解释一:
屏蔽某些编译时的警告信息
在强制类型转换的时候编译器会给出警告
加上
程序代码
@SuppressWarnings("unchecked")
就不会警告了
解释二:
注释类型
当你的编码可能存在警告时,比如安全警告,可以用它来消除
api中是这样描述的
指示应该在注释元素(以及包含在该注释元素中的所有程序元素)中取消显示指定的编译器警告。注意,在给定元素中取消显示的警告集是所有包含元素中取消显示的警告的超集。例如,如果注释一个类来取消显示某个警告,同时注释一个方法来取消显示另一个警告,那么将在此方法中同时取消显示这两个警告。
根据风格不同,程序员应该始终在最里层的嵌套元素上使用此注释,在那里使用才有效。如果要在特定的方法中取消显示某个警告,则应该注释该方法而不是注释它的类。
解释三:
@SuppressWarnings
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`注解的主要作用是告诉编译器忽略被注解的代码元素内部的某些警告。这种机制对于处理那些已知但不影响代码功能性的警告特别有用。 ##### 1. 使用场景 - **抑制特定类型的警告**:例如,当你明确...
`@SuppressWarnings` 的主要作用是消除开发者认为不重要的或者暂时无法解决的警告。这在大型项目中尤其有用,因为大量的警告信息可能会使真正的问题变得难以发现。通过使用此注解,开发者可以集中精力处理更重要的...
@SuppressWarnings({"unchecked", "deprecation"}) ``` 这段代码表示抑制了两种类型的警告:“unchecked”(未检查的转换)和“deprecation”(过时的方法调用)。 #### 3. 常见的警告类型及示例 ##### 3.1 过时...
"Maven"是一个广泛使用的项目管理工具,它简化了Java项目的构建、依赖管理和文档生成。"flume-plugin-maven-plugin-1.0.zip"是针对Apache Flume的一个Maven插件,版本为1.0。Apache Flume是一款分布式、可靠且可用于...
对于带有参数的注释,如`@SuppressWarnings("unchecked")`,可以省略参数名`value`,直接写成`@SuppressWarnings("unchecked")`。 注释可以分为三类: 1. **标记注释**:没有参数的注释。 2. **单值注释**:有一个...
- **消除感叹号**:`@SuppressWarnings` 用于抑制编译器的警告,如 `@SuppressWarnings("unchecked")` 可以阻止未检查类型转换警告。注解的 `value` 属性可以指定要忽略的警告类型,若只有一个值,可以省略属性名和...
@SuppressWarnings("unchecked") public void suppressWarning() { List<String> list = (List) new ArrayList(); } // 使用 @SafeVarargs 标记可能不安全的可变参数方法 public static <T> T[] toArray(@...
@SuppressWarnings("unchecked") public void add(String data) { list.add(data); } ``` #### 五、自定义注解 除了内置注解外,Java还允许开发者定义自己的注解类型。下面是一些关于自定义注解的基础示例。 ...
在这个例子中,@SuppressWarnings("unchecked")用于抑制未检查的类型转换警告。 4. **自定义注解@NewAnnotation的使用**: ```java @NewAnnotation("mainmethod") public class AnnotationTest { public ...
@SuppressWarnings("unchecked") public void addJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName, Class jobClass, String cronExpression, Object data) { newJob...
例如,`@SuppressWarnings("unchecked")`可以防止编译器对潜在的未检查类型转换发出警告。 自定义的Annotation则允许开发者根据需求创建自己的元数据。定义自定义Annotation需要使用`@interface`关键字,可以包含零...
注释并非仅用于文档化代码,而是具有实际的功能性作用。从Java 5开始,引入了注解这一特性,极大地增强了代码的可维护性和灵活性。 首先,我们有三种类型的注解:标记注解、单值注解和多值注解。标记注解不包含任何...
在文档中,@deprecated标签也有类似的作用,两者主要区别在于@Deprecated是JDK 5引入的注解形式。 3. @ SuppressWarnings:这个注解用于抑制编译器发出的警告。它可以应用于类、方法、变量或整个源文件,以消除特定...
例如,`@SuppressWarnings` 可以用于消除编译器发出的特定类型的警告,如使用了过时的 API (`deprecation`)、未检查的转换(`unchecked`)等。 3. **完整注释**: 完整注释可以包含多个参数,但 Java 内置的注解通常...
@SuppressWarnings("unchecked") public static void createWord(Map dataMap,String templateName,String filePath,String fileName){ try { //创建配置实例 Configuration configuration = new ...
`SuppressWarnings`还可以接受多个参数,如`"rawtypes"`和`"unchecked"`,分别用于抑制未指定泛型类型和执行未检查转换的警告。 3. **元注解**:元注解定义了其他注解的行为。`@Target`指定注解可以应用到哪些程序...