Java的Annotation（注解）

原文地址：http://hi.baidu.com/274084093/item/95124a41e893da17886d106b

注解为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据。它是对来自像C#之类的其他语言对Java造成的语言特性压力所做出的一种回应。
一、Java内置基本注解
　　在Java中内置几种了基本的注解，下面列出几种常用的注解：
　　1、@Deprecated：用该注解注释的程序元素，表明不鼓励程序员使用这样的元素，通常是它很危险或存在更好的选择。
　　2、@Override：表明当前的方法定义将覆盖超类中的方法。
　　3、@SuppressWarnings：表明关闭不当的编译器警告信息。
　　4、@Documented：表明某一类型的注释将通过javadoc和类似的默认工具进行文档化。
　　5、@Inherited：允许子类继承父类中的注解。
　　6、@Retention：表明需要在什么级别保存该注解信息。
　　7、@Target：表明该注解可以用于什么地方。
　　8、@Generated：该注解用于标记已生成的源代码，它可以用于区分单个文件中用户编写的代码和生成的代码。
　　9、@PostConstruct：该注解用于在依赖关系注入完成之后需要执行的方法上，以执行任何初始化。
　　10、@PreDestroy：该注解作为回调通知用于各方法，以表示该实例正处于被容器移除的过程中。
　　11、@Resource：该注解用于标记应用程序所需要的资源。
二、定义注解
　　注解的定义看起来很像接口的定义，具体代码如下：
Java代码  收藏代码
   1. import java.lang.annotation.*;  
   2. @Target(ElementType.METHOD)  
   3. @Retention(RetentionPolicy.RUTIME)  
   4. public @interface Test {}  
import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUTIME)
public @interface Test {}
　　除了@符号之外，@Test的定义很像一个空的接口，定义一个注解的时候，要用到一些元注解（Java内置的注解），如上面例子中的定义，@Target表明新定义的注解将用于方法定义上，@Retention表明新定义的注解将在运行时起作用。

Java SE5内置四种元注解
@Target:表示该注解可以用于什么地方.可能的ElementType参数包括:
1)CONSTRUCTOR:构造器的声明
2)FIELD:域声明(包括enum实例)
3)LOCAL_VARIABLE:局部变量声明
4)METHOD:方法声明
5)PACKAGE:包声明
6)PARAMETER:参数声明
7)TYPE:类、接口(包括注解类型)或enum声明
@Retention:表示需要在什么级别保存该注解信息.可选的RetentionPolicy参数包括:
1)SOURCE:注解将被编译器丢弃
2)CLASS:注解在class文件中可用,但会被VM丢弃
3)RUNTIME:VM将在运行期也保留注解,因此可以通过反射机制读取注解的信息
@Documented:将此注解包含在Javadoc中
@Inherited:允许子类继承父类中的注解
大多数时候,程序员主要是定义自己的注解，并编写自己的处理器来处理它们.

在注解中，一般都会包含一些元素以表示某些值，而没有元素的注解称为标记注解，如上面的@Test注解，下面定义一个新的注解，将包含一些元素，如：
Java代码  收藏代码

package com;    
import java.lang.annotation.*;
@Target(ElementType.METHOD)

//用来定义你的注解将应用在什么地方,本处应用为方法 
@Retention(RetentionPolicy.RUNTIME)

//用来定义该注解在哪一个级别可用,在源代码中(source)类文件中(class)或者运行时(runtime) 
public @interface UseCase
{
　　public int id();
　　publicString description() default"no description";
}
　　该注解中定义了两个元素id和description，其中description元素通过default指定了默认值。

packagecom;    
public class PasswordUtils {    
 @UseCase(id=47,description="Passwords must contain at least one numeric")    
 public booleanvalidatePassword(){    
  return true;    
 }   
 @UseCase(id=48)    
 publicString encryptPassword(String password){    
  return password;    
 }    
 @UseCase(id=49,description="Jong_Cai")    
 public voidshowName(){    
  System.out.println("Jong_Cai");    
 }    
}   
 如果没有用来读取注解的工具,那注解也不会比注释更有用.使用注解的过程中.很重要的一个部分就是创建与使用注解处理器.Java SE5扩展了反射机制的API,以帮助程序员构造这类工具.同时,它还提供了一个外部工具apt帮助程序员解析带有注解的Java源代码.下面是一个非常简单的注解处理器,我们将用它来读取PasswordUtils类,并使用反射机制查找@UseCase标记.我们为其提供了一组id值得,然后它会列出在PasswordUtils中找到的用例,以及缺失的用例.
------------------------ UseCaseTracker.java ---------------------------   

package com;

import java.lang.reflect.Method;

import java.util.ArrayList;

import java.util.Collections;

import java.util.List;

public class UseCaseTracker {

    public static void trackUseCases(List<Integer> list, Class<?>cl) {

       for (Method m : cl.getDeclaredMethods()) {

           UseCase us = m.getAnnotation(UseCase.class);

           if (us != null) {

              System.out.println("Found UseCase:" + us.id() + " "

                     + us.description());

              list.remove(new Integer(us.id()));

           }

       }

       for (int i : list) {

           System.out.println("Warning:Missinguse case-" + i);

       }

    }

    public static void main(String[] args) {

       List<Integer> list = new ArrayList<Integer>();

       Collections.addAll(list, 47, 48, 49, 50, 51);

       trackUseCases(list, PasswordUtils.class);

    }

}

执行结果：

Found Use Case:47 Passwords must contain at least one numeric
Found Use Case:48 no description
Found Use Case:49 Jong_Cai
Warning:Missing use case-50
Warning:Missing use case-51

这个程序用到了两个反射的方法:getDeclaredMethods()和getAnnotation(),它们都属于AnnotatedElement接口(class,Method与Field等类都实现了该接口).getAnnotation()方法返回指定类型的注解对象,在这里就是UseCase,如果被注解的方法上没有该类型的注解,则返回null值.然后我们通过调用id()和description()方法从返回的UseCase对象中提取元素的值.其中encryptPassword()方法在注解的时候没有指定description的值,因此处理器在处理它对应的注解时,通过description()方法取得的是默认值no description.
三、注解处理器
　　如果没有用来读取注解的工具，那注解也不会比注释更有用，使用注解的过程中，很重要的一部分就是创建与使用注解处理器，而注解处理器的编写需要更加实际应用来灵活应用。
四、注意地方
　　1、注解元素可以用的类型只有：所有基本类型(int,float,boolean)、String、Class、enum、Annotation、以上类型的数组。
　　2、在定义元素的默认值时有限制，首先，元素不能有不确定的值，也就是说，元素必须要么具有默认值，要么在使用注解时提供元素的值；其次，对于非基本类型的元素，不能以null作为其值。
　　3、注解不支持继承。