《对线面试官》Java 注解

作者：Java3y

2022 年 5 月 06 日
本文字数：2280 字
阅读完需：约 7 分钟

面试官：来讲讲什么是注解吧

候选者：注解在我的理解下，就是代码中的特殊标记，这些标记可以在编译、类加载、运行时被读取，并执行相对应的处理。

面试官：你这讲得有点抽象，你先说说你在开发中有没有用到注解吧。

候选者：注解其实在开发中是非常常见的，比如我们在使用各种框架时（像我们 Java 程序员接触最多的还是 Spring 框架一套），就会用到非常多的注解，@Controller / @Param / @Select 等等。一些项目也用到 lombok 的注解，@Slf4j / @Data 等等

候选者：除了框架实现的注解，Java 原生也有 @Overried、@Deprecated、@FunctionalInterface 等基本注解。Java 原生的基本注解大多数用于「标记」和「检查」

候选者：原生 Java 除了这些提供基本注解之外，还有一种叫做元 Annotation（元注解），所谓的元 Annotation 就是用来修饰注解的。常用的元 Annotation 有 @Retention 和 @Target。@Retention 注解可以简单理解为设置注解的生命周期，而 @Target 表示这个注解可以修饰哪些地方（比如方法、还是成员变量、还是包等等）

面试官：嗯，听得出来你在工作中是真的用到注解的，这些可能是 Spring、Mybatis 等框架原生提供的，可能是 Java 原生的。那你自己写过注解吗？

候选者：嗯，写过的。背景是这样的：我司有个监控告警系统，对外提供了客户端供我们自己使用。监控一般的指标就是 QPS、RT 和错误嘛。

候选者：原生的客户端需要在代码里指定上报，这会导致这种监控的代码会跟业务代码混合，比较恶心。

public void send(String userName) {  try {    // qps 上报    qps(params);    long startTime = System.currentTimeMillis();
    // 构建上下文(模拟业务代码）    ProcessContext processContext = new ProcessContext();    UserModel userModel = new UserModel();    userModel.setAge("22");    userModel.setName(userName);    //...
    // rt 上报    long endTime = System.currentTimeMillis();    rt(endTime - startTime);  } catch (Exception e) {        // 出错上报    error(params);  }}

复制代码

候选者：其实这种基础的监控信息，显然都可以通过 AOP 切面的方式去处理掉（可以看到都是方法级的）。而再用注解这个载体配置相关的信息，配合 AOP 解析就会比较优雅

候选者：接下来讲讲我是怎么做的吧。

候选者：要写自定义的注解，首先考虑我们是在什么时候解析这个注解。这就需要用到前面所说的 @Retention 注解，这个注解会修饰我们自定义注解生命周期。

候选者：@Retention 注解传入的是 RetentionPolicy 枚举，该枚举有三个常量，分别是 SOURCE、CLASS 和 RUNTIME

候选者：SOURCE 代表着注解仅保留在源级别中，并由编译器忽略。CLASS 代表着注解在编译时由编译器保留，但 Java 虚拟机（JVM）会忽略。RUNTIME 代表着标记的注解会由 JVM 保留，因此运行时环境可以使用它。

候选者：理解这块就得了解从 .java 文件到 class 文件再到 class 被 jvm 加载的过程了。下面的图描述着从.java 文件到编译为 class 文件的过程

候选者：从上面的图可以发现有个「注解抽象语法树」，这里其实就会去解析注解，然后做处理的逻辑。

候选者：所以重点来了，如果你想要在编译期间处理注解相关的逻辑，你需要继承 AbstractProcessor 并实现 process 方法。比如可以看到 lombok 就用 AnnotationProcessor 继承了 AbstractProcessor。

候选者：一般来说，只要自定义的注解中 @Retention 注解设置为 SOURCE 和 CLASS 这俩个级别，那么就需要继承并实现（因为 SOURCE 和 CLASS 这俩个级别等加载到 jvm 的时候，注解就被抹除了）

候选者：从这里又引申出：lombok 的实现原理就是在这（为什么使用了个 @Data 这样的注解就能有 set/get 等方法了，就是在这里加上去的）

面试官：嗯，你是还有点东西哦

候选者：一般来说，我们自己定义的注解都是 RUNTIME 级别的，因为大多数情况我们是根据运行时环境去做一些处理。

候选者：我们现实在开发的过程中写自定义注解需要配合反射来使用（因为反射是 Java 获取运行时的信息的重要手段）。

候选者：所以，我当时就用了自定义注解，在 Spring AOP 的逻辑处理中，判断是否带有自定义注解，如果有则将监控的逻辑写在方法的前后。这样，只要在方法上加上我的注解，那就可以有对方法监控的效果（RT、QPS、ERROR）

@Around("@annotation(com.sanwai.service.openapi.monitor.Monitor)")    public Object antispan(ProceedingJoinPoint pjp) throws Throwable {
        String functionName = pjp.getSignature().getName();        Map<String, String> tags = new HashMap<>();
        logger.info(functionName);
        tags.put("functionName", functionName);        tags.put("flag", "done");
        monitor.sum(functionName, "start", 1);
        //方法执行开始时间        long startTime = System.currentTimeMillis();
        Object o = null;        try {            o = pjp.proceed();        } catch (Exception e) {            //方法执行结束时间            long endTime = System.currentTimeMillis();
            tags.put("flag", "fail");            monitor.avg("rt", tags, endTime - startTime);
            monitor.sum(functionName, "fail", 1);            throw e;        }
        //方法执行结束时间        long endTime = System.currentTimeMillis();
        monitor.avg("rt", tags, endTime - startTime);
        if (null != o) {            monitor.sum(functionName, "done", 1);        }        return o;    }