天天看點

@SuppressWarnings

@SuppressWarnings

J2SE 提供的最後一個批注是 @SuppressWarnings。該批注的作用是給編譯器一條指令,告訴它對被批注的代碼元素内部的某些警告保持靜默。

一點背景:J2SE 5.0 為 Java 語言增加了幾個新的特性,并且和它們一起增加了許多新的警告并承諾在将來增加更多的警告。您可以為 "javac" 增加 -Xlint 參數來控制是否報告這些警告(如上面的 @Deprecated 部分所示)。

預設情況下,Sun 編譯器以簡單的兩行的形式輸出警告。通過添加 -Xlint:keyword 标記(例如 -Xlint:finally),您可以獲得關鍵字類型錯誤的完整說明。通過在關鍵字前面添加一個破折号,寫為 -Xlint:-keyword,您可以取消警告。(-Xlint 支援的關鍵字的完整清單可以在 javac 文檔頁面上找到。)下面是一個清單:

關鍵字 用途
deprecation 使用了不贊成使用的類或方法時的警告
unchecked 執行了未檢查的轉換時的警告,例如當使用集合時沒有用泛型 (Generics) 來指定集合儲存的類型。
fallthrough 當 Switch 程式塊直接通往下一種情況而沒有 Break 時的警告。
path 在類路徑、源檔案路徑等中有不存在的路徑時的警告。
serial 當在可序列化的類上缺少 serialVersionUID 定義時的警告。
finally 任何 finally 子句不能正常完成時的警告。
all 關于以上所有情況的警告。

@SuppressWarnings 批注允許您選擇性地取消特定代碼段(即,類或方法)中的警告。其中的想法是當您看到警告時,您将調查它,如果您确定它不是問題,您就可以添加一個 @SuppressWarnings 批注,以使您不會再看到警告。雖然它聽起來似乎會屏蔽潛在的錯誤,但實際上它将提高代碼安全性,因為它将防止您對警告無動于衷 — 您看到的每一個警告都将值得注意。

下面是使用 @SuppressWarnings 來取消 deprecation 警告的一個例子:

public class DeprecatedExample2 {
  @Deprecated
  public static void foo() {
  }
}

public class DeprecatedUser2 {
  @SuppressWarnings(value={"deprecation"})
public static void main(String[] args) {
    DeprecatedExample2.foo();
  }
}
      

@SuppressWarnings 批注接收一個 "value" 變量,該變量是一個字元串數組,它訓示将取消的警告。合法字元串的集合随編譯器而變化,但在 JDK 上,可以傳遞給 -Xlint 的是相同的關鍵字集合(非常友善)。并且要求編譯器忽略任何它們不能識别的關鍵字,這在您使用一些不同的編譯器時非常友善。

因為 @SuppressWarnings 批注僅接收一個參數,并為該參數使用了特殊的名稱 "value",是以您可以選擇省略 value=,作為一種友善的縮寫:

public class DeprecatedUser2 {
  @SuppressWarnings({"deprecation"})
public static void main(String[] args) {
    DeprecatedExample2.foo();
  }
}
      

您可以将單個數組參數中的任意數量的字元串值傳遞給批注,并在任何級别上放置批注。例如,以下示例代碼訓示将取消整個類的 deprecation 警告,而僅在 main() 方法代碼内取消 unchecked 和 fallthrough 警告:

import java.util.*;

@SuppressWarnings({"deprecation"})
public class NonGenerics {

  @SuppressWarnings({"unchecked","fallthrough"})
public static void main(String[] args) {
    Runtime.runFinalizersOnExit();

    List list = new ArrayList();
    list.add("foo");
  }

  public static void foo() {
    List list = new ArrayList();
    list.add("foo");
  }
}
           

@SuppressWarnings 是否比前兩個批注更有用?絕對是這樣。不過,在 JDK 1.5.0 版本中還沒有完全支援該批注,如果您用 1.5.0 來嘗試它,那麼它将類似無操作指令。調用 -Xlint:-deprecation 也沒有任何效果。Sun 沒有聲明什麼時候将增加支援,但它暗示這将在即将推出的一個 dot 版本中實作。

更進一步

如果您試圖在 Javadocs 頁面中檢視這些屬性,那麼您可能很難找到它們。它們位于核心的 java.lang 包中,但有點隐蔽,它們出現在 Javadoc 類的最底端,列在 Exceptions 和 Errors 後面。

繼續閱讀