java注解用法详解——@SuppressWarnings

简介: java中注解用法详解——@SuppressWarnings 一、前言   注释类型: 当你的编码可能存在警告时,比如安全警告,可以用它来消除。 api中是这样描述的: 指示应该在注释元素(以及包含在该注释元素中的所有程序元素)中取消显示指定的编译器警告。

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")             // 抑制全部类型的警告

 

我的GitHub地址: https://github.com/heizemingjun
我的博客园地址: http://www.cnblogs.com/chenmingjun
我的蚂蚁笔记博客地址: http://blog.leanote.com/chenmingjun
Copyright ©2018 黑泽明军
【转载文章务必保留出处和署名,谢谢!】
相关文章
|
7月前
|
Java 编译器 开发者
注解的艺术:Java编程的高级定制
注解是Java编程中的高级特性,通过内置注解、自定义注解及注解处理器,可以实现代码的高度定制和扩展。通过理解和掌握注解的使用方法,开发者可以提高代码的可读性、可维护性和开发效率。在实际应用中,注解广泛用于框架开发、代码生成和配置管理等方面,展示了其强大的功能和灵活性。
148 25
|
10月前
|
移动开发 前端开发 Java
Java最新图形化界面开发技术——JavaFx教程(含UI控件用法介绍、属性绑定、事件监听、FXML)
JavaFX是Java的下一代图形用户界面工具包。JavaFX是一组图形和媒体API,我们可以用它们来创建和部署富客户端应用程序。 JavaFX允许开发人员快速构建丰富的跨平台应用程序,允许开发人员在单个编程接口中组合图形,动画和UI控件。本文详细介绍了JavaFx的常见用法,相信读完本教程你一定有所收获!
8887 5
Java最新图形化界面开发技术——JavaFx教程(含UI控件用法介绍、属性绑定、事件监听、FXML)
|
10月前
|
XML Java 编译器
Java注解的底层源码剖析与技术认识
Java注解(Annotation)是Java 5引入的一种新特性,它提供了一种在代码中添加元数据(Metadata)的方式。注解本身并不是代码的一部分,它们不会直接影响代码的执行,但可以在编译、类加载和运行时被读取和处理。注解为开发者提供了一种以非侵入性的方式为代码提供额外信息的手段,这些信息可以用于生成文档、编译时检查、运行时处理等。
201 7
|
10月前
|
Java 编译器 数据库
Java 中的注解(Annotations):代码中的 “元数据” 魔法
Java注解是代码中的“元数据”标签,不直接参与业务逻辑,但在编译或运行时提供重要信息。本文介绍了注解的基础语法、内置注解的应用场景,以及如何自定义注解和结合AOP技术实现方法执行日志记录,展示了注解在提升代码质量、简化开发流程和增强程序功能方面的强大作用。
347 5
|
11月前
|
Java 编译器
Java进阶之标准注解
Java进阶之标准注解
108 0
|
12月前
|
存储 安全 Java
深入理解Java中的FutureTask:用法和原理
【10月更文挑战第28天】`FutureTask` 是 Java 中 `java.util.concurrent` 包下的一个类,实现了 `RunnableFuture` 接口,支持异步计算和结果获取。它可以作为 `Runnable` 被线程执行,同时通过 `Future` 接口获取计算结果。`FutureTask` 可以基于 `Callable` 或 `Runnable` 创建,常用于多线程环境中执行耗时任务,避免阻塞主线程。任务结果可通过 `get` 方法获取,支持阻塞和非阻塞方式。内部使用 AQS 实现同步机制,确保线程安全。
1113 3
|
12月前
|
XML Java 编译器
Java学习十六—掌握注解:让编程更简单
Java 注解(Annotation)是一种特殊的语法结构,可以在代码中嵌入元数据。它们不直接影响代码的运行,但可以通过工具和框架提供额外的信息,帮助在编译、部署或运行时进行处理。
236 43
Java学习十六—掌握注解:让编程更简单
|
13天前
|
数据采集 存储 弹性计算
高并发Java爬虫的瓶颈分析与动态线程优化方案
高并发Java爬虫的瓶颈分析与动态线程优化方案
Java 数据库 Spring
48 0
|
25天前
|
算法 Java
Java多线程编程:实现线程间数据共享机制
以上就是Java中几种主要处理多线程序列化资源以及协调各自独立运行但需相互配合以完成任务threads 的技术手段与策略。正确应用上述技术将大大增强你程序稳定性与效率同时也降低bug出现率因此深刻理解每项技术背后理论至关重要.
59 16