Java 注解Annotations 学习笔记

爱被打了一巴掌 2023-06-22 08:23 3阅读 0赞

### Java 注解Annotations 学习笔记 ###

*  逻辑梳理
 *  自定义注解
 *   *  1. \`@interface\` ：用于声明注解
     *  2. \`@Retentio\` ：用于定义注解的生命周期。
     *  3. \`@Target\` ：用于说明注解可以加在那些代码上。
     *  4. \`@Inherited\`：注解继承
     *  5. \`@Documented\` ：将类添加到\`javadoc\`文档中
     *  6. \`@Repeatable\`：可重复添加
 *  自定义注解例子
 *   *  定义个注解容器
     *  测试自定义注解
 *  参考资料

# 逻辑梳理 #

1.  注解本身只起一个标记的作用。(它的工作需要两个元注解配合)  
    1.1. `@Target`标记了注解应用于代码的某位置。  
    1.2. `@Retentio`标记注解的狗命留到何时。
2.  配合反射动态拿到注解。  
    2.1. 能拿到添加注解时指定的参数。  
    2.2. 根据需要添加代码处理业务逻辑。
3.  自定义注解一般配合AOP使用。  
    3.1. 先自定一个注解。  
    3.2. 创建个拦截器，拦截自定义注解，添加业务逻辑处理。

// 拦截指定注解修饰的方法
    @Pointcut(value = "@annotation(包名.注解名)")
    private void ponitcut(){ 
    	...
    }

# 自定义注解 #

## 1. `@interface` ：用于声明注解 ##

## 2. `@Retentio` ：用于定义注解的生命周期。 ##

*  这是个`元注解`（声明注解时使用到的注解）。
 *  值域：`java.lang.annotation.RetentionPolicy.*` 下面的代码中有注释

也就是保留到什么时候。具体看下面的代码注释说明。

<table> 
 <thead> 
  <tr> 
   <th align="left">保留策略</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">@Retention(RetentionPolicy.SOURCE)</td> 
   <td align="left">标记的注解只保留在源码中，会被编译器忽略。</td> 
  </tr> 
  <tr> 
   <td align="left">@Retention(RetentionPolicy.CLASS)</td> 
   <td align="left"><code>【默认】</code>编译器在编译时保留标记的注解，但会被Java虚拟机(JVM)无视。</td> 
  </tr> 
  <tr> 
   <td align="left">@Retention(RetentionPolicy.RUNTIME)</td> 
   <td align="left">标记的注解到JVM阶段，以便运行时环境可以通过反射获取它。</td> 
  </tr> 
 </tbody> 
</table>

## 3. `@Target` ：用于说明注解可以加在那些代码上。 ##

*  这是个`元注解`（声明注解时使用到的注解）。
 *  值域：`java.lang.annotation.ElementType.*` 下面的代码中有注释
 *  此参数类型是个 `ElementType` 数组，单个值时可以简写。

<table> 
 <thead> 
  <tr> 
   <th align="left">枚举</th> 
   <th align="left">表示注解可应用于</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">ElementType.ANNOTATION_TYPE</td> 
   <td align="left">注解</td> 
  </tr> 
  <tr> 
   <td align="left">ElementType.CONSTRUCTOR</td> 
   <td align="left">构造函数</td> 
  </tr> 
  <tr> 
   <td align="left">ElementType.FIELD</td> 
   <td align="left">字段或属性</td> 
  </tr> 
  <tr> 
   <td align="left">ElementType.LOCAL_VARIABLE</td> 
   <td align="left">局部变量</td> 
  </tr> 
  <tr> 
   <td align="left">ElementType.METHOD</td> 
   <td align="left">方法</td> 
  </tr> 
  <tr> 
   <td align="left">ElementType.PACKAGE</td> 
   <td align="left">包声明</td> 
  </tr> 
  <tr> 
   <td align="left">ElementType.PARAMETER</td> 
   <td align="left">方法的参数</td> 
  </tr> 
  <tr> 
   <td align="left">ElementType.TYPE</td> 
   <td align="left">接口、类、枚举</td> 
  </tr> 
  <tr> 
   <td align="left">ElementType.TYPE_PARAMETER</td> 
   <td align="left">类型参数声明 JDK1.8开始</td> 
  </tr> 
  <tr> 
   <td align="left">ElementType.TYPE_USE</td> 
   <td align="left">任何类型名称声明 JDK1.8开始</td> 
  </tr> 
 </tbody> 
</table>

## 4. `@Inherited`：注解继承 ##

*  这是个`元注解`（声明注解时使用到的注解）。
 *  表示注解类型可以从超类继承，当用户查询注释类型，而类没有该类型的注释时，将查询类的超类以获取注释类型。此注释仅适用于类声明。

## 5. `@Documented` ：将类添加到`javadoc`文档中 ##

*  这是个`元注解`（声明注解时使用到的注解）。
 *  给一个类添加`@Documented`表示此类的信息将出现在`javadoc`生成的文档中。

## 6. `@Repeatable`：可重复添加 ##

*  这是个`元注解`（声明注解时使用到的注解）。
 *  `@Repeatable`是在`Java SE 8`中引入的，表示标记的注释可以对相同的声明或类型使用应用不止一次。

# 自定义注解例子 #

先创建一个自定义注解，把能勾的选项都勾上。

package com.jerry.demo;
    
    import static java.lang.annotation.ElementType.ANNOTATION_TYPE;//标注"注释类型声明"
    import static java.lang.annotation.ElementType.CONSTRUCTOR;//标注"构造方法声明"
    import static java.lang.annotation.ElementType.FIELD;//标注"字段(属性)声明"
    import static java.lang.annotation.ElementType.LOCAL_VARIABLE;//标注"局部变量声明"
    import static java.lang.annotation.ElementType.METHOD;//标注"方法声明"
    import static java.lang.annotation.ElementType.PACKAGE;//标注"包声明"
    import static java.lang.annotation.ElementType.PARAMETER;//标注"参数声明"
    import static java.lang.annotation.ElementType.TYPE;//标注"类、接口（包括注释）或枚举声明"
    import static java.lang.annotation.ElementType.TYPE_PARAMETER;//标注"类型参数声明" JDK1.8开始
    import static java.lang.annotation.ElementType.TYPE_USE;//标注"任何类型名称声明" JDK1.8开始
    import static java.lang.annotation.RetentionPolicy.RUNTIME;
    
    import java.lang.annotation.Repeatable;
    import java.lang.annotation.Retention;//注释只在源代码级别保留，编译时被忽略
    import java.lang.annotation.Target;//注解可以被使用在那些地方
    
    @Repeatable(JerryAnnotations.class)//此注解可以多次应用于相同的声明或类型
    //@Inherited//定义子类是否可继承父类定义的Annotation。仅针对@Target(ElementType.TYPE)类型的annotation有效，并且仅针对class的继承，对interface的继承无效
    @Retention(RUNTIME)
    @Target({  TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,
    		ANNOTATION_TYPE, PACKAGE, TYPE_PARAMETER, TYPE_USE })
    public @interface JerryAnnotation { 
    	String[] value() default { };
    // String value() default "";
    }

## 定义个注解容器 ##

如果注解是可以重复添加的，则需要定义这个。

package com.jerry.demo;
    
    import java.lang.annotation.Documented;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    
    @Documented//该 Annotation 标签将出现在 javadoc 中
    @Retention(RetentionPolicy.RUNTIME)
    public @interface JerryAnnotations { 
    	JerryAnnotation[] value();
    }

*  `java.lang.annotation.RetentionPolicy`

/** * 定义了 Annotation 的生命周期 * @author Administrator */
    public enum RetentionPolicy { 
    	//注释只在源代码级别保留，编译时被忽略
    	SOURCE,
    	//注释将被编译器在类文件中记录 但在运行时不需要JVM保留。这是默认的 行为
    	CLASS,
    	/** * 注解将被编译器记录在类文件中,并会保留到VM中运行时，因此可以反射得到注解。 * @see java.lang.reflect.AnnotatedElement */
    	RUNTIME
    }

## 测试自定义注解 ##

**判断调用对象是否包含指定注解。`Class、Field、Method、Constructor` 都可以使用。**  
等价于`getAnnotation(annotationClass) != null`

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

package com.jerry.demo;
    
    import java.lang.annotation.Annotation;
    import java.lang.reflect.InvocationTargetException;
    import java.lang.reflect.Method;
    
    public class Test { 
    	
    	@JerryAnnotation("可重复添加：第一波")
    // @JerryAnnotation("可重复添加：第二波")
    // @JerryAnnotation("可重复添加：第三波")
    	public void foo(){ 
    		System.out.println("666666666666666");
    	}
    	
    	public static void main(String[] args) throws NoSuchMethodException, SecurityException, IllegalAccessException, IllegalArgumentException, InvocationTargetException { 
    		Test test = new Test();
    		// 获取Person的Class实例
            Class<Test> c = Test.class;
            // 获取 foo() 方法的Method实例
            Method sfoo = c.getMethod("foo");
            //sfoo.invoke(test); // 调用方法
            // 打印注解信息
            iteratorAnnotations(sfoo);
    	}
    	
    	public static void iteratorAnnotations(Method method) { 
    
    		// --------------- 判断注解时候存在，存在就直接读取 ---------------
            // 判断 方法是否包含JerryAnnotation注解（当注解是可重复的，并且添加了1个以上，此处为false）
            if(method.isAnnotationPresent(JerryAnnotation.class)){ 
                // 获取该方法的JerryAnnotation注解实例
            	JerryAnnotation jerryAnnotation = method.getAnnotation(JerryAnnotation.class);
                // 获取 jerryAnnotation的值，并打印出来
                String[] values = jerryAnnotation.value();
                for (String str:values)
                    System.out.printf(str+", ");
                System.out.println();
            }
            
            // --------------- 获取方法上的所有注解 ---------------
            Annotation[] annotations = method.getAnnotations();
            for(Annotation annotation : annotations){ 
                System.out.println(annotation);
            }
            
            // --------------- 获取方法参数上的所有注解 ---------------
            // 用二位参数接收：arr[参数][参数的注解]
            Annotation[][] annotationParams = method.getParameterAnnotations();
            
            // 遍历 按参数分注解
            for(Annotation[] annos : annotationParams){ 
            	// 遍历注解
            	for(Annotation anno : annos){ 
            		// 判断注解是谁
            		if (anno instanceof SomeAnnotation) { 
            			SomeAnnotation sa = (SomeAnnotation) anno;
            			...
            	    }
                }
            }
        }
    }

# 参考资料 #

[廖学峰 Java教程 注解][Java_]  
[https://docs.oracle.com/javase/tutorial/java/annotations/][https_docs.oracle.com_javase_tutorial_java_annotations]  
[https://www.javatpoint.com/java-annotation][https_www.javatpoint.com_java-annotation]

[Java_]: https://www.liaoxuefeng.com/wiki/1252599548343744/1255945389098144
[https_docs.oracle.com_javase_tutorial_java_annotations]: https://docs.oracle.com/javase/tutorial/java/annotations/
[https_www.javatpoint.com_java-annotation]: https://www.javatpoint.com/java-annotation