场景

最近写一个文档, 用到了一个导出类的属性释义, 但这些释义定义在导出类属性上的注解上, 如下

几十个字段好几个类, 一个个敲是自然万万不可,复制也太慢, 最好是写个代码一锅端!

方案

此处用到了反射, 还有java.lang下的两个方法

•  java.lang.Package.isAnnotationPresent(Class<? extends Annotation> annotationClass) 
  • 如果指定类型的注释存在于此元素上,  方法返回true
• java.lang.Package.getAnnotation(Class< A > annotationClass) 
  • 如果是该类型的注释, 方法返回该元素的该类型的注释

实例

实体类TestExportVO

import java.io.Serializable;
import java.lang.reflect.Field;

import cn.afterturn.easypoi.excel.annotation.Excel;
import io.swagger.annotations.ApiModel;
import lombok.Data;

@Data
@ApiModel(value = "TestExportVO")
public class TestExportVO implements Serializable {
    private static final long serialVersionUID = 1L;

    /** 姓名 */
    @Excel(name = "姓名", width = 15)
    private String studentName;

    /** 身份证号 */
    @Excel(name = "身份证号", width = 20)
    private String identityId;

    /** 学号 */
    @Excel(name = "学号", width = 20)
    private String studentId;

    /** 出生日期 */
    @Excel(name = "出生日期", width = 15)
    private String birthday;

    // ......
}

获取注释上的内容 

    public static void main(String[] args) {
        // 获取类注解
        if(TestExportVO.class.isAnnotationPresent(ApiModel.class)){
            System.out.println(TestExportVO.class.getAnnotation(ApiModel.class).value());
        }

        // 获取类变量注解：
        Field[] fields = TestExportVO.class.getDeclaredFields();
        for (Field f : fields) {
            if(f.isAnnotationPresent(Excel.class)){
                System.out.print(f.getAnnotation(Excel.class).name() + ",");
            }
        }
    }

运行如下

扩展

获取方法上的注解

        // 获取方法注解：
        Method[] methods = TestExportVO.class.getDeclaredMethods();
        for (Method m : methods) {
            if(m.isAnnotationPresent(Excel.class)){
                System.out.println(m.getAnnotation(Excel.class).name());
            }
        }

获取方法参数上的注解

        // 获取方法参数注解：
        Method[] methods2 = TestExportVO.class.getDeclaredMethods();
        for (Method m : methods2) {
            // 获取方法的所有参数
            Parameter[] parameters = m.getParameters();
            for (Parameter p : parameters) {
                // 判断是否存在注解
                if(p.isAnnotationPresent(Excel.class)){
                    System.out.println(p.getAnnotation(Excel.class).name());
                }
            }
        }

以前不知道注解有什么用，现在学到了框架，发现到处都是注解。所以搞明白注解的原理还是很有必要的。

要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解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 Table {
    /**
     * 数据表名称注解，默认值为类名称
     * @return
     */
    public String tableName() default "className";
}

@Target(ElementType.FIELD)
public @interface NoDBColumn {

}

　　注解Table 可以用于注解类、接口(包括注解类型) 或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。

@Retention：

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

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

　　取值（RetentionPoicy）有：

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

　　实例代码：

/**
 * 
 * @author peida
 *
 */
@Inherited
public @interface Greeting {
    public enum FontColor{ BULE,RED,GREEN};
    String name();
    FontColor fontColor() default FontColor.GREEN;
}

自定义注解实例

自定义一个注解：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Target(ElementType.METHOD)//注解作用于方法
public @interface MyAnnotation {
	String name()default "张三丰";
	int abilityNum()default 1;
	String[] abilityNames()default {"太极拳"};
}

测试代码：测试是否能获取注解的参数 

public class TestAnnotation {

	@MyAnnotation(name="令狐冲",abilityNum=2,abilityNames= {"独孤九剑","吸星大法"})
	public void people1(String name,int age) {
	}

	@MyAnnotation(name="段誉",abilityNum=2,abilityNames= {"凌波微步","六脉神剑"})
	public void people2(String name,int age) {
	}

	@MyAnnotation     //没有配置，则使用默认值
	public void people3(String name,int age) {
	}

	public static void main(String[] args){

		Method[] methods=TestAnnotation.class.getMethods();//反射获取所有方法

		for(Method m:methods) { //遍历所有方法
			if(m.isAnnotationPresent(MyAnnotation.class)) {//判断方法是否有MyAnnotation注解

				MyAnnotation myAnno=m.getAnnotation(MyAnnotation.class);

				System.out.print(myAnno.name()+"有" +myAnno.abilityNum()+"个技能： ");

				for(String abilityName:myAnno.abilityNames()) {
					System.out.print(abilityName+" ");
				}
				System.out.println();
			}
			
		}
	}
}

输出结果：

段誉有2个技能： 凌波微步 六脉神剑 

令狐冲有2个技能： 独孤九剑 吸星大法 

张三丰有1个技能： 太极拳