[java Annotation] 注解（Annotatin）自定义注解入门

引言

要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。

元注解

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它annotation类型说明。Java5.0定义的元注解：

1. @Target
2. @Retention
3. @Documented
4. @Inherited

@Target

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

**作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）
取值（ElementType)有：

• TYPE 类，接口（包括注解类型） 或者枚举
• FIELD 字段声明 （包括枚举的常量值）
• METHOD 方法声明
• PARAMETER 方法参数
• CONSTRUCTOR 构造器
• LOCAL_VARIABLE 本地变量
• ANNOTATION_TYPE 注解类型
• PACKAGE 包
• TYPE_PARAMETER 泛型中的类型参数
• TYPE_USE 泛型中使用的类型

使用实例：

@Target(ElementType.TYPE)public @interface Table {    /**     * 数据表名称注解，默认值为类名称     * @return     */    public String tableName() default "className";}@Target(ElementType.FIELD)public @interface NoDBColumn {}

注解Table可以用于注解类、接口（包括注解类型）或enum声明，而注解NoDBColumn仅可用于注解类的成员变量

@Retention

@Retention定义了该Annotation被保留的时间长短：

• 某些Annotaion仅出现在源代码中，而被编译器丢弃
• 一些被编译在class文件中编译在class文件中的Annotation可能会被虚拟机忽略
• 一些在runntime也有效

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

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

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)@Documentedpublic @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的子类。

@Inheritedpublic @interface Greeting {    public enum FontColor{ BULE,RED,GREEN};    String name();    FontColor fontColor() default FontColor.GREEN;}

自定义注解

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

定义注解格式

public @interface 注解名 {定义体}

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

• 所有的基本数据类型（byte, short, int, long, char, boolean, float, double)
• String类型
• Class类型
• enum类型
• Annotation类型
• 以上所有的类型的数组

Annotation类型里面的参数该怎么设定：

• 只能用public访问权修饰 （跟接口的规则一样）
• 参数成员只能用基本类型， String, Enum, Class, Annotation等引用类型
• 如果只有一个参数成员，最好把参数名称设为”value”, 后加小括号

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

注解元素的默认值

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

@Target(ElementType.FIELD)@Retention(RetentionPolicy,RUNTIME)@Documentedpublic @interface FruitProvider {    int id() default -1;    String name() default "";    String address() default "";

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

原文出处

深入理解Java：注解（Annotation）自定义注解入门:http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html