Java中注解与原理分析详解

更新时间：2022年11月15日 11:06:45 作者：知了一笑

注解即标注与解析，在Java的代码工程中，注解的使用几乎是无处不在，甚至多到被忽视。本文就来和大家详细说说Java中注解的原理与实现，需要的可以参考一下

一、注解基础

注解即标注与解析，在Java的代码工程中，注解的使用几乎是无处不在，甚至多到被忽视；

无论是在JDK源码或者框架组件，都在使用注解能力完成各种识别和解析动作；在对系统功能封装时，也会依赖注解能力简化各种逻辑的重复实现；

基础接口

在Annotation的源码注释中有说明：所有的注解类型都需要继承该公共接口，本质上看注解是接口，但是代码并没有显式声明继承关系，可以直接查看字节码文件；

//1、声明注解
public @interface SystemLog {}

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

//3、打印结果
Compiled from "SystemLog.java"
public interface com.base.test.SystemLog extends java.lang.annotation.Annotation

元注解

声明注解时使用，用来定义注解的作用目标，保留策略等；

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

Documented：是否被javadoc或类似工具记录在文档中；
Inherited：标识注解是否可以被子类继承；
Target：作用目标，在ElementType枚举中可以看到取值包括类、方法、属性等；
Retention：保留策略，比如编译阶段是否丢弃，运行时保留；

此处声明一个SystemLog注解，作用范围是在方法上，并且在运行时保留，该注解通常用在服务运行时，结合AOP切面编程实现方法的日志采集；

二、注解原理

先来看一个简单的注解使用案例，再细致的分析其中原理，案例并不复杂，就是常见的标注与解析两个关键动作；

public class LogInfo {
    @SystemLog(model = "日志模块")
    public static void main(String[] args) {
        // 生成代理文件
        System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
        // 反射机制
        Method[] methods = LogInfo.class.getMethods();
        for (Method method:methods){
            SystemLog systemLog = method.getAnnotation(SystemLog.class) ;
            if (systemLog != null){
                // 动态代理：com.sun.proxy.$Proxy2
                System.out.println(systemLog.getClass().getName());
                System.out.println(systemLog.model());
            }
        }
    }
}

这里涉及到两个核心概念：反射机制、动态代理；反射机制可以在程序运行时获取类的完整结构信息，代理模式给目标对象提供一个代理对象，由代理对象持有目标对象的引用；

案例中通过反射机制，在程序运行时进行注解的获取和解析，值得关注的是systemLog对象的类名，输出的是代理类信息；

案例执行完毕后，会在代码工程的目录下生成代理类，可以查看$Proxy2文件；

public final class $Proxy2 extends Proxy implements SystemLog {
    public final String model() throws  {
        try {
            return (String)super.h.invoke(this, m3, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }
}

在对SystemLog解析的过程中，实际上是在使用注解的代理类，$Proxy2继承了Proxy类并实现了SystemLog接口，并且重写了相关方法；有关反射和代理的逻辑，在之前的内容中有详说，此处不赘述；

值得一看是代理类中invoke方法调用，具体的处理逻辑在AnnotationInvocationHandler类的invoke方法中，会对注解原生方法和自定义方法做判断，并对原生方法提供实现；

三、常用注解

1、JDK注解

在JDK中有多个注解是经常使用的，例如Override、Deprecated、SuppressWarnings等；

Override：判断方法是否为重写方法；
Deprecated：标记过时的API，继续使用会警告；
FunctionalInterface：检验是否为函数式接口；
SuppressWarnings：代码的警告会静默处理；

这里注意FunctionalInterface注解，从1.8开始引入，检验是否为函数式接口，即接口只能有一个抽象方法，否则编译报错；

2、Lombok注解

在具体的看Lombok组件之前，需要先了解一个概念：代码编译；在open-jdk的描述文档中大致分为三个核心阶段；

第一步：读取命令行上指定的所有源文件，解析为语法树，进行符号表填充；

第二步：调用注解处理器，如果处理器生成任何新的源文件或类文件，编译会重新启动；

第三步：分析器创建的语法树被分析并转换为类文件；

更多细节说明可以参考openjdk文档中Compiler模块的内容，下面再回到Lombok组件上；

Lombok组件在代码工程中的使用非常频繁，通过注解的方式极大的简化Java中Bean对象的编写，提高了效率并且让源码显得简洁；

这里用一段简单的代码演示其效果，在IdKey的类中通过三个常用的Lombok注解，替代了类中很多基础方法的显式生成，查看编译后的文件实际是存在相关方法的；

@Data
@AllArgsConstructor
@NoArgsConstructor
public class IdKey {
    private Integer id ;
    private String key ;

    public static void main(String[] args) {
        IdKey idKey01 = new IdKey(1,"cicada") ;
        System.out.println(idKey01);
        idKey01.setId(2);
        idKey01.setKey("smile");
        System.out.println(idKey01);
    }
}

这里需要了解JDK中注解处理器的相关源码，AbstractProcessor作为超类，编译器在编译时会去检查该类的子类，子类中最核心的是process方法；

//1、Lombok处理器
@SupportedAnnotationTypes("*")
public class LombokProcessor extends AbstractProcessor {
    private JavacTransformer transformer;
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
         transformer.transform(prio, javacProcessingEnv.getContext(), cusForThisRound, cleanup);
    }
}

//2、AST抽象树
public class JavacTransformer {
    public void transform(long priority, Context context, List<JCTree.JCCompilationUnit> compilationUnits,
                          CleanupRegistry cleanup) {
        JavacAST ast = new JavacAST(messager, context, unit, cleanup);
        ast.traverse(new AnnotationVisitor(priority));
        handlers.callASTVisitors(ast, priority);
    }
}

// 3、注解处理抽象类
public abstract class JavacAnnotationHandler<T extends Annotation> {
    public abstract void handle(AnnotationValues<T> annotation, JCAnnotation ast, JavacNode annotationNode);
}

//4、Getter注解处理
public class HandleGetter extends JavacAnnotationHandler<Getter> {
    @Override 
    public void handle(AnnotationValues<Getter> annotation, JCTree.JCAnnotation ast, JavacNode annotationNode) {
        JavacNode node = annotationNode.up();
        List<JCTree.JCAnnotation> onMethod = unboxAndRemoveAnnotationParameter(ast, "onMethod", "@Getter(onMethod", annotationNode);
        switch (node.getKind()) {
            case FIELD:
                createGetterForFields(level, fields, annotationNode, true, lazy, onMethod);
                break;
        }
    }
}

IdKey类从简洁的源码编译为复杂的字节码文件，通过注解对结构处理时关联一个核心概念，叫AST抽象树，会涉及到很多语法、词法的解析逻辑；

四、自定义注解

在系统开发中通过自定义注解可以处理各种麻烦的重复逻辑，其最明显的好处就是可以大量的消除冗余的代码块；

1、同步控制

代码中可能存在很多方法是限制重复请求的，加锁处理是很常用的手段，此时完全可以通过注解结合AOP切面编程简化代码的复杂程度；

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SyncLock {
    String lockKey();           // 锁的Key
    int time () default 3000 ;  // 有效时间
    int retryNum () default 3 ; // 重试次数
}

通过注解标记在方法上，可以极大简化同步锁的编码步骤，只是在读取KEY的时候需要设计好解析规则，结合反射原理进行获取即可；

基于相同的原理，也适应与日志采集、系统告警等功能，在之前的内容中都有详细的总结；

2、类型引擎

在数据处理的逻辑中，经常有这样一种场景，同一份数据要动态推送到多种数据源中存储，比如常见的MySQL表和ES索引双写模式，这就需要对实体对象做不同的解析逻辑；

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface BizType {
    EsIndexEnum esIndexEnum () ;        // ES索引解析适配
    MySqlTableEnum mySqlTableEnum () ;  // MySQL表解析适配
    ExcelEnum excelEnum () ;            // Excel解析适配
}

首先声明一个类型解析的注解，可以标记在实体对象的字段属性上，然后根据各种数据源的类型枚举，去适配不同解析工厂的执行逻辑，比如常用数据类型、格式、或者完全自定义。

到此这篇关于Java中注解与原理分析详解的文章就介绍到这了,更多相关Java注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java使用Scanner类进行控制台输入实现方法
这篇文章主要介绍了Java使用Scanner类进行控制台输入实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-12-12
Spring Security无法调用接口错误的问题解决
记录一下之前在写程序的时候遇到的问题,Spring Security无法调用接口错误的问题,本文就来介绍一下解决方法,感兴趣的可以了解一下
2023-08-08
Java事务管理学习之Spring和Hibernate详解
这篇文章主要给大家介绍了Java事务管理学习之Spring和Hibernate的相关资料，文中通过示例代码介绍的非常详细，需要的朋友们可以参考借鉴，下面来一起看看吧。
2017-03-03
Spring服务注解有哪些
这篇文章主要介绍了Spring服务注解，具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2016-11-11
剑指Offer之Java算法习题精讲字符串操作与数组及二叉搜索树
跟着思路走，之后从简单题入手，反复去看，做过之后可能会忘记，之后再做一次，记不住就反复做，反复寻求思路和规律，慢慢积累就会发现质的变化
2022-03-03
SpringBoot Security从入门到实战示例教程
Spring Security是一个功能强大且高度可定制的身份验证和访问控制框架，接下来通过本文给大家介绍SpringBoot Security从入门到实战示例教程，感兴趣的朋友一起看看吧
2022-05-05
Java实现File转换MultipartFile格式的例子
本文主要介绍了Java实现File转换MultipartFile格式的例子，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-07-07
spring4新特性之web开发增强
这篇文章主要介绍了spring4新特性之web开发增强的相关资料,需要的朋友可以参考下
2017-09-09
jenkins中如何集成commander应用的完整步骤
jenkins是一个用java编写的开源的持续集成工具，在与oracle发生争执后，项目从hudson项目独立出来，下面这篇文章主要给大家介绍了关于jenkins中如何集成commander应用的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考下
2018-05-05
java web项目Session获取不到问题及解决
这篇文章主要介绍了java web项目Session获取不到问题及解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-01-01