[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