自定义注解使用

注解介绍

它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。为程序的元素（类、方法、成员变量）加上更直观、更明了的说明，这些说明信息是与程序的业务逻辑无关，并且供指定的工具或框架使用。Annontation像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中

注解本质是一个继承了Annotation 的特殊接口，其具体实现类是Java 运行时生成的动态代理类。而我们通过反射获取注解时，返回的是Java 运行时生成的动态代理对象$Proxy1。通过代理对象调用自定义注解（接口）的方法，会最终调用AnnotationInvocationHandler 的invoke 方法 

元注解

所有元注解定义在java.lang.annotation包下面，其中Annotation是注解的基本接口，所有的注解都继承这个接口

 java.lang.annotation 提供了四种元注解，专门注解其他的注解（在自定义注解的时候，需要使用到元注解）

1、@Documented：指定被标注的注解会包含在javadoc中

2、@Retention： 指定注解的生命周期（源码、class文件、运行时），其参考值见类的定义：java.lang.annotation.RetentionPolicy

RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式。
RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。 

3、@Target：指定注解使用的目标范围（类、方法、字段等），其参考值见类的定义：java.lang.annotation.ElementTyp

ElementType.CONSTRUCTOR ：用于描述构造器。

ElementType.FIELD ：成员变量、对象、属性（包括enum实例）。
ElementType.LOCAL_VARIABLE: 用于描述局部变量。
ElementType.METHOD ： 用于描述方法。
ElementType.PACKAGE ：用于描述包。
ElementType.PARAMETER ：用于描述参数。
ElementType.ANNOTATION_TYPE：用于描述参数
ElementType.TYPE ：用于描述类、接口(包括注解类型) 或enum声明。

 4、@Inherited：指定子类可以继承父类的注解，只能是类上的注解，方法和字段的注解不能继承。即如果父类上的注解是@Inherited修饰的就能被子类继承

注解处理器类库 

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

代码案例：

public <T extends Serializable> List<LogSystem> generateLog(T target) {
	Class<? extends Serializable> clz = target.getClass();
	Field[] fields = clz.getDeclaredFields();
	Method[] methods = clz.getMethods();
	SystemLogging clzAnnotation = null;
	// 类上是否有标注了@systemlogging注解
	if(clz.isAnnotationPresent(SystemLogging.class)){
	}
	for (Method method : methods) {
		// 方法上是否标注了@systemlogging注解
		if(method.isAnnotationPresent(SystemLogging.class)){
		}
	}
	for(Field field : fields){
		// 属性上是否有标注了@systemlogging注解
		if(field.isAnnotationPresent(SystemLogging.class)){
		}
        // 获取属性上指定注解的内容，不存在返回null
        SystemLogging systemLogging = field.getAnnotation(SystemLogging.class);
	}
}

自定义注解

• Annotation 类型定义为@interface, 所有的Annotation 会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口。
•   参数成员只能用public 或默认(default) 这两个访问权修饰。语法：类型  属性名()  [default 默认值];      default表示默认值 ，也可以不编写默认值的.
•   参数成员只能用基本类型byte、short、char、int、long、float、double、boolean八种基本数据类型和String、Enum、Class、annotations等数据类型，以及这一些类型的数组.
•   要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation 对象，因为你除此之外没有别的获取注解对象的方法。
•   注解也可以没有定义成员,，不过这样注解就没啥用了

代码案例

@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SystemLogging {
    String[] keys() default {};

    String value() default "";

    String secondValue() default "";

    String keyName() default "字段";

    Class<? extends KeyEnums>[] keyEnum() default {};

    boolean deleted() default false;
}

切面类使用自定义注解

@Component
@Aspect
@Slf4j
public class CheckAspect {

    @Pointcut(value ="@annotation(systemLogging)")
	public void checkUser(SystemLogging systemLogging) {
       // 加了注解的方法会进入切面类
	}

}

springboot中的自定义注解类

springboot扩展注解：SpringBoot重点详解--@Conditional注解_pengjunlee的博客-CSDN博客