java常见的3种注解（Annotation）

1.@Deprecated

2 @Override

3.@SuppressWarnings

Annotation，是Java5的新特性，下面是Sun的Tutorial的描述，因为是英文，这里我翻译下，希望能够比较清晰的描述一下Annotation的语法以及思想。

JDK5引入了Metedata(元数据)很容易的就能够调用Annotations.Annotations提供一些本来不属于程序的数据，比如:一段代码的作者或者告诉编译器禁止一些特殊的错误。An annotation 对代码的执行没有什么影响。Annotations使用@annotation的形势应用于代码：类(class),属性(field),方法(method)等等。一个Annotation出现在上面提到的开始位置，而且一般只有一行,也可以包含有任意的参数。@Author("MyName")class myClass() { }

  or @SuppressWarnings("unchecked")void MyMethod() { }

  Defining your own annotation is an advanced technique that won't be described here, but there are three built-in annotations that every Java programmer should know: @Deprecated, @Override, and @SuppressWarnings. The following example illustrates all three annotation types, applied to methods:

  定义自己的Annotation是一个比较高级的技巧，这里我们不做讨论，这里我们仅仅讨论每一个Java programer都应该知道的内置的annotations:@Deprecated, @Override, and @SuppressWarnings。下面的程序阐述了这三种annotation如何应用于methods。import java.util.List;

  class Food {}

  class Hay extends Food {}

  class Animal {

  Food getPreferredFood() {

  return null; } /** * @deprecated document why the method was deprecated */

  @Deprecated

  static void deprecatedMethod() { }

  }

  class Horse extends Animal {

  Horse() {

  return;

  }

  @Override

  Hay getPreferredFood() {

  return new Hay();

  }

  @SuppressWarnings("deprecation")

  void useDeprecatedMethod() {

  Animal.deprecateMethod(); //deprecation warning - suppressed }}

  }

  }

 

  @Deprecated @Deprecated annotation标注一个method不再被使用。编译器在一个program(程序？)使用了不赞成的方法，类，变量的时候会产生警告(warning)。如果一个元素(element:method, class, or variable)不赞成被使用，应该像前面的例子里使用相应的@deprecated 标签，并且注意标签的首字母是小写的"d",而annotation时大写的"D"。一般情况下，我们应该避免使用不赞成使用的方法(deprecated methods)，而应该考虑替代的方法。

 

  @Override @Override annotation 告诉编译器当前元素是重写(override)自父类的一个元素。在前面的例子中，override annotation用来说明Horse类中的getPreferredFood这个方法重写(override)自Animal类中相同的方法。如果一个方法被标注了@Override，但是其父类中没有这个方法时，编译器将会报错。但是并不是说我们一定要使用这个annotation，但是它能够很明显的给出实际行为，尤其是在方法返回一个被重写的方法返回类型的子类型的时候。上面的例子中，Animal.getPreferredFood 返回一个 Food实例，Horse.getPreferredFood 返回一个Hay实例，这里Horse是Animal的子类，Hay是Food的子类。

@SuppressWarnings annotation 告诉编译器禁止别的元素产生的特殊的警告(warnings)，在前面的例子里，useDeprecatedMethod调用了Animal的不赞成使用的一个方法。一般情况下，编译器会给出一个警告(warning)，但是在这种情况下，不会产生这个警告，也就是说被suppress。每个编译器的警告都属于一个类型。Java Language Specification列出了两种类型："deprecation" 和 "unchecked"。"unchecked" warning 发生在使用非generic的旧代码交互的generic collection类时。为了禁止不止一种的警告时，使用下面的语法:@SuppressWarnings({"unchecked", "deprecation"})