天天看點

@SuppressWarnings注解常見用法使用場合注解介紹value常見取值unused

使用場合

@SuppressWarnings注解,主要用于抑制編譯器報出的warning資訊。

比如在idea中,如果某個方法的傳回值沒有被使用,idea在文法檢查時,會把這個方法标記為陰影狀态,滑鼠懸停後會顯示對應的原因。

@SuppressWarnings注解常見用法使用場合注解介紹value常見取值unused

 如果此時我覺得這個傳回值是必要的,隻是暫時還沒用到,就可以加一個@SuppressWarnings注解,抑制警告資訊。

@SuppressWarnings注解常見用法使用場合注解介紹value常見取值unused

當然,不是每時每刻都需要解決warning。一般會在送出代碼前做一個檢查,例如用idea的gui送出到git倉庫時,預設會對我們的修改做一個檢查,如果有warning資訊會提示我們修改。

注解介紹

@SuppressWarnings注解可标注于類、屬性、方法、參數構造函數、局部變量上。

一般需滿足最小範圍原則,即如果警告資訊來自于某個方法時,則将此注解标注與該方法上,而不要标注于範圍更大的類上。

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

注解隻有一個value值,用于接收warning的類型,下面列舉常見的value。

value常見取值

UnusedReturnValue

作用:抑制  “方法的傳回值未被使用”警告

示例:

@SuppressWarnings("UnusedReturnValue")    
    int batchInsert(@Param("lists") List<T>lists, Class<T>clazz);
           

unused

作用:抑制“方法或者變量未被使用”警告

示例:

@SuppressWarnings("unused")
    public <T> String getByPrimaryKey(Object key, Class<T> clazz) {
           

unchecked

作用:抑制“未經檢查的類型轉化”警告

示例:

@SuppressWarnings注解常見用法使用場合注解介紹value常見取值unused

 all

作用:抑制所有的報錯

盡量遵守“最小範圍”原則,一般情況下不要用。