[Spring-注解] 之 @SuppressWarnings

@SuppressWarnings注解

• 概述

java.lang.SuppressWarnings是J2SE5.0中标准的Annotation之一。可以标注在类、字段、方法、参数、构造方法，以及局部变量上。

• 作用

在开发中，有时候IDE/编译器会给出一些没有必要的告警。可以通过@SuppressWarnings来屏蔽。@SuppressWarnings有很多种面向场景。

• 使用

@SuppressWarnings(“”)
@SuppressWarnings({})
@SuppressWarnings(value={})

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

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

• 示例

·  @SuppressWarnings("unchecked")

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

·  @SuppressWarnings("serial")

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

·  @SuppressWarnings("deprecation")

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

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

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

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

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

  编码时我们总会发现如下变量未被使用的警告提示：

  上述代码编译通过且可以运行，但每行前面的“感叹号”就严重阻碍了我们判断该行是否设置的断点了。这时我们可以在方法前添加 @SuppressWarnings("unused") 去除这些“感叹号”。

 

二、 @SuppressWarings注解 　　　　　　　　　　　　　　　　　　　　　　　　　　　

  作用：用于抑制编译器产生警告信息。

  示例1——抑制单类型的警告：

@SuppressWarnings("unchecked")
public void addItems(String item){
  @SuppressWarnings("rawtypes")
   List items = new ArrayList();
   items.add(item);
}

  示例2——抑制多类型的警告：

@SuppressWarnings(value={"unchecked", "rawtypes"})
public void addItems(String item){
   List items = new ArrayList();
   items.add(item);
}

  示例3——抑制所有类型的警告：

@SuppressWarnings("all")
public void addItems(String item){
   List items = new ArrayList();
   items.add(item);
}

 

三、注解目标　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

 通过 @SuppressWarnings 的源码可知，其注解目标为类、字段、函数、函数入参、构造函数和函数的局部变量。

 而家建议注解应声明在最接近警告发生的位置。

 

四、抑制警告的关键字　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

关键字	用途
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	o 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