java 自定义注解

java 自定义注解
========================================================
Java注解主要在包java.lang.annotation中实现

一、元注解
@Documented、@Inherited、@Retention、@Target

1. @Documented
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，
因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。
（简单理解就是可以被文档化）

2. @Inherited
@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。
如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

3. @Retention
定义了该Annotation被保留的时间长短：
某些Annotation仅出现在源代码中，而被编译器丢弃；
而另一些却被编译在class文件中，编译在class文件中的Annotation可能会被虚拟机忽略；
而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。
使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
RetentionPolicy.RUNTIME 注解会在class字节码文件中存在，在运行时可以通过反射获取到
RetentionPolicy.CLASS 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得
RetentionPolicy.SOURCE 注解仅存在于源码中，在class字节码文件中不包含

4. @Target
@Target说明了Annotation所修饰的对象范围：Annotation可被用于
packages、types（类、接口、枚举、Annotation类型）、
类型成员（方法、构造方法、成员变量、枚举值）、
方法参数和本地变量（如循环变量、catch参数）。

ElementType.CONSTRUCTOR  作用于构造器
ElementType.FIELD  作用于域/属性
ElementType.LOCAL_VARIABLE  用于描述局部变量
ElementType.METHOD  作用于方法
ElementType.PACKAGE   用于描述包
ElementType.PARAMETER   用于描述参数
ElementType.TYPE   用于描述类、接口(包括注解类型) 或enum声明，最常用

单个修饰对象的范围：@Target(ElementType.TYPE)  
多个修饰对象的范围：@Target({ ElementType.TYPE, ElementType.METHOD})

二、作用于类、方法、属性

1. 创建一个注解类【定义注解】

/**
 * 定义一个用户名的自定义注解
 */  
@Documented //文档  
@Retention(RetentionPolicy.RUNTIME) //在运行时可以获取  
@Target({ ElementType.TYPE, ElementType.METHOD}) //作用到类，方法，接口上等  
@Inherited //子类会继承  
public @interface UserNameAnnotations {  
      
    public String value() default "taiyang"; //使用的时候 @UserNameAnnotations(value="太阳")  
 
}

2. 创建一个Test类 【使用注解】

/** 
 * 一个注解的测试类 
 */  
//注解作用于类上面  
//可以通过反射 获取类的信息之后 获取得到这个注解的值
@UserNameAnnotations(value = "太阳")   
public class Test {  
  
    private String userName;
  
    public String getUserName() {  
        return userName;  
    }  
  
    public void setUserName(String userName) {  
        this.userName = userName;  
    }  
  
}

3. 测试类【解析注解】

public class mainTest {

    //通过isAnnotationPresent()方法判断是否类上是否有某个注解
    //通过getAnnotation()可以获取注解对象
 
    /** 作用于类 **/
    public static void main_class(String[] args) {  
        Class<Test> testClass = Test.class;  
        if (testClass.isAnnotationPresent(UserNameAnnotations.class)) {
            UserNameAnnotations userNameAnnotations = (UserNameAnnotations) testClass.getAnnotation(UserNameAnnotations.class);
            if (userNameAnnotations != null) {
                System.out.println("value:" + userNameAnnotations.value());  
            } else {  
                System.out.println("null");  
            }  
        } else {
            System.out.println("this is not UserNameAnnotations Annotations class");  
        }  
    }
    
    /** 作用于方法 **/
    Method method = testClass.getDeclaredMethod("getUserName");//获取方法
    method.isAnnotationPresent()/method.getAnnotation()
    
    /** 作用于属性字段 **/
    Field field = testClass.getDeclaredField("userName");//获取字段
    field.isAnnotationPresent()/field.getAnnotation()
}

参考: http://blog.csdn.net/initphp/article/details/37041975