@SuppressWarnings注解使用指南

参考资料地址1:Java @SuppressWarnings:抑制编译器警告

参考资料地址2: @SuppressWarnings注解作用与用法详解

@SuppressWarings注解
作用:用于抑制编译器产生警告信息

00 简介:

java.lang.SuppressWarnings是J2SE 5.0中标准的Annotation之一。可以标注在类、字段、方法、参数、构造方法,以及局部变量上。

sun的官方文档描述:

value - 将由编译器在注释的元素中取消显示的警告集。允许使用重复的名称。忽略第二个和后面出现的名称。出现未被识别的警告名不是 错误:编译器必须忽略无法识别的所有警告名。但如果某个注释包含未被识别的警告名,那么编译器可以随意发出一个警告。
各编译器供应商应该将它们所支持的警告名连同注释类型一起记录。鼓励各供应商之间相互合作,确保在多个编译器中使用相同的名称。

作用:告诉编译器忽略指定的警告,不用在编译完成后出现警告信息。

01 使用:

@SuppressWarnings(“”)
@SuppressWarnings({})
@SuppressWarnings(value={})

02 示例:

  • @SuppressWarnings(“unchecked”)告诉编译器忽略 unchecked 警告信息,如使用List,ArrayList等未进行参数化产生的警告信息。
  • @SuppressWarnings(“serial”)如果编译器出现这样的警告信息:The serializable class WmailCalendar does not declare a static final serialVersionUID field of type long,使用这个注释将警告信息去掉。
  • @SuppressWarnings(“deprecation”)如果使用了使用@Deprecated注释的方法,编译器将出现警告信息。使用这个注释将警告信息去掉。
  • @SuppressWarnings(“unchecked”, “deprecation”)告诉编译器同时忽略unchecked和deprecation的警告信息。
  • @SuppressWarnings(value={“unchecked”, “deprecation”})等同于@SuppressWarnings(“unchecked”, “deprecation”)

代码示例

    //示例1——抑制单类型的警告:
    @SuppressWarnings("unchecked")
    public void addItems1(String item){
        @SuppressWarnings("rawtypes")
        List items = new ArrayList();
        items.add(item);
    }

    //示例2——抑制多类型的警告:
    @SuppressWarnings(value={"unchecked","rawtypes"})
    public void addItems2(String item){
        List items = new ArrayList();
        items.add(item);
    }

    //示例3——抑制所有类型的警告:
    @SuppressWarnings("all")
    public void addItems3(String item){
        List items = new ArrayList();
        items.add(item);
    }

03 @SuppressWarnings注解的作用

J2SE 提供的最后一个批注是 @SuppressWarnings。该批注的作用是给编译器一条指令,告诉它对被批注的代码元素内部的某些警告保持静默。
@SuppressWarnings 批注允许您选择性地取消特定代码段(即,类或方法)中的警告。其中的想法是当您看到警告时,您将调查它,如果您确定它不是问题,
您就可以添加一个 @SuppressWarnings 批注,以使您不会再看到警告。虽然它听起来似乎会屏蔽潜在的错误,但实际上它将提高代码安全性,因为它将防止
您对警告无动于衷 — 您看到的每一个警告都将值得注意。

04 抑制警告的关键字

抑制警告的关键字如下表所示。

关键字 用途
all 抑制所有警告
boxing 抑制装箱、拆箱操作时候的警告
cast 抑制映射相关的警告
dep-ann 抑制启用注释的警告
deprecation 抑制过期方法警告
fallthrough 抑制在 switch 中缺失 breaks 的警告
finally 抑制 finally 模块没有返回的警告
hiding 抑制相对于隐藏变量的局部变量的警告
incomplete-switch 忽略不完整的 switch 语句
nls 忽略非 nls 格式的字符
null 忽略对 null 的操作
rawtypes 使用 generics 时忽略没有指定相应的类型
restriction 抑制禁止使用劝阻或禁止引用的警告
serial 忽略在 serializable 类中没有声明 serialVersionUID 变量
static-access 抑制不正确的静态访问方式警告
synthetic-access 抑制子类没有按最优方法访问内部类的警告
unchecked 抑制没有进行类型检查操作的警告
unqualified-field-access 抑制没有权限访问的域的警告
unused 抑制没被使用过的代码的警告
posted @ 2022-03-07 10:22  进击的小蔡鸟  阅读(734)  评论(0编辑  收藏  举报