Java中的SuppressWarnings注解使用

@SuppressWarnings 注解

@SuppressWarnings: 抑制编译器警告

如下，可以看到idea中有警告的颜色标注

当我们不希望看到这些警告的时候，可以使用 SuppressWarnings注解来抑制警告信息

在{" "} 中，可以写入你希望抑制(不显示)警告信息

在idea中可以看到这些警告的信息，然后根据下面的属性介绍依次填入对应的抑制警告的参数，如：

• rawtypes，抑制与使用raw类型相关的警告

• unchecked，抑制与未检查的作业相关的警告

• unused，抑制与未用的程式码及停用的程式码相关的警告

可以从下面的警告参数中找到对应的警告参数即可。可以看到警告全部被抑制了

当然，也可以直接选择参数 all，警告就全部会被抑制

关于SuppressWarnings 作用范围是和放置的位置相关

比如 @SuppressWarnings放置在 main方法，那么抑制警告的范围就是 main，通常我们可以放置具体的语句、方法、 类。

• @SuppressWarnings注解的常见的值
• unchecked是忽略没有检查的警告
• rawtypes是忽略没有指定泛型的警告(传参时没有指定泛型的警告错误)
• unused是忽略没有使用某个变量的警告错误
• @SuppressWarnings可以修饰的程序元素，查看 @Target

查看源码：

(1) 放置的位置就是 TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE

(2) 该注解类有数组 String[] values() ，设置一个数组比如 {"rawtypes", "unchecked", "unused"}

生成@SupperssWarnings时，不用背，直接点击左侧的黄色提示，就可以选择(注意可以指定生成的位置)

@SuppressWarning 中的属性介绍以及属性说明

• all：抑制所有警告
• boxing：抑制与封装/拆装作业相关的警告
• cast：抑制与强制转型作业相关的警告
• dep-ann：抑制与淘汰注释相关的警告
• deprecation：抑制与淘汰的相关警告
• fallthrough：抑制与switch陈述式中遗漏break相关的警告
• finally：抑制与未传回finally区块相关的警告
• hiding：抑制与隐藏变数的区域变数相关的警告
• incomplete-switch：抑制与switch陈述式(enum case)中遗漏项目相关的警告
• javadoc：抑制与javadoc相关的警告
• nls：抑制与非nls字串文字相关的警告
• null：抑制与空值分析相关的警告
• rawtypes：抑制与使用raw类型相关的警告
• resource：抑制与使用Closeable类型的资源相关的警告
• restriction：抑制与使用不建议或禁止参照相关的警告
• serial：抑制与可序列化的类别遗漏serialVersionUID栏位相关的警告
• static-access：抑制与静态存取不正确相关的警告
• static-method：抑制与可能宣告为static的方法相关的警告
• super：抑制与置换方法相关但不含super呼叫的警告
• synthetic-access：抑制与内部类别的存取未最佳化相关的警告
• sync-override：抑制因为置换同步方法而遗漏同步化的警告
• unchecked：抑制与未检查的作业相关的警告
• unqualified-field-access：抑制与栏位存取不合格相关的警告
• unused：抑制与未用的程式码及停用的程式码相关的警告

@SuppressWarnings 注解常见用法

使用场合

@SuppressWarnings注解，主要用于抑制编译器报出的warning信息。

比如在idea中，如果某个方法的返回值没有被使用，idea在语法检查时，会把这个方法标记为阴影状态，鼠标悬停后会显示对应的原因。

如果此时我觉得这个返回值是必要的，只是暂时还没用到，就可以加一个@SuppressWarnings注解，抑制警告信息。

当然，不是每时每刻都需要解决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

作用：抑制“未经检查的类型转化”警告

示例：

all

作用：抑制所有的报错

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

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

最新评论