天天看点

@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

作用:抑制所有的报错

尽量遵守“最小范围”原则,一般情况下不要用。