自定义注解 annotation 总结

要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。所以这篇文章我会首先和大家介绍一下一些必要了解的基本概念，然后我再用代码演示一下，最后再做一下简单的归纳总结。

 

一、必要了解的基本概念

1、元注解：元注解的作用就是负责注解其他注解。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去查询一个@Inheritedannotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

二、现在用代码演示一下怎么自定义注解：

定义一个@table注解

package com.gaox.annotataion;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * @author gaox * @createTime 2017年5月24日 下午2:25:11 */@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)public @interface Table {public String value() default "";public String descrip() default "";}

定义一个@id注解

package com.gaox.annotataion;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * @author gaox * @createTime 2017年5月24日 下午3:07:10 */@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)public @interface Id {public String value( ) default "";}

定义一个@column注解

package com.gaox.annotataion;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * @author gaox * @createTime 2017年5月24日 下午3:07:55 */@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)public @interface Column {public String name();public String descrip();}

然后我们在看看注解怎么用：

package com.gaox.entity;import java.io.Serializable;import java.util.Date;import com.gaox.annotataion.Column;import com.gaox.annotataion.Id;import com.gaox.annotataion.Table;/** * @author gaox * @createTime 2017年5月24日 下午2:22:32 */@Table("This is an annotation")public class Person implements Serializable{@Id("id")private Integer id;@Column(name="gaox",descrip="姓名")private String name;private String sex;private String address;private Date born;public Integer getId() {return id;}public void setId(Integer id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}public String getSex() {return sex;}public void setSex(String sex) {this.sex = sex;}public String getAddress() {return address;}public void setAddress(String address) {this.address = address;}public Date getBorn() {return born;}public void setBorn(Date born) {this.born = born;}public Person(String name, String sex, String address, Date born) {super();this.name = name;this.sex = sex;this.address = address;this.born = born;}public Person() {super();}}

测试一下看看，自定义的注解有没有作用

测试一：取出类上的@Table的参数值

package test;import java.lang.annotation.Annotation;import java.lang.reflect.InvocationTargetException;import java.lang.reflect.Method;import com.gaox.entity.Person;/** * @author gaox * @createTime 2017年5月24日 下午2:35:07 */public class Test {public static void main(String[] args) {Annotation[]annotations=Person.class.getAnnotations();for (Annotation a : annotations) {Method[] methods=a.annotationType().getDeclaredMethods();for (Method method : methods) {if(method.isAccessible()){method.setAccessible(true);}try {System.out.println(method.invoke(a, null));} catch (IllegalAccessException e) {// TODO Auto-generated catch blocke.printStackTrace();} catch (IllegalArgumentException e) {// TODO Auto-generated catch blocke.printStackTrace();} catch (InvocationTargetException e) {// TODO Auto-generated catch blocke.printStackTrace();}}}}}

测试结果输出了:This is anannotation

测试二：获取@cloumn的参数

package test;import java.lang.reflect.Field;import com.gaox.annotataion.Column;import com.gaox.entity.Person;/** * @author gaox * @createTime 2017年5月24日 下午3:16:59 */public class Test2 {public static void main(String[] args) {Field[] fields=Person.class.getDeclaredFields();for (Field field : fields) {if(!field.isAccessible()){field.setAccessible(true);}if(field.isAnnotationPresent(Column.class)){System.out.println("@Column的name:"+field.getAnnotation(Column.class).name());System.out.println("@Column的descrip:"+field.getAnnotation(Column.class).descrip());}}}}

测试结果输出：

@Column的name:gaox

@Column的descrip:姓名

三、总结一下：　　使用@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)这两个访问权修饰.例如,Stringvalue();这里把方法设为defaul默认类型；　
　　第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;
　　第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.

 

注解元素的默认值：

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

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