Java注解原理-优快云博客

本文链接：https://blog.youkuaiyun.com/sinat_34715587/article/details/144209199

Java注解是 Java 5 中引入的一种特殊类型的注释，它提供了一种将元数据或附加信息与程序元素（如类、方法、字段、参数等）相关联的方式。注解不会直接影响程序的执行逻辑，但它们可以被其他程序使用，例如编译器、开发工具或其他可以在运行时处理注解的代码。

在注解出现之前，配置都是通过写大量 XML 来完成的，XML的弊端是复杂且难维护，注解使用简单的标记式的方式进行配置，提高了开发效率。注解可以为 Java 代码提供元数据，各种框架也都会利用注解来暴露功能，比如 Spring 框架中的@Service、@Controller、@Bean注解，Spring Boot 的 @SpringBootApplication 注解。框架可以通过类或方法等元素上标记的注解，来了解它们的功能或特性，并以此来启用或执行相应的功能。通过注解而不是 API 调用来配置框架，属于声明式交互，可以简化框架的配置工作，也可以和框架解耦。系统功能封装也能依赖注解能力简化各种逻辑的重复实现。

Java注解的主要用途包括以下几个方面：

‌编译时处理‌：

‌代码生成‌：注解可以用来在编译时生成代码。比如 Java Persistence API（JPA）使用注解来定义实体和关系，编译器可以基于这些注解生成数据库表和其他相关代码‌。

‌编译检查‌：注解可以用来进行编译时的类型检查。比如 @Override 注解告诉编译器该方法旨在覆盖超类中的方法，如果没有正确覆盖，编译器将发出错误‌。

‌运行时处理‌：

‌配置管理‌：注解可以用来配置应用程序的各个方面。比如 Spring 框架使用注解来配置依赖注入‌。

‌行为改变‌：注解可以用来改变程序的行为。比如 JUnit 测试框架使用注解来标记测试方法‌。

‌文档生成‌：

注解可以用来生成API文档。比如 @Documented 注解可以用来指示一个注解应该被包含在生成的文档中‌。

注解原理

在 java.lang.annotation.Annotation 源码注释中有说明，所有的注解类型都继承自这个普通的公共接口（Annotation），本质上看注解是接口，但代码并没有显式声明继承关系。

// 注解的本质就是一个继承了 Annotation 接口的接口。
// 可以去反编译任意一个注解类来验证下
// 1、声明注解
public @interface SystemLog {}

// 2、查看指令
javap -v SystemLog.class

// 3、打印结果
Compiled from "SystemLog.java"
public interface sora.example.instances.SystemLog extends java.lang.annotation.Annotation

准确地说，注解是一种特殊的注释，如果没有解析它的代码，它可能连注释都不如。解析一个类或者方法的注解有两种形式，一种是编译时扫描，一种是运行时反射。

编译器扫描

编译器扫描是指编译器在对 java 代码编译字节码的过程中会检测到某个类或者方法被一些注解修饰，这时它会对这些注解进行某些处理。典型的就是 @Override 注解，一旦编译器检测到某个方法被 @Override 注解修饰了，编译器就会检查当前方法的方法签名是否真正重写了父类的某个方法，也就是比较父类中是否具有一个同样的方法签名。这种情况只适用于那些编译器已经熟知的注解类，比如 JDK 内置的几个注解，而自定义的注解，编译器是不知道注解作用的，当然也不知道该如何处理，往往只是会根据该注解的作用范围来选择是否编译进字节码文件。

运行时反射

通过”定义 - 标注 - 解析“实现一个注解Case，从虚拟机层面分析注解的本质到底是什么。这里通过反射（getAnnotation 方法）去获取注解类实例，JDK 通过动态代理机制生成一个实现注解（接口）的代理类（systemLog对象的类名输出的是代理类信息）。反射机制可以在程序运行时获取类的完整结构信息，代理模式给目标对象提供一个代理对象，由代理对象持有目标对象的引用。实现如下，

// 声明一个 SystemLog 注解，作用范围是在方法上，并在运行时保留，该注解通常用在服务运行时，结合AOP切面编程实现方法的日志采集
package sora.example.instances;

import java.lang.annotation.*;

@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SystemLog {
    String model() default "";
}

package sora.example.instances;

import java.lang.reflect.Method;

public class LogInfo {
    @SystemLog(model = "日志模块")
    public static void main(String[] args) throws NoSuchMethodException {
        // 反射机制
        Method method = LogInfo.class.getMethod("main", String[].class);
        SystemLog systemLog = method.getAnnotation(SystemLog.class);
        if (systemLog != null) {
            // 动态代理：com.sun.proxy.$Proxy2
            System.out.println(systemLog.getClass().getName());
            System.out.println(systemLog.model());
        }
    }
}

// 设置一个虚拟机启动参数，用于捕获 JDK 动态代理类
// -Dsun.misc.ProxyGenerator.saveGeneratedFiles=true
// 运行输出：
com.sun.proxy.$Proxy2
日志模块

执行后在代码工程目录下生成代理类，SystemLog 注解解析实际是在使用注解的代理类，$Proxy2代理类继承了 Proxy 类并实现了 SystemLog 接口，并重写了相关方法（包括 model 方法以及接口 SystemLog 从 Annotation 接口继承的方法）。查看 $Proxy2 文件（com\sun\proxy）如下，

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//

package com.sun.proxy;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
import sora.example.instances.SystemLog;

public final class $Proxy2 extends Proxy implements SystemLog {
    private static Method m1;
    private static Method m2;
    private static Method m4;
    private static Method m3;
    private static Method m0;

    public $Proxy2(InvocationHandler var1) throws  {
        super(var1);
    }

    public final boolean equals(Object var1) throws  {
        try {
            return (Boolean)super.h.invoke(this, m1, new Object[]{var1});
        } catch (RuntimeException | Error var3) {
            throw var3;
        } catch (Throwable var4) {
            throw new UndeclaredThrowableException(var4);
        }
    }

    public final String toString() throws  {
        try {
            return (String)super.h.invoke(this, m2, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);