由@suppressWarnings("unchecked")想到的一丢丢

2022-11-29 08:48:43 浏览数 (1)

JavaSE 提供的最后一个批注是 @SuppressWarnings。该批注的作用是给编译器一条指令,告诉它对被批注的代码元素内部的某些警告保持静默。

代码语言:javascript复制
   Java5 为 Java 语言增加了几个新的特性,并且和它们一起增加了许多新的警告并承诺在将来增加更多的警告。您可以为 "javac" 增加 -Xlint 参数来控制是否报告这些警告(如上面的 @Deprecated 部分所示)。 

清单: - deprecation 使用了不赞成使用的类或方法时的警告 - unchecked 执行了未检查的转换时的警告,例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型。 - fallthrough 当 Switch 程序块直接通往下一种情况而没有 Break 时的警告。 - path 在类路径、源文件路径等中有不存在的路径时的警告。 - serial 当在可序列化的类上缺少 serialVersionUID 定义时的警告 - finally 任何 finally 子句不能正常完成时的警告。 - all 关于以上所有情况的警告。

@SuppressWarnings 批注允许您选择性地取消特定代码段(即,类或方法)中的警告。其中的想法是当您看到警告时,您将调查它,如果您确定它不是问题,您就可以添加一个 @SuppressWarnings 批注,以使您不会再看到警告。虽然它听起来似乎会屏蔽潜在的错误,但实际上它将提高代码安全性,因为它将防止您对警告无动于衷 — 您看到的每一个警告都将值得注意。

下面是使用 @SuppressWarnings 来取消 deprecation 警告的一个例子:

代码语言:javascript复制
public class DeprecatedExample {
   @Deprecated
   public static void foo() {}
}

public class DeprecatedUser {
   @SuppressWarnings(value={"deprecation"})
   public static void main(String[] args) {
      DeprecatedExample2.foo();
   }
}

@SuppressWarnings 批注接收一个 “value” 变量,该变量是一个字符串数组,它指示将取消的警告。合法字符串的集合随编译器而变化,但在 JDK 上,可以传递给 -Xlint 的是相同的关键字集合(非常方便)。并且要求编译器忽略任何它们不能识别的关键字,这在您使用一些不同的编译器时非常方便。 因为 @SuppressWarnings 批注仅接收一个参数,并为该参数使用了特殊的名称 “value”,所以您可以选择省略 value=,作为一种方便的缩写:

代码语言:javascript复制
public class DeprecatedUser2 {
   @SuppressWarnings({"deprecation"})
   public static void main(String[] args) {
   DeprecatedExample2.foo();
   }
}

您可以将单个数组参数中的任意数量的字符串值传递给批注,并在任何级别上放置批注。例如,以下示例代码指示将取消整个类的 deprecation 警告,而仅在 main() 方法代码内取消 unchecked 和 fallthrough 警告:

代码语言:javascript复制
import java.util.*;
@SuppressWarnings({"deprecation"})
public class NonGenerics {
@SuppressWarnings({"unchecked","fallthrough"})
    public static void main(String[] args) {
        Runtime.runFinalizersOnExit();
        List list = new ArrayList();
        list.add("foo");
    }

    public static void foo() {
        List list = new ArrayList();
        list.add("foo");
    }
}

@SuppressWarnings 是否比前两个批注更有用?绝对是这样。 更进一步,如果您试图在 Javadocs 页面中查看这些属性,那么您可能很难找到它们。它们位于核心的 java.lang 包中,但有点隐蔽,它们出现在 Javadoc 类的最底端,列在 Exceptions 和 Errors 后面。 注意到了附加在 SuppressWarnings 批注后面的陌生的批注 @Target 和 @Retention 了吗?这些称为元数据批注,它们描述了该批注在哪里适用。我将在本系列的第二篇文章中介绍它们,以及介绍如何将元数据批注应用到您自己的批注中。

0 人点赞