java注解用法详解——@SuppressWarnings

java中注解用法详解——@SuppressWarnings

一、前言  

    注释类型:
        当你的编码可能存在警告时,比如安全警告,可以用它来消除。

        api中是这样描述的:
            指示应该在注释元素(以及包含在该注释元素中的所有程序元素)中取消显示指定的编译器警告。
            注意,在给定元素中取消显示的警告集是所有包含元素中取消显示的警告的超集。
            例如,如果注释一个类来取消显示某个警告,同时注释一个方法来取消显示另一个警告,那么将在此方法中同时取消显示这两个警告。

            根据风格不同,程序员应该始终在最里层的嵌套元素上使用此注释,在那里使用才有效。
            如果要在特定的方法中取消显示某个警告,则应该注释该方法而不是注释它的类。

  在java编译过程中会出现很多警告,有很多是安全的,但是每次编译有很多警告影响我们对error的过滤和修改,我们可以在代码中加上 @SuppressWarnings(“XXXX”) 来解决

  例如:@SuppressWarnings("deprecation")  表示不显示使用了不赞成使用的类或方法时的警告。 

  再比如:

  编码时我们总会发现如下:变量未被使用的警告提示

  上述代码编译通过且可以运行,但每行前面的“感叹号”就严重阻碍了我们判断该行是否设置的断点了。这时我们可以在方法前添加 @SuppressWarnings("unused") 去除这些“感叹号”。

  再比如:

  这时我们可以在方法前添加 @SuppressWarnings("resource") 去除这些“感叹号”。

二、 @SuppressWarings注解

  作用:用于抑制编译器产生警告信息。

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

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

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

三、注解目标                           

  通过 @SuppressWarnings 的源码可知,其注解目标为类、字段、函数、函数入参、构造函数和函数的局部变量。   而专家建议注解应声明在最接近警告发生的位置。

四、抑制警告的关键字

It depends on your IDE or compiler.

Here is a list for Eclipse Galileo:

  • all to suppress all warnings
  • boxing to suppress warnings relative to boxing/unboxing operations
  • cast to suppress warnings relative to cast operations
  • dep-ann to suppress warnings relative to deprecated annotation
  • deprecation to suppress warnings relative to deprecation
  • fallthrough to suppress warnings relative to missing breaks in switch statements
  • finally to suppress warnings relative to finally block that don’t return
  • hiding to suppress warnings relative to locals that hide variable
  • incomplete-switch to suppress warnings relative to missing entries in a switch statement (enum case)
  • nls to suppress warnings relative to non-nls string literals
  • null to suppress warnings relative to null analysis
  • restriction to suppress warnings relative to usage of discouraged or forbidden references
  • serial to suppress warnings relative to missing serialVersionUID field for a serializable class
  • static-access to suppress warnings relative to incorrect static access
  • synthetic-access to suppress warnings relative to unoptimized access from inner classes
  • unchecked to suppress warnings relative to unchecked operations
  • unqualified-field-access to suppress warnings relative to field access unqualified
  • unused to suppress warnings relative to unused code

List for Indigo adds:

  • javadoc to suppress warnings relative to javadoc warnings
  • rawtypes to suppress warnings relative to usage of raw types
  • static-method to suppress warnings relative to methods that could be declared as static
  • super to suppress warnings relative to overriding a method without super invocations

List for Juno adds:

  • resource to suppress warnings relative to usage of resources of type Closeable
  • sync-override to suppress warnings because of missing synchronize when overriding a synchronized method

部分翻译如下:

@SuppressWarnings(“unchecked”)    // 抑制未检查的转化,例如集合没有指定类型的警告   @SuppressWarnings(“unused”)       // 抑制未使用的变量的警告   @SuppressWarnings(“resource”)    // 抑制与使用Closeable类型资源相关的警告   @SuppressWarnings(“path”)      // 抑制在类路径,原文件路径中有不存在的路径的警告   @SuppressWarnings("deprecation")    // 抑制使用了某些不赞成使用的类和方法的警告   @SuppressWarnings("fallthrough")      // 抑制switch语句执行到底没有break关键字的警告   @SuppressWarnings("serial")         // 抑制某类实现Serializable,但是没有定义serialVersionUID,这个需要但是不必须的字段的警告   @SuppressWarnings("rawtypes")        // 抑制没有传递带有泛型的参数的警告   @SuppressWarnings("all")             // 抑制全部类型的警告

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏武军超python专栏

2018-7-17 python中函数的讲解

定义函数的基本语法:【定义/声明函数、调用函数】 define 定义 param 参数

12340
来自专栏GreenLeaves

C# 特性(Attribute)之Serializable特性

本文参考自Serializable 作用,纯属读书笔记,加深记忆 介绍之前,先说一个重要的知识点: Serializable属性并不序列化类,它只是一个标签。至...

342100
来自专栏nummy

python拾遗【2】自定义异常类

12230
来自专栏Java职业技术分享

Java技术——你真的了解String类的intern()方法吗

是不是感觉莫名其妙,新定义的str2好像和str1没有半毛钱的关系,怎么会影响到有关str1的输出结果呢?其实这都是intern()方法搞的鬼!看完这篇文章,你...

17300
来自专栏听Allen瞎扯淡

一起 Static 和 Synchronized 引发的血案

这两天在定位一个网上问题的时候发现一个很诡异的现象,系统夜间的汇总任务跑了很长一段时间才能结束,而且日志显示这些汇总任务的每个子任务都很快就结束了,但整体任务还...

71520
来自专栏编程心路

Java虚拟机内存管理(二)—堆的使用

Java 虚拟机作为运行 Java 程序抽象出来的计算机,具有内存管理的能力,像内存分配、垃圾回收等这些相关的内存管理问题,Java 虚拟机都会帮我们解决,所以...

14920
来自专栏蛋未明的专栏

PHP分割两个数组的相同元素和不同元素的两种方法

23040
来自专栏magicsoar

一个C++bug引入的许多知识

一、前言     假设我们有一个Car类,用了表示一个车,它有id,名字,牌照等许多东西,还有一个表示车的部件CarPart。     但出于某方面的考虑,我们...

25890
来自专栏后台全栈之路

Python 调用 C 动态链接库,包括结构体参数、回调函数等

项目中要对一个用 C 编写的 .so 库进行逻辑自测。这项工作,考虑到灵活性,我首先考虑用 Python 来完成。

699110
来自专栏JavaQ

99%的高级程序员都这样使用null

如果使用某个对象或对象里属性前先判断是否为null,那就需要思考一下你的代码是否已经烂掉了。 null是什么意思,你能说清楚它的意图吗?方法返回了null,是出...

35060

扫码关注云+社区

领取腾讯云代金券