java基础之：java注解

一：元注解

      元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：
　　1.@Target,
　　2.@Retention,
　　3.@Documented,
　　4.@Inherited
　　这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

　@Target：

　 　　@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循 环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

　　作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

　　取值(ElementType)有：

　　　　1.CONSTRUCTOR:用于描述构造器
　　　　2.FIELD:用于描述域即类成员变量
　　　　3.LOCAL_VARIABLE:用于描述局部变量
　　　　4.METHOD:用于描述方法
　　　　5.PACKAGE:用于描述包
　　　　6.PARAMETER:用于描述参数
　　　　7.TYPE:用于描述类、接口(包括注解类型) 或enum声明



@Retention：

  @Retention定 义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在 class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为 Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

　　作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

　　取值（RetentionPoicy）有：

　　　　1.SOURCE:在源文件中有效（即源文件保留）
　　　　2.CLASS:在class文件中有效（即class保留）
　　　　3.RUNTIME:在运行时有效（即运行时保留）



@Documented:

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



@Inherited：

 

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

　　注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

　 　当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继 承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现， 或者到达类继承结构的顶层.









二：自定义注解
     使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细 节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数 的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。
       定义注解格式：
　　public @interface 注解名 {定义体}
注解参数的可支持数据类型：

　　　　1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)
　　　　2.String类型
　　　　3.Class类型
　　　　4.enum类型
　　　　5.Annotation类型
　　　　6.以上所有类型的数组

　　Annotation类型里面的参数该怎么设定:
　　第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　 　
　 　第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　
　　第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

三：实例

《一》类注解

package com.yeepay.thead.test;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 
 * @author shangxiaofei
 *(1)使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。
 *(2)在定义注解时，不能继承其他的注解或接口。
 *(3)@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。
 *(4)方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。
 *(5)可以通过default来声明参数的默认值。
 *(6)因为没有定义public，所以默认的访问权限为包权限，在定义时没有指定默认值，则使用时必须指定默认值  
 */


@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MyAnnotationByClass {
    //定义一个name属性
    public String name() default "sxf"; 
    
    //定义一个内部枚举类
    public enum SEX{MAN,WOMEN};
    
    //定义一个性别的属性
    public SEX xingbie();
    
    //定义一个年龄的类型
    public int age();
}

《二》属性注解

package com.yeepay.thead.test;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MyAnnotationByField {
    
    public String value() default "";
}

《三》方法注解

package com.yeepay.thead.test;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 方法注解
 * @author shangxiaofei
 *
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MyAnotationByMethod {
    
    public String fundcheck() default "";

}

《四》测试

package com.yeepay.thead.test;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

import com.yeepay.thead.test.MyAnnotationByClass.SEX;


public class AnotationTest {

    public static void main(String[] args) {
        User user=new User("sxf");
        //testClassAnotation(user);
        //testFieldAnotation(user);
        testMethodAnnotation(user);
    }
    
    
    /**
     * 测试注释类的注解
     * @param user
     */
    public static void testClassAnotation(User user){
        //获取对象的类
        Class cls=user.getClass();
        //判断当前的类的对象是否是这个注解注释的
        boolean flag =cls.isAnnotationPresent(MyAnnotationByClass.class);
        if(flag){
            //如果是这个注解注释的，则获取这个注解对象
            MyAnnotationByClass myAnnotationByClass=(MyAnnotationByClass) cls.getAnnotation(MyAnnotationByClass.class);
            //获取注解的属性值
            String name=myAnnotationByClass.name();
            SEX sex=myAnnotationByClass.xingbie();
            int age=myAnnotationByClass.age();
            System.out.println("AnotationTest.testClassAnotation()"+name);
            System.out.println("AnotationTest.testClassAnotation()"+sex);
            System.out.println("AnotationTest.testClassAnotation()"+age);
        }
        
    }
    
    /**
     *测试属性的注解
     * @param user
     */
    public static void testFieldAnotation(User user){
        //获取对象的类
        Class cls=user.getClass();
        //判断当前的类的对象是否是这个注解注释的
        Field[] fields=cls.getDeclaredFields();
        for(int i=0;i<fields.length;i++){
            Field fil=fields[i];
            boolean flag=fil.isAnnotationPresent(MyAnnotationByField.class);
            if(flag){
                MyAnnotationByField myAnnotationByField=fil.getAnnotation(MyAnnotationByField.class);
                //获取属性注解的值
                String value=myAnnotationByField.value();
                System.out.println("AnotationTest.testFieldAnotation()"+value);
            }
        }
    }
    
    
    /**
     * 测试方法注解
     * @param user
     */
    public static void testMethodAnnotation(User user){

        //获取对象的类
        Class cls=user.getClass();
        //获取所有的方法
        Method[] methods=cls.getDeclaredMethods();
        for(int i=0;i<methods.length;i++){
            Method method=methods[i];
            boolean flag=method.isAnnotationPresent(MyAnotationByMethod.class);
            if(flag){
                //获取注解的值
                MyAnotationByMethod myAnotationByMethod=method.getAnnotation(MyAnotationByMethod.class);
                String fundcheck=myAnotationByMethod.fundcheck();
                System.out.println("AnotationTest.testMethodAnnotation()"+fundcheck);
            }
            
        }
    }
}