Java中@SuppressWarnings注解可以使用的参数列表

Posted 2023-03-30 Nonoas

参数	效果
all	抑制所有警告信息
boxing	抑制自动装箱和拆箱操作的警告信息
cast	抑制类型转换的警告信息
dep-ann	抑制过时的注解的警告信息
deprecation	抑制过时的方法或类的警告信息
fallthrough	抑制在switch语句中case块缺少break语句的警告信息
finally	抑制finally块无法正常执行的警告信息
hiding	抑制变量或方法隐藏父类中的变量或方法的警告信息
incomplete-switch	抑制在switch语句中没有处理所有情况的警告信息
javadoc	抑制Javadoc注释中的错误或警告信息
nls	抑制非本地化字符串的警告信息
null	抑制空指针引用的警告信息
rawtypes	抑制使用未经检查的原始类型的警告信息
resource	抑制在try-with-resources语句中未关闭资源的警告信息
restriction	抑制受限制的类或API的警告信息
serial	抑制没有序列化ID的类的警告信息
static-access	抑制使用静态方法或变量的警告信息
static-method	抑制通过实例引用静态方法的警告信息
super	抑制使用未经检查的类型作为超类的警告信息
synthetic-access	抑制合成类或方法的警告信息
unchecked	抑制未经检查的转换、操作等的警告信息
unqualified-field-access	抑制未经限定的字段访问的警告信息
unused	抑制未使用的代码和变量的警告信息

ps：并不是所有的参数都可以应用于所有的警告类型，有些参数只适用于特定类型的警告

@SuppressWarnings注解

简介：java.lang.SuppressWarnings是J2SE 5.0中标准的Annotation之一。可以标注在类、字段、方法、参数、构造方法，以及局部变量上。
作用：告诉编译器忽略指定的警告，不用在编译完成后出现警告信息。
使用：
@SuppressWarnings(“”)
@SuppressWarnings({})
@SuppressWarnings(value={})

根据sun的官方文档描述：
value - 将由编译器在注释的元素中取消显示的警告集。允许使用重复的名称。忽略第二个和后面出现的名称。出现未被识别的警告名不是 错误：编译器必须忽略无法识别的所有警告名。但如果某个注释包含未被识别的警告名，那么编译器可以随意发出一个警告。

各编译器供应商应该将它们所支持的警告名连同注释类型一起记录。鼓励各供应商之间相互合作，确保在多个编译器中使用相同的名称。

示例：

·   @SuppressWarnings("unchecked")

告诉编译器忽略 unchecked 警告信息，如使用List，ArrayList等未进行参数化产生的警告信息。

·   @SuppressWarnings("serial")

如果编译器出现这样的警告信息：The serializable class WmailCalendar does not declare a static final serialVersionUID field of type long
       使用这个注释将警告信息去掉。

·   @SuppressWarnings("deprecation")

如果使用了使用@Deprecated注释的方法，编译器将出现警告信息。
       使用这个注释将警告信息去掉。

·   @SuppressWarnings("unchecked", "deprecation")

告诉编译器同时忽略unchecked和deprecation的警告信息。

·   @SuppressWarnings(value={"unchecked", "deprecation"})

等同于@SuppressWarnings("unchecked", "deprecation")

 

Fortunately for us, the Eclipse folks have documented the values they support (As of Eclipse 3.3), here they are for reference:

• 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