簡介: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")
編碼時我們總會發現如下變量未被使用的警告提示:
上述代碼編譯通過且可以運行,但每行前面的“感嘆號”就嚴重阻礙了我們判斷該行是否設置的斷點了。這時我們可以在方法前添加 @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(在switch語句中,抑制與缺失中斷相關的警告) |
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)(為了在switch語句(enum案例)中抑制相對於缺失條目的警告) |
nls |
to suppress warnings relative to non-nls string literals(要抑制相對於非nls字符串字面量的警告) |
null |
to suppress warnings relative to null analysis(為了抑制與null分析相關的警告) |
rawtypes |
to suppress warnings relative to un-specific types when using generics on class params(在類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(為了一個可串行化的類,為了抑制相對於缺失的serialVersionUID字段的警告) |
static-access |
o suppress warnings relative to incorrect static access(o抑制與不正確的靜態訪問相關的警告) |
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(抑制沒有使用過代碼的警告) |
五、Java Lint選項
1. lint的含義
用於在編譯程序的過程中,進行更細節的額外檢查。
- javac 的標准選項和非標准選項
標准選項:是指當前版本和未來版本中都支持的選項,如 -cp 和 -d 等。
非標准選項:是指當前版本支持,但未來不一定支持的選項。通過 javac -X 查看當前版本支持的非標准選項。
3. 查看警告信息
默認情況下執行 javac 僅僅顯示警告的扼要信息,也不過阻止編譯過程。若想查看警告的詳細信息,則需要執行 javac -Xlint:keyword 來編譯源碼了。