java注解

系统内置标准注解：

注解的语法比较简单，除了@符号的使用外，他基本与Java固有的语法一致，JavaSE中内置三个标准注解，定义在java.lang中：

@Override：用于修饰此方法覆盖了父类的方法;

@Deprecated：用于修饰已经过时的方法;

@SuppressWarnnings:用于通知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声明

@Target(ElementType.TYPE)
public @interface User {
    public String userName() default "wuming";
}

@Retention

@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；

而另一些却被编译在class文件中，编译在class文件中的Annotation可能会被虚拟机忽略；

而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。

使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

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

取值（RetentionPoicy）有：

　　　　1.SOURCE:在源文件中有效（注解的信息会被编译器抛弃，不会留在class文件中，注解的信息只会留在源文件中）

　　　　2.CLASS:在class文件中有效（注解的信息被保留在class文件(字节码文件)中当程序编译时，但不会被虚拟机读取在运行的时候）

　　　　3.RUNTIME:在运行时有效（注解的信息被保留在class文件(字节码文件)中当程序编译时，会被虚拟机保留在运行时，

所以他们可以用反射的方式读取）

Retention meta-annotation类型有唯一的value作为成员，它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理

@Documented

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

@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类型被发现，或者到达类继承结构的顶层。

举例

@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Inherited1 {
    String value();
}

Inherited2没有该注解

@Retention(RetentionPolicy.RUNTIME)
public @interface Inherited2 {
    String value();
}

@Inherited1("使用Inherited的注解 class")
@Inherited2("未使用Inherited的注解 class")
public class Parent {
    @Inherited1("使用Inherited的注解 method1")
    @Inherited2("未使用Inherited的注解 method1")
    public  void  method1(){}
    @Inherited1("使用Inherited的注解 method2")
    @Inherited2("未使用Inherited的注解 method2")
    public  void  method2(){}
    @Inherited1("使用Inherited的注解 field")
    @Inherited2("未使用Inherited的注解 field")
    public String str;
}

子类继承父类

public class Child extends Parent{
    @Override
    public void method1() {
    }
}

public class test {
    public static void main(String[] args) throws NoSuchMethodException, NoSuchFieldException {
        Class<Child> clazz = Child.class;
        System.out.println("对类测试");
        if(clazz.isAnnotationPresent(Inherited1.class)){
            System.out.println(clazz.getAnnotation(Inherited1.class).value());
        }
        if(clazz.isAnnotationPresent(Inherited2.class)){
            System.out.println(clazz.getAnnotation(Inherited2.class).value());
        }
        System.out.println("对方法测试");
        Method method1 = clazz.getMethod("method1", null);
        if(method1.isAnnotationPresent(Inherited1.class)){
            System.out.println(method1.getAnnotation(Inherited1.class).value());
        }
        if(method1.isAnnotationPresent(Inherited2.class)){
            System.out.println(method1.getAnnotation(Inherited2.class).value());
        }
        System.out.println("对方法2测试");
        Method method2 = clazz.getMethod("method2", null);
        if(method2.isAnnotationPresent(Inherited1.class)){
            System.out.println(method2.getAnnotation(Inherited1.class).value());
        }
        if(method2.isAnnotationPresent(Inherited2.class)){
            System.out.println(method2.getAnnotation(Inherited2.class).value());
        }
        System.out.println("对属性测试");
        Field str = clazz.getField("str");
        if(str.isAnnotationPresent(Inherited1.class)){
            System.out.println(str.getAnnotation(Inherited1.class).value());
        }
        if(str.isAnnotationPresent(Inherited2.class)){
            System.out.println(str.getAnnotation(Inherited2.class).value());
        }
    }
}

结果：

对类测试

使用Inherited的注解 class

对方法测试

对方法2测试

使用Inherited的注解 method2

未使用Inherited的注解 method2

对属性测试

使用Inherited的注解 field

未使用Inherited的注解 field

说明通过Inherited元注解声明的自定义注解，在类上使用时，可以被子类继承，method1是重写的方法，且Inherited对方法无效，所以没有输出

        method2用的是父类的方法，所以都能输出，同理属性的测试

 

注解参数的可支持数据类型：

1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)

2.String类型

3.Class类型

4.enum类型

5.Annotation类型

6.以上所有类型的数组

 

注解参数设置

第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为default默认类型；　 　

第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　

第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

 

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
    /**
     * 颜色枚举
     * @author peida
     *
     */
    public enum Color{ BULE,RED,GREEN};
    
    /**
     * 颜色属性
     * @return
     */
    Color fruitColor() default Color.GREEN;
}

public class Apple {
    
    @FruitName("Apple")
    private String appleName;
    
    @FruitColor(fruitColor=Color.RED)
    private String appleColor;
    
    
    
    
    public void setAppleColor(String appleColor) {
        this.appleColor = appleColor;
    }
    public String getAppleColor() {
        return appleColor;
    }
    
    
    public void setAppleName(String appleName) {
        this.appleName = appleName;
    }
    public String getAppleName() {
        return appleName;
    }
    
    public void displayName(){
        System.out.println("水果的名字是：苹果");
    }
}

注解元素的默认值：

 

　　注解元素必须有确定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态，因为每个注解的声明中，所有元素都存在，并且都具有相应的值，为了绕开这个约束，我们只能定义一些特殊的值，例如空字符串或者负数，一次表示某个元素不存在，在定义注解时，这已经成为一个习惯用法。例如：

@Target(ElementType.FIELD)
15 @Retention(RetentionPolicy.RUNTIME)
16 @Documented
17 public @interface FruitProvider {
18     /**
19      * 供应商编号
20      * @return
21      */
22     public int id() default -1;
23     
24     /**
25      * 供应商名称
26      * @return
27      */
28     public String name() default "";
29     
30     /**
31      * 供应商地址
32      * @return
33      */
34     public String address() default "";
35 }

注解处理器

如果没有用来读取注解的方法和工作，那么注解也就不会比注释更有用处了。使用注解的过程中，很重要的一部分就是创建于使用注解处理器。Java SE5扩展了反射机制的API，以帮助程序员快速的构造自定义注解处理器。

注解处理器类库(java.lang.reflect.AnnotatedElement)：

 

　　Java使用Annotation接口来代表程序元素前面的注解，该接口是所有Annotation类型的父接口。除此之外，Java在java.lang.reflect 包下新增了AnnotatedElement接口，该接口代表程序中可以接受注解的程序元素，该接口主要有如下几个实现类：

 

　　Class：类定义

　　Constructor：构造器定义

　　Field：累的成员变量定义

　　Method：类的方法定义

　　Package：类的包定义

java.lang.reflect 包下主要包含一些实现反射功能的工具类，实际上，java.lang.reflect 包所有提供的反射API扩充了读取运行时Annotation信息的能力。当一个Annotation类型被定义为运行时的Annotation后，该注解才能是运行时可见，当class文件被装载时被保存在class文件中的Annotation才会被虚拟机读取。

　　AnnotatedElement 接口是所有程序元素（Class、Method和Constructor）的父接口，所以程序通过反射获取了某个类的AnnotatedElement对象之后，程序就可以调用该对象的如下四个个方法来访问Annotation信息：

 

　　方法1：<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回null。

　　方法2：Annotation[] getAnnotations():返回该程序元素上存在的所有注解。

　　方法3：boolean isAnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解，存在则返回true，否则返回false.

　　方法4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注释。与此接口中的其他方法不同，该方法将忽略继承的注释。（如果没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响。

使用举例

public class Apple {
    
    @FruitName("Apple")
    private String appleName;
    
    @FruitColor(fruitColor=Color.RED)
    private String appleColor;
    
    @FruitProvider(id=1,name="陕西红富士集团",address="陕西省西安市延安路89号红富士大厦")
    private String appleProvider;
    
    public void setAppleColor(String appleColor) {
        this.appleColor = appleColor;
    }
    public String getAppleColor() {
        return appleColor;
    }
    
    public void setAppleName(String appleName) {
        this.appleName = appleName;
    }
    public String getAppleName() {
        return appleName;
    }
    
    public void setAppleProvider(String appleProvider) {
        this.appleProvider = appleProvider;
    }
    public String getAppleProvider() {
        return appleProvider;
    }
    
    public void displayName(){
        System.out.println("水果的名字是：苹果");
    }
}

public class FruitInfoUtil {
    public static void getFruitInfo(Class<?> clazz){
        
        String strFruitName=" 水果名称：";
        String strFruitColor=" 水果颜色：";
        String strFruitProvicer="供应商信息：";
        
        Field[] fields = clazz.getDeclaredFields();
        
        for(Field field :fields){
            if(field.isAnnotationPresent(FruitName.class)){
                FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);
                strFruitName=strFruitName+fruitName.value();
                System.out.println(strFruitName);
            }
            else if(field.isAnnotationPresent(FruitColor.class)){
                FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);
                strFruitColor=strFruitColor+fruitColor.fruitColor().toString();
                System.out.println(strFruitColor);
            }
            else if(field.isAnnotationPresent(FruitProvider.class)){
                FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);
                strFruitProvicer=" 供应商编号："+fruitProvider.id()+" 供应商名称："+fruitProvider.name()+" 供应商地址："+fruitProvider.address();
                System.out.println(strFruitProvicer);
            }
        }
    }
}