Java中@SuppressWarnings的使用

一、@SuppressWarnings("serial")是什么意思？

 

比如有个类实现了java.io.Serialize接口：

package com.onede4.test;public class TestSerial implementsjava.io.Serializable {}

   如果代码仅仅写上这样，放在eclipse里会给你提示一个黄色的警告，为啥呢，就是因为，你实现了Serializable 接口，但是没有给出private static final longserialVersionUID = 5952689219411916553L;类似这样的私有字段（这个字段是实现了Serializable接口需要的，但不必须）只要加上类似这样的一个字段，黄色警告就会消失，但是你如果就是不想加这个字段，同时还不想看到那个黄色的警告，没问题，那就要在类上加一个注解（@SuppressWarnings("serial")）

package com.onede4.test;@SuppressWarnings("serial")public class TestSerial implementsjava.io.Serializable {}

这样eclipse就不会有那个黄色的警告了，不过我们还是推荐给出private static final longserialVersionUID = 5952689219411916553L;当你的类进行序列化和反序列化操作的时候如果没有这个字段可能会出问题，所以尽量加上这个字段，不要用@SuppressWarnings("serial")注解

压制要求提供串行版本标志serialVersionUID的警告信息

serialVersionUID作用：

   序列化时为了保持版本的兼容性，即在版本升级时反序列化仍保持对象的唯一性。

有两种生成方式：

   一个是默认的1L，比如：private static final longserialVersionUID = 1L; 一个是根据类名、接口名、成员方法及属性等来生成一个64位的哈希字段，比如：

 private static final   long     serialVersionUID = xxxxL;

   当你一个类实现了Serializable接口，如果没有定义serialVersionUID，Eclipse会提供这个 提示功能告诉你去定义 。在Eclipse中点击类中warning的图标一下，Eclipse就会自动给定两种生成的方式。如果不想定义它，在Eclipse的设置中也可以把它关掉的，设置如下：

  Window ==> Preferences ==> Java ==> Compiler ==>Error/Warnings ==>

  Potential programming problems

 将Serializable class withoutserialVersionUID的warning改成ignore即可。

   如果你没有考虑到兼容性问题时，就把它关掉，不过有这个功能是好的，只要任何类别实现了Serializable这个接口的话，如果没有加入serialVersionUID，Eclipse都会给你warning提示，这个serialVersionUID为了让该类别Serializable向后兼容。 如果你的类Serialized存到硬盘上面后，可是后来你却更改了类别的field(增加或减少或改名)，当你Deserialize时，就会出现Exception的，这样就会造成不兼容性的问题。但当serialVersionUID相同时，它就会将不一样的field以type的预设值Deserialize，可避开不兼容性问题。

二、@suppressWarnings（"xxxxx"）是什么意思？

    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 警告的一个例子：

publicclass DeprecatedExample2 {  @Deprecated  public static void foo() {  }}publicclass DeprecatedUser2 { @SuppressWarnings(value={"deprecation"})publicstatic void main(String[] args) {    DeprecatedExample2.foo();  }}

    @SuppressWarnings 批注接收一个 "value" 变量，该变量是一个字符串数组，它指示将取消的警告。合法字符串的集合随编译器而变化，但在 JDK 上，可以传递给 -Xlint 的是相同的关键字集合（非常方便）。并且要求编译器忽略任何它们不能识别的关键字，这在您使用一些不同的编译器时非常方便。

    因为 @SuppressWarnings 批注仅接收一个参数，并为该参数使用了特殊的名称 "value"，所以您可以选择省略 value=，作为一种方便的缩写：

publicclass DeprecatedUser2 {  @SuppressWarnings({"deprecation"})publicstatic void main(String[] args) {    DeprecatedExample2.foo();  }}

    您可以将单个数组参数中的任意数量的字符串值传递给批注，并在任何级别上放置批注。例如，以下示例代码指示将取消整个类的 deprecation 警告，而仅在 main() 方法代码内取消 unchecked 和 fallthrough 警告：

importjava.util.*;@SuppressWarnings({"deprecation"})publicclass NonGenerics { @SuppressWarnings({"unchecked","fallthrough"})publicstatic 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 了吗？这些称为元数据批注，它们描述了该批注在哪里适用。我将在本系列的第二篇文章中介绍它们，以及介绍如何将元数据批注应用到您自己的批注中。