JAVA Annotation 自定义注解

    Annotation（注解），是源代码的元数据

    本质一：它是一个附属品，依赖其它元素存在

    本质二： 自己没有任何做用，在恰当的时候由外部程序解析产生做用

    做用：简化配置，增长代码可读性，提升系统的可维护性

Annotation（注解）就是Java提供了一种元程序中的元素关联任何信息和着任何元数据（metadata）的途径和方法。Annotion(注解)是一个接口，程序能够经过反射来获取指定程序元素的Annotion对象，而后经过Annotion对象来获取注解里面的元数据。

    Annotation(注解)是JDK5.0及之后版本引入的。它能够用于建立文档，跟踪代码中的依赖性，甚至执行基本编译时检查。从某些方面看，annotation就像修饰符同样被使用，并应用于包、类 型、构造方法、方法、成员变量、参数、本地变量的声明中。这些信息被存储在Annotation的“name=value”结构对中。

Java元注解和相关定义注解的语法

元注解：

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

@Retention: 定义注解的保留策略

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

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

    取值（RetentionPoicy）有：

        @Retention(RetentionPolicy.SOURCE)   //注解仅存在于源码中，在class字节码文件中不包含

        @Retention(RetentionPolicy.CLASS)     // 默认的保留策略，注解会在class字节码文件中存在，但运行时没法得到，

        @Retention(RetentionPolicy.RUNTIME)  // 注解会在class字节码文件中存在，在运行时能够经过反射获取到

@Target：定义注解的做用目标

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

    做用：用于描述注解的使用范围（即：被描述的注解能够用在什么地方）

    取值（RetentionPoicy）有：

        @Target(ElementType.TYPE)   //接口、类、枚举、注解

        @Target(ElementType.FIELD) //字段、枚举的常量

        @Target(ElementType.METHOD) //方法

        @Target(ElementType.PARAMETER) //方法参数

        @Target(ElementType.CONSTRUCTOR)  //构造函数

        @Target(ElementType.LOCAL_VARIABLE)//局部变量

        @Target(ElementType.ANNOTATION_TYPE)//注解

        @Target(ElementType.PACKAGE) ///包   

@Document：说明该注解将被包含在javadoc中

    @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 org.lvgang;

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

/**
 * 个人姓名注解
 * @author lvgang
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyName {
    String value() default "";
}

    

package org.lvgang;

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

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

}

 

package org.lvgang;

import org.lvgang.MyColor.Color;

public class My{
    
    @MyName("lvgang")
    private String name;
    
    @MyColor(myColor=Color.RED)
    private String color;
    
    public void setColor(String color) {
        this.color = color;
    }
    public String getColor() {
        return color;
    }
    
    public void setName(String appleName) {
        this.name = name;
    }
    public String getName() {
        return name;
    }
}

    注解元素的默认值：

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

package org.lvgang;

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

/**
 * 应者注解
 * @author lvgang
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Provider {
    /**
     * 编号
     * @return
     */
    public int id() default -1;
    
    /**
     * 名称
     * @return
     */
    public String name() default "";
    
    /**
     * 地址
     * @return
     */
    public String address() default "";
}

    定义了注解，并在须要的时候给相关类，类属性加上注解信息，若是没有响应的注解信息处理流程，注解能够说是没有实用价值。如何让注解真真的发挥做用，主要就在于注解处理方法，下一步咱们将学习注解信息的获取和处理！