J2SE 提供的最后一个批注是 @SuppressWarnings。该批注的作用是给编译器一条指令,告诉它对被批注的代码元素内部的某些警告保持静默。
一点背景:J2SE 5.0 为 Java 语言增加了几个新的特性,并且和它们一起增加了许多新的警告并承诺在将来增加更多的警告。您可以为 "javac" 增加 -Xlint 参数来控制是否报告这些警告(如上面的 @Deprecated 部分所示)。
默认情况下,Sun 编译器以简单的两行的形式输出警告。通过添加 -Xlint:keyword 标记(例如 -Xlint:finally),您可以获得关键字类型错误的完整说明。通过在关键字前面添加一个破折号,写为 -Xlint:-keyword,您可以取消警告。(-Xlint 支持的关键字的完整列表可以在 上找到。)下面是一个清单:
关键字 用途
deprecation 使用了不赞成使用的类或方法时的警告
unchecked 执行了未检查的转换时的警告,例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型。
fallthrough 当 Switch 程序块直接通往下一种情况而没有 Break 时的警告。
path 在类路径、源文件路径等中有不存在的路径时的警告。
serial 当在可序列化的类上缺少 serialVersionUID 定义时的警告。
finally 任何 finally 子句不能正常完成时的警告。
all 关于以上所有情况的警告。
@SuppressWarnings 批注允许您选择性地取消特定代码段(即,类或方法)中的警告。其中的想法是当您看到警告时,您将调查它,如果您确定它不是问题,您就可以添加一个 @SuppressWarnings 批注,以使您不会再看到警告。虽然它听起来似乎会屏蔽潜在的错误,但实际上它将提高代码安全性,因为它将防止您对警告无动于衷 — 您看到的每一个警告都将值得注意。
下面是使用 @SuppressWarnings 来取消 deprecation 警告的一个例子:
public class DeprecatedExample2 { @Deprecated public static void foo() { } } public class DeprecatedUser2 { @SuppressWarnings(value={"deprecation"}) public static void main(String[] args) { DeprecatedExample2.foo(); } }
@SuppressWarnings 批注接收一个 "value" 变量,该变量是一个字符串数组,它指示将取消的警告。合法字符串的集合随编译器而变化,但在 JDK 上,可以传递给 -Xlint 的是相同的关键字集合(非常方便)。并且要求编译器忽略任何它们不能识别的关键字,这在您使用一些不同的编译器时非常方便。
因为 @SuppressWarnings 批注仅接收一个参数,并为该参数使用了特殊的名称 "value",所以您可以选择省略 value=,作为一种方便的缩写:
public class DeprecatedUser2 { @SuppressWarnings({"deprecation"}) public static void main(String[] args) { DeprecatedExample2.foo(); } }
您可以将单个数组参数中的任意数量的字符串值传递给批注,并在任何级别上放置批注。例如,以下示例代码指示将取消整个类的 deprecation 警告,而仅在 main() 方法代码内取消 unchecked 和 fallthrough 警告:
import java.util.*; @SuppressWarnings({"deprecation"}) public class NonGenerics { @SuppressWarnings({"unchecked","fallthrough"}) public static void main(String[] args) { Runtime.runFinalizersOnExit(); List list = new ArrayList(); list.add("foo"); } public static void foo() { List list = new ArrayList(); list.add("foo"); } }
@SuppressWarnings 是否比前两个批注更有用?绝对是这样。不过,在 JDK 1.5.0 版本中还没有完全支持该批注,如果您用 1.5.0 来尝试它,那么它将类似无操作指令。调用 -Xlint:-deprecation 也没有任何效果。Sun 没有声明什么时候将增加支持,但它暗示这将在即将推出的一个 dot 版本中实现。
更进一步
如果您试图在 Javadocs 页面中查看这些属性,那么您可能很难找到它们。它们位于核心的 java.lang 包中,但有点隐蔽,它们出现在 Javadoc 类的最底端,列在 Exceptions 和 Errors 后面。
注意到了附加在 SuppressWarnings 批注后面的陌生的批注 @Target 和 @Retention 了吗?这些称为元数据批注,它们描述了该批注在哪里适用。我将在本系列的第二篇文章中介绍它们,以及介绍如何将元数据批注应用到您自己的批注中。
分享到:
相关推荐
### @SuppressWarnings 注解详解 #### 一、概述 在Java编程中,`@SuppressWarnings`是一个十分重要的注解,主要用于抑制代码中的警告信息。随着Java语言的发展,为了提高代码质量和安全性,J2SE 5.0引入了许多新...
### 关于@SuppressWarnings("unchecked")详解 在Java编程中,`@SuppressWarnings` 是一个非常有用的注解,它允许开发者暂时忽略某些编译警告。这在处理一些已知但并不影响程序运行安全性的警告时非常有用。本文将...
### Java中的@SuppressWarnings详解 #### 一、@SuppressWarnings("serial")的理解与应用 ##### 1.1 注解概述 `@SuppressWarnings("serial")` 是 Java 中一个重要的注解,用于抑制有关 `serialVersionUID` 的编译...
### Java SuppressWarnings详解 在Java开发过程中,经常会遇到编译器警告的问题,这些警告虽然不会阻止程序的编译和运行,但过多的警告会影响代码的可读性和维护性。为了解决这一问题,Java提供了`@...
### Annotation详解 #### 一、概述 在Java编程语言中,`Annotation`(注解)是一种元数据形式,用于向编译器或分析工具提供有关程序的信息,而不会影响程序的实际执行逻辑。开发者可以通过注解来标记代码的不同...
### JDK注释详解:深入理解Java中的注解 在Java开发中,注解(Annotation)是一种重要的元数据机制,用于向编译器、工具或框架提供额外的信息,从而增强代码的功能性和可读性。本文将从JDK源注释出发,深入解析三种...
在代码中使用注解时,将注解放在类、方法、字段、参数等元素前,比如 `@Override` 用于标记重写父类方法,`@Deprecated` 标记已废弃的方法,`@SuppressWarnings` 抑制编译器警告。注解不仅可以用于源码,还可以存在...
【标题】:注解(Annotation)详解 注解(Annotation)是Java编程语言中的一个重要特性,自Java 5版本引入,它提供了一种安全的方法来将元数据与代码关联。元数据是关于数据的数据,可以用来提供程序的额外信息,如...
- **@SuppressWarnings**:用于抑制编译器的警告,可以根据需要指定不同的参数来忽略特定类型的警告,如`@SuppressWarnings("deprecation")`来忽略使用了过时元素的警告。 **自定义注解**: Java允许创建自定义注解...
`@Override` 用于标记重写父类方法,`@Deprecated` 标记不再推荐使用的代码,`@SuppressWarnings` 可以抑制编译器警告。 2. **元注解**:元注解是用于定义其他注解的注解,包括 `@Retention`(定义注解的生命周期)...
### Java Annotation 规范详解 #### 一、Java Annotation 概述 在现代软件开发过程中,元数据(Metadata)的概念变得越来越重要。元数据是指关于数据的数据,它可以帮助我们更好地理解、管理和处理程序中的信息。...
Java提供了三种预定义的元注解,它们分别是`@Override`、`@Deprecated`和`@ SuppressWarnings`。`@Override`用于标记重写父类方法的方法,确保编译器检查方法是否真正覆盖了父类方法;`@Deprecated`用于标记不再推荐...
以下是对Java注解的全面详解: 1. **注解类型**: Java注解有三种类型:源码级注解、编译器注解和运行时注解。源码级注解在编译后不会保留,仅用于编译器进行语法检查;编译器注解会影响编译过程,如`@Override`;...
Java基础(5-8) - 注解机制详解 Java中的注解机制是从JDK1.5版本开始引入的特性,用于对代码进行说明,可以对包、类、接口、字段、方法参数、局部变量等进行注解。它主要的作用有四方面:生成文档、编译检查、编译时...
- `@ SuppressWarnings`:此注解用于指示编译器忽略特定类型的警告,如在使用过时方法时产生的"deprecation"警告。 2. **Java第三方注解** - 在Spring框架中,注解被广泛使用以简化配置和增强代码的可读性: - `...
本篇文章将重点介绍第16章中的内容——JDK内置的基本标注类型,包括`Override`、`Deprecated`、以及`SuppressWarnings`这三个核心标注。 ### 16.2 JDK内置的基本标注类型 #### 16.2.1 重写(Override) **概述**...
推荐阅读:Android WebView线性进度条实例详解 最近在android项目中使用webview嵌套了一个抽奖活动网页,活动上线,运行良好(改了N次需求和突发bug),还好这种模式的活动,只需要修改网页,不需要重新打包发布市场...
JavaSE071Target及ElementType详解 JavaSE071Target及ElementType是Java语言中两个重要的概念,它们都是Java注解(Annotation)的组成部分。本文将详细介绍JavaSE071Target及ElementType的概念、用法和实现原理。 ...