Java 《注解篇》运行时注解

﹏ヽ暗。殇╰゛Y 2022-05-24 11:41 215阅读 0赞

## 基本概念 ##

<table> 
 <thead> 
  <tr> 
   <th>注解类型</th> 
   <th>特点</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>RetentionPolicy.SOURCE</td> 
   <td>注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；</td> 
  </tr> 
  <tr> 
   <td>RetentionPolicy.CLASS</td> 
   <td>注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期；</td> 
  </tr> 
  <tr> 
   <td>RetentionPolicy.RUNTIME</td> 
   <td>注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在</td> 
  </tr> 
 </tbody> 
</table>

## 参考文章 ##

https://juejin.im/post/5aa8bb61f265da239c7b0d55

## 什么是注解 ##

首先注解主要分为三类：

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>特点</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>标准 Annotation</td> 
   <td>包括 Override, Deprecated, SuppressWarnings，是java自带的几个注解，他们由编译器来识别，不会进行编译， 不影响代码运行，至于他们的含义不是这篇博客的重点，这里不再讲述。</td> 
  </tr> 
  <tr> 
   <td>元 Annotation</td> 
   <td>@Retention, @Target, @Inherited, @Documented，它们是用来定义 Annotation 的 Annotation。也就是当我们要自定义注解时，需要使用它们。</td> 
  </tr> 
  <tr> 
   <td>自定义 Annotation</td> 
   <td>根据需要，自定义的Annotation。而自定义的方式</td> 
  </tr> 
 </tbody> 
</table>

## 自定义注解 ##

### Retention ###

<table> 
 <thead> 
  <tr> 
   <th>可选</th> 
   <th>特点</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>RetentionPolicy.SOURCE</td> 
   <td>源码时注解，一般用来作为编译器标记。如Override, Deprecated, SuppressWarnings。</td> 
  </tr> 
  <tr> 
   <td>RetentionPolicy.RUNTIME</td> 
   <td>运行时注解，在运行时通过反射去识别的注解。</td> 
  </tr> 
  <tr> 
   <td>RetentionPolicy.CLASS</td> 
   <td>编译时注解，在编译时被识别并处理的注解。</td> 
  </tr> 
 </tbody> 
</table>

### Target ###

<table> 
 <thead> 
  <tr> 
   <th>可选</th> 
   <th>特点</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ElementType.TYPE</td> 
   <td>类、接口、注解类型或枚举</td> 
  </tr> 
  <tr> 
   <td>ElementType.FIELD</td> 
   <td>属性</td> 
  </tr> 
  <tr> 
   <td>ElementType.METHOD</td> 
   <td>方法</td> 
  </tr> 
  <tr> 
   <td>ElementType.PARAMETER</td> 
   <td>用于描述参数</td> 
  </tr> 
  <tr> 
   <td>ElementType.CONSTRUCTOR</td> 
   <td>构造方法</td> 
  </tr> 
  <tr> 
   <td>ElementType.LOCAL_VARIABLE</td> 
   <td>局部变量</td> 
  </tr> 
  <tr> 
   <td>ElementType.ANNOTATION_TYPE</td> 
   <td>注解类</td> 
  </tr> 
  <tr> 
   <td>ElementType.PACKAGE</td> 
   <td>包</td> 
  </tr> 
 </tbody> 
</table>

### @interface ###

@interface并不是说 下方代码 PrintView 是一个接口，而是声明注解。  
就像申明类用关键字class一样。申明注解用的就是@interface。  
（值得注意的是：在ElementType的分类中，class、interface、Annotation、enum同属一类为Type，并且从官方注解来看，似乎interface是包含@interface的）

### 常用方法 ###

class

<table> 
 <thead> 
  <tr> 
   <th>可选</th> 
   <th>特点</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>getFields</td> 
   <td>获得某个类的所有的公共（public）的字段，包括父类中的字段</td> 
  </tr> 
  <tr> 
   <td>getDeclaredFields</td> 
   <td>获得某个类的所有声明的字段，即包括public、private和proteced，但是不包括父类的申明字段</td> 
  </tr> 
  <tr> 
   <td>getMethods</td> 
   <td>获取某个类的方法，包括父类中的字段</td> 
  </tr> 
  <tr> 
   <td>getDeclaredMethods</td> 
   <td>获取某个类的方法，不包括父类</td> 
  </tr> 
  <tr> 
   <td>getConstructors</td> 
   <td>构造&lt;与上面相同，就不说明了&gt;</td> 
  </tr> 
  <tr> 
   <td>getDeclaredConstructors</td> 
   <td>构造</td> 
  </tr> 
 </tbody> 
</table>

获取返回值

public void init(IOfficialApi api) {
            Class a = api.getClass();
            Method[] methods = a.getDeclaredMethods();
            for (Method method: methods){
                // 类型
                System.out.println("类名 ->" + method.getName());
                // 得到方法的返回值类型的类类型
                Class<?> returnType = method.getReturnType();
                System.out.print("返回值 -> "  + returnType.getName() + " : " + returnType.get());
                System.out.println();
                // 参数名称
                Parameter[] parameters = method.getParameters();
                Class[] paramTypes = method.getParameterTypes();
                for (int i = 0; i < parameters.length; i++) {
                    System.out.print(parameters[i].getName() + " -> " + paramTypes[i].getName());
                }
                System.out.println();
            }
    
            t = HttpService.Companion.getOfficialApi().getPackageClient()
                    .observeOn(Schedulers.computation());
        }

## 运行时注解 ##

> 在运行时根据注解，通过反射获取具体信息，然后做一些操作。  
> （所以也会带来一定的性能开销）

*  声明注解

import java.lang.annotation.*;
    
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.TYPE})
    public @interface PrintView {
        int value();
    }

*  查找注解，并输出

public class Parent {
        public void create() {
            //注解解析
            PrintView annotation = this.getClass().getAnnotation(PrintView.class);
            if (annotation != null) {
                try {
                    int value = annotation.value();
                    System.out.println("查找到的值 -> " + value);
                } catch (RuntimeException e) {
                    e.printStackTrace();
                }
            }
        }
    }

*  使用注解

@PrintView(12345)
    public class Child extends Parent {}

public class main {
        public static void main(String[] args) {
            Child child = new Child();
            child.create();
        }
    }
    // 输出
    // 查找到的值 -> 12345