你的位置:首页 > Java教程

[Java教程]关于java中的批注@SuppressWarnings


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

背景:J2SE5.0为java语言添加了几个特性和新的警告,并承诺将来会有更多的警告,您可以为 "javac" 添加 -Xlint 参数来控制是否报告这些警告。

默认情况下:sun编译器以简单的两行的形式输出警告。通过添加 -Xlint:keyword 标记(如:-Xlint:finally), 您可以获得关键字keyword类型的完整说明。
通过在关键字前添加破折号 -Xlint:-finally,您可以取消警告。

目前关键字清单:

all to suppress all warnings
boxing to suppress warnings relative to boxing/unboxing operations
cast to suppress warnings relative to cast operations
dep-ann to suppress warnings relative to deprecated annotation
deprecation to suppress warnings relative to deprecation
fallthrough to suppress warnings relative to missing breaks in switch statements
finally to suppress warnings relative to finally block that don’t return
hiding to suppress warnings relative to locals that hide variable
incomplete-switch to suppress warnings relative to missing entries in a switch statement (enum case)
nls to suppress warnings relative to non-nls string literals
null to suppress warnings relative to null analysis
rawtypes to suppress warnings relative to un-specific types when using generics on class params
restriction to suppress warnings relative to usage of discouraged or forbidden references
serial to suppress warnings relative to missing serialVersionUID field for a serializable class
static-access to suppress warnings relative to incorrect static access
synthetic-access to suppress warnings relative to unoptimized access from inner classes
unchecked to suppress warnings relative to unchecked operations
unqualified-field-access to suppress warnings relative to field access unqualified
unused to suppress warnings relative to unused code

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

@SuppressWarnings 批注允许你选择性的取消特点代码段(类或方法)中的警告。是这样想的:当你看到警告时,你将调查它,如果你确定它不是问题,您就可以通过用@SuppressWarnings批注,以使你不会再看到警告。虽然听起来似乎会屏蔽潜在的错误,但实际上它将提高代码的安全性。(每一个警告都将值得注意)。

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

 

@SuppressWarnings 批注接受一个"value"变量,该变量是一个字符串数组,它指示将取消的警告。合法字符串的集合随这编译器的变化而变化,但在 JDK 上,可以传递给-Xlint 的是相同的关键字集合,并且要求编译器忽略任何它们不能识别的关键字。

因为 @SuppressWarnings 批注仅接收一个参数,并为该参数使用了特殊的名称 "value",所以您可以选择省略 value=,作为一种方便的缩写:

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

 

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

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");}}