`
huiqinbo
  • 浏览: 344438 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

@SuppressWarnings("**")是什么意思【回钦波详细解答】

 
阅读更多
    很多网友问我(回钦波)很多 @SuppressWarnings的事情,在这里我想举点例子说明一下,
J2SE 提供的最后一个批注是 @SuppressWarnings。该批注的作用是给编译器一条指令,告诉它对被批注的代码元素内部的某些警告保持静默。 

一点背景:J2SE 5.0 为 Java 语言增加了几个新的特性,并且和它们一起增加了许多新的警告并承诺在将来增加更多的警告。您可以为 "javac" 增加 -Xlint 参数来控制是否报告这些警告(如上面的 @Deprecated 部分所示)。 

默认情况下,Sun 编译器以简单的两行的形式输出警告。通过添加 -Xlint:keyword 标记(例如 -Xlint:finally),您可以获得关键字类型错误的完整说明。通过在关键字前面添加一个破折号,写为 -Xlint:-keyword,您可以取消警告。(-Xlint 支持的关键字的完整列表可以在 javac 文档页面上找到。)下面是一个清单: 


关键字  用途 
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 了吗?这些称为元数据批注,它们描述了该批注在哪里适用。我将在本系列的第二篇文章中介绍它们,以及介绍如何将元数据批注应用到您自己的批注中。 
更多了解、更多交流:QQ444084929【回钦波】  http://www.huiqinbo.com
分享到:
评论

相关推荐

    @SuppressWarnings

    - **文档与维护**:如果确实需要使用`@SuppressWarnings`,最好在代码中添加相应的注释说明为什么需要抑制这个警告,以方便后续的维护工作。 #### 六、进一步学习 如果你想了解更多关于`@SuppressWarnings`的信息...

    关于@SuppressWarnings("uncheck ")(转)

    ### 关于@SuppressWarnings("unchecked")详解 在Java编程中,`@SuppressWarnings` 是一个非常有用的注解,它允许开发者暂时忽略某些编译警告。这在处理一些已知但并不影响程序运行安全性的警告时非常有用。本文将...

    @SuppressWarnings简介

    `@SuppressWarnings` 是 Java 编程语言中的一个注解,它在 J2SE 5.0 版本中被引入,用于控制编译时的警告信息。这个注解的目的是让程序员能够选择性地抑制(忽略)特定类型的编译器警告,避免在代码中看到这些警告,...

    suppressWarnings注解参数介绍

    下面将详细介绍`@SuppressWarnings`注解的各种参数及其应用场景。 ### 1. `deprecation` `@SuppressWarnings("deprecation")`用于抑制与过时(deprecated)方法或类相关的警告。当一个API不再推荐使用但又不能立即...

    java SuppressWarnings

    下面将详细介绍`@SuppressWarnings`的用法、参数及其应用场景。 #### 1. SuppressWarnings注解简介 `@SuppressWarnings`是Java中的一个内置注解,用于告知编译器忽略指定类型的警告。该注解可以应用于类、方法、...

    java中的SuppressWarnings(xxx).doc

    ### Java中的@SuppressWarnings详解 #### 一、@SuppressWarnings("serial")的理解与应用 ##### 1.1 注解概述 `@SuppressWarnings("serial")` 是 Java 中一个重要的注解,用于抑制有关 `serialVersionUID` 的编译...

    注解annotation的详细介绍

    3. **@SuppressWarnings**: `@SuppressWarnings`注解用于抑制编译器的警告信息。你可以指定一个或多个参数来控制要忽略的警告类型。常见的参数有`unchecked`、`deprecation`等。在示例中,若不希望看到未检查类型...

    完整版 Java高级教程 Java语言程序设计 第7章 Java注解(共10页).ppt

    3. **@SuppressWarnings**:用于抑制编译器的警告信息。可以指定要忽略的警告类型,避免过多的警告信息干扰开发流程。 4. **@Documented**:当应用到其他注解上时,确保该注解在生成的Javadoc中被包含,提高文档的...

    Hibernate+Annotation.doc

    3. **@SuppressWarnings**: 这个注解用于抑制编译器的警告信息。在处理一些可能导致警告的代码段时,如使用了`@Deprecated`的方法,可以通过`@SuppressWarnings`注解来避免编译器显示警告。 4. **@Entity**: `@...

    annotation.rar

    - **@ SuppressWarnings**: 用于抑制编译器警告,比如未使用的变量或不安全的类型转换。 - **@FunctionalInterface**: 标记一个接口为函数式接口,表示该接口仅有一个抽象方法。 - **@Nullable** 和 **@NonNull**...

    Java Annonation

    - **@SuppressWarnings**:用于抑制警告信息。 - **@SafeVarargs**:用于标记可能不安全的可变参数方法。 ##### 3.2 元注解 - **@Retention**:用于指定注解的保留策略。 - **@Target**:用于指定注解可以应用的...

    Java中三种标准注解和四种元注解.pdf

    3. **@SuppressWarnings** - 此注解用于抑制编译器的警告信息。如果你不想看到特定类型的警告,可以在问题出现的地方使用它,指定要抑制的警告类型。 **四种元注解** 元注解是用于注解其他注解的注解,它们定义了...

    java中元注解及实列

    3. **@SuppressWarnings**:抑制编译器警告。可以指定要忽略的警告类型,例如“unchecked”或“deprecation”。 ```java @SuppressWarnings("deprecation") public void someMethod() { // ... } ``` 4. **@...

    CacheManager.java 管理缓存

    @SuppressWarnings("all") public class CacheManager { private static HashMap cacheMap = new HashMap(); /** * 单实例构造方法 */ private CacheManager() { super(); } /** * 得到缓存。同步...

    6.注解-introdute.doc

    3. **@SuppressWarnings**:这个注解用于抑制编译器的警告信息。在`SuppressWarningsTest`类中,由于使用了未指定类型的`HashMap`,通常会产生警告,但通过`@SuppressWarnings({"unchecked","deprecation"})`可以...

    maxx 注解晨会

    - **@SuppressWarnings**:用于抑制编译器警告。例如,`@SuppressWarnings("deprecation")`可以忽略使用了已废弃API的警告。 #### 3. 自定义注解 自定义注解是根据项目需求创建的特定注解。例如: ```java ...

    JavaSE进阶-09-注解1

    - **@SuppressWarnings**:抑制特定类型的警告,如未检查转换、过时类使用等。 3. **定制注释类型**: - 可以自定义注解,如`@NewAnnotation`,并应用到类、方法等元素上。 4. **使用定制注释类型**: - 创建的...

    java jsonto对象互转

    @SuppressWarnings("unchecked") public static <T> T jsonToObject(String jsonString, Class<T> pojoCalss) { Object pojo; JSONObject jsonObject = JSONObject.fromObject(jsonString); pojo = JSONObject....

    Java实战篇:设计自己的Annotation

    - **@Target**:用于指定Annotation可以应用的元素类型,例如类、方法、字段等。 **2.2.2 创建自定义Annotation** 假设我们要创建一个用于标记测试方法的Annotation,名为`@TestMethod`,它可以应用于方法上,并且...

Global site tag (gtag.js) - Google Analytics