@SuppressWarnings注解的作用与用法

我会带着你远行 2024-04-23 20:08 68阅读 0赞

## @SuppressWarnings注解 ##

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

**作用**：告诉编译器忽略指定的警告，不用在编译完成后出现警告信息。

**使用**：

@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")

@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 的源码可知，其注解目标为类、字段、函数、函数入参、构造函数和函数的局部变量。

注解关键字：

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