1. 程式人生 > >@SuppressWarnings註解用法詳解

@SuppressWarnings註解用法詳解

今天來談談@SuppressWarnings註解的作用。

@SuppressWarnings 註解的作用是給編譯器一條指令,告訴它對被批註的程式碼元素內部的某些警告保持靜默。

@SuppressWarnings 批註允許您選擇性地取消特定程式碼段(即,類或方法)中的警告。其中的想法是當您看到警告時,您將調查它,如果您確定它不是問題,

您就可以新增一個 @SuppressWarnings 批註,以使您不會再看到警告。雖然它聽起來似乎會遮蔽潛在的錯誤,但實際上它將提高程式碼安全性,因為它將防止

您對警告無動於衷 — 您看到的每一個警告都將值得注意。

我經常遇到的問題是不曉得什麼時候用@SupressWarnings的什麼批註好,所以做了如下整理

使用:
@SuppressWarnings(“”)
@SuppressWarnings({})
@SuppressWarnings(value={})

編碼時我們總會發現如下變數未被使用的警告提示:

上述程式碼編譯通過且可以執行,但每行前面的“感嘆號”就嚴重阻礙了我們判斷該行是否設定的斷點了。這時我們可以在方法前新增 @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 的原始碼可知,其註解目標為類、欄位、函式、函式入參、建構函式和函式的區域性變數。

package java.lang;

import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}

建議註解應宣告在最接近警告發生的位置。

抑制警告的關鍵字
  • 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(抑制確在switch中缺失breaks的警告)
  • finally to suppress warnings relative to finally block that don’t return (抑制finally模組沒有返回的警告)
  • 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)(忽略沒有完整的switch語句)
  • nls to suppress warnings relative to non-nls string literals(忽略非nls格式的字元)
  • to suppress warnings relative to null analysis(忽略對null的操作)
  • rawtypes to suppress warnings relative to un-specific types when using generics on class params(使用generics時忽略沒有指定相應的型別)
  • 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(忽略在serializable類中沒有宣告serialVersionUID變數)
  • 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 (抑制沒被使用過的程式碼的警告)