Java 注解(Annotation)详解:从基础到 APT 实战

news2026/5/7 15:37:44
前言注解是 Java 提供的一种元编程能力它像标签一样贴在代码的类、方法、字段上可以被编译器或运行时读取并处理。从 Java 5 引入至今注解已经彻底改变了 Java 生态 —— Spring、Lombok、JUnit 等框架的核心都离不开注解。但很多开发者对注解的理解停留在Override和Autowired的用法上不清楚注解的本质是什么也不知道如何编写自定义注解更不了解编译期注解处理器APT这种黑科技。本文将带你从零到一掌握注解并手写一个简单的Getter注解处理器生成 getter 方法。一、注解的本质是什么先看一个常见注解Override的源码javaTarget(ElementType.METHOD) Retention(RetentionPolicy.SOURCE) public interface Override { }使用interface关键字定义注解它本质上是一个继承自java.lang.annotation.Annotation接口的特殊接口。反编译后可以看到javapublic interface Override extends Annotation { }注解可以包含成员属性形式类似于方法javapublic interface MyAnnotation { String value() default ; int count() default 0; }使用时MyAnnotation(value hello, count 5)二、元注解 —— 注解的注解元注解作用Target限定注解可以贴在哪些位置类、方法、字段、参数等Retention注解保留到何时源码、字节码、运行时Documented是否被 Javadoc 收录Inherited子类是否可以继承父类上的该注解Repeatable(Java 8)允许在同一位置重复使用同一注解2.1 Retention 的三种策略策略生效时机典型场景SOURCE仅存在源码中编译后丢弃代码检查Override、LombokCLASS编译时保留在字节码中但运行时不可见字节码插桩工具RUNTIME运行时仍可通过反射读取Spring、JUnit运行时需要读取javaRetention(RetentionPolicy.RUNTIME) Target(ElementType.METHOD) public interface Test { }2.2 Target 常用取值javaElementType.TYPE // 类、接口、枚举 ElementType.FIELD // 字段 ElementType.METHOD // 方法 ElementType.PARAMETER // 方法参数 ElementType.CONSTRUCTOR // 构造器 ElementType.LOCAL_VARIABLE // 局部变量 ElementType.ANNOTATION_TYPE // 注解类型 ElementType.PACKAGE // 包三、自定义注解并运行时解析反射3.1 定义一个权限检查注解javaRetention(RetentionPolicy.RUNTIME) Target(ElementType.METHOD) public interface RequiresPermission { String value(); }3.2 使用注解javapublic class UserService { RequiresPermission(admin) public void deleteUser(Long userId) { System.out.println(删除用户: userId); } public void listUsers() { System.out.println(列出所有用户); } }3.3 通过反射读取注解并处理javapublic class SecurityAspect { public static void invokeWithPermissionCheck(Object obj, String methodName, Object... args) throws Exception { Method method obj.getClass().getMethod(methodName, getParameterTypes(args)); if (method.isAnnotationPresent(RequiresPermission.class)) { RequiresPermission anno method.getAnnotation(RequiresPermission.class); String required anno.value(); if (!admin.equals(getCurrentUserRole())) { throw new SecurityException(权限不足需要: required); } } method.invoke(obj, args); } private static String getCurrentUserRole() { // 模拟获取当前登录用户角色 return guest; } private static Class?[] getParameterTypes(Object[] args) { return Arrays.stream(args).map(Object::getClass).toArray(Class[]::new); } public static void main(String[] args) throws Exception { UserService service new UserService(); invokeWithPermissionCheck(service, deleteUser, 1L); // 抛出异常 } }运行时注解是 Spring AOP 的实现基石但反射有一定性能开销。四、编译期注解处理器APT—— Lombok 的秘密Lombok 的Getter、Data就是在编译期修改抽象语法树AST生成代码。我们来实现一个简化版Getter。4.1 定义注解保留到 SOURCEjavaRetention(RetentionPolicy.SOURCE) Target(ElementType.FIELD) public interface Getter { }4.2 编写注解处理器需要依赖javax.annotation.processing.*和com.sun.source.tree.*Maven 需添加 tools.jar。javaSupportedAnnotationTypes(com.example.Getter) SupportedSourceVersion(SourceVersion.RELEASE_8) public class GetterProcessor extends AbstractProcessor { Override public boolean process(Set? extends TypeElement annotations, RoundEnvironment roundEnv) { for (Element element : roundEnv.getElementsAnnotatedWith(Getter.class)) { if (element.getKind() ! ElementKind.FIELD) { processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, Getter only applies to fields, element); continue; } // 获取包含该字段的类 Element enclosingClass element.getEnclosingElement(); String fieldName element.getSimpleName().toString(); TypeMirror fieldType element.asType(); String methodName get capitalize(fieldName); // 生成 getter 方法的代码字符串 String code public fieldType methodName () { return fieldName ; }; // 通过 Filer 写入新文件过于复杂实际 Lombok 直接修改 AST // 这里简化演示输出信息 processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, Generated getter: code, element); } return true; } private String capitalize(String str) { return str.substring(0, 1).toUpperCase() str.substring(1); } }注意真正修改类字节码需要使用 Java 编译器 API 或 Lombok 的JavacAnnotationHandler机制。感兴趣的可以研究 Lombok 源码。但了解 APT 工作原理已经能帮你理解很多框架。4.3 注册注解处理器在resources/META-INF/services/javax.annotation.processing.Processor文件中写入处理器的全限定名。五、注解在主流框架中的应用框架注解示例用途SpringController,Autowired,TransactionalIoC、AOP、声明式事务JUnitTest,BeforeEach,ParameterizedTest单元测试生命周期LombokData,Slf4j编译期代码生成JacksonJsonProperty,JsonIgnore序列化/反序列化控制HibernateEntity,Column,OneToManyORM 映射FeignFeignClient,GetMapping,RequestParam声明式 HTTP 客户端SwaggerApiOperation,ApiParamAPI 文档生成六、最佳实践与常见坑6.1 ❌ 错误试图在 SOURCE 注解上使用反射javaRetention(RetentionPolicy.SOURCE) interface A {} // 运行时获取不到返回 null A a SomeClass.class.getAnnotation(A.class); // null6.2 ❌ 错误注解成员类型不受支持支持的成员类型基本类型、String、Class、枚举、注解、以及上述类型的数组。不能用普通对象或包装类。java// 编译错误 public interface Bad { Integer value(); // Integer 不允许应用 int }6.3 ✅ 使用默认值减少冗余javapublic interface Mapping { String path() default ; RequestMethod method() default RequestMethod.GET; }6.4 ✅ 注解作为元数据业务的逻辑应由代码实现注解不是魔法它是数据。真正干活的还是你的拦截器、AOP、处理器。七、面试高频题Q1: 注解可以被继承吗被Inherited标记的注解当贴在父类上时子类可以自动继承但仅限于类继承接口不行。反射获取时需要看是否有该元注解。Q2: 如何在同一属性上重复使用同一个注解Java 8 引入Repeatable定义容器注解javaRepeatable(Roles.class) interface Role { String value(); } interface Roles { Role[] value(); } // 使用 Role(admin) Role(user) public void doSomething() {}Q3: 运行时注解的性能影响每次getAnnotation都会遍历注解属性并生成动态代理对象频繁调用有明显损耗。建议在启动时缓存。总结保留策略可见性典型应用SOURCE编译后消失Lombok、代码检查CLASS字节码保留运行时不可见字节码框架ASMRUNTIME反射可见Spring、ORM、测试框架注解是 Java 元编程的入口掌握它意味着你能理解主流框架的设计思想甚至写出自己的代码生成工具。如果你对 APT 感兴趣强烈建议去读一下 Lombok 源码会让你对 Java 编译过程的理解跃升一个台阶。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2557263.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

SpringBoot-17-MyBatis动态SQL标签之常用标签

文章目录 1 代码1.1 实体User.java1.2 接口UserMapper.java1.3 映射UserMapper.xml1.3.1 标签if1.3.2 标签if和where1.3.3 标签choose和when和otherwise1.4 UserController.java2 常用动态SQL标签2.1 标签set2.1.1 UserMapper.java2.1.2 UserMapper.xml2.1.3 UserController.ja…

wordpress后台更新后 前端没变化的解决方法

使用siteground主机的wordpress网站,会出现更新了网站内容和修改了php模板文件、js文件、css文件、图片文件后,网站没有变化的情况。 不熟悉siteground主机的新手,遇到这个问题,就很抓狂,明明是哪都没操作错误&#x…

网络编程(Modbus进阶)

思维导图 Modbus RTU(先学一点理论) 概念 Modbus RTU 是工业自动化领域 最广泛应用的串行通信协议,由 Modicon 公司(现施耐德电气)于 1979 年推出。它以 高效率、强健性、易实现的特点成为工业控制系统的通信标准。 包…

UE5 学习系列(二)用户操作界面及介绍

这篇博客是 UE5 学习系列博客的第二篇,在第一篇的基础上展开这篇内容。博客参考的 B 站视频资料和第一篇的链接如下: 【Note】:如果你已经完成安装等操作,可以只执行第一篇博客中 2. 新建一个空白游戏项目 章节操作,重…

IDEA运行Tomcat出现乱码问题解决汇总

最近正值期末周,有很多同学在写期末Java web作业时,运行tomcat出现乱码问题,经过多次解决与研究,我做了如下整理: 原因: IDEA本身编码与tomcat的编码与Windows编码不同导致,Windows 系统控制台…

利用最小二乘法找圆心和半径

#include <iostream> #include <vector> #include <cmath> #include <Eigen/Dense> // 需安装Eigen库用于矩阵运算 // 定义点结构 struct Point { double x, y; Point(double x_, double y_) : x(x_), y(y_) {} }; // 最小二乘法求圆心和半径 …

使用docker在3台服务器上搭建基于redis 6.x的一主两从三台均是哨兵模式

一、环境及版本说明 如果服务器已经安装了docker,则忽略此步骤,如果没有安装,则可以按照一下方式安装: 1. 在线安装(有互联网环境): 请看我这篇文章 传送阵>> 点我查看 2. 离线安装(内网环境):请看我这篇文章 传送阵>> 点我查看 说明&#xff1a;假设每台服务器已…

XML Group端口详解

在XML数据映射过程中&#xff0c;经常需要对数据进行分组聚合操作。例如&#xff0c;当处理包含多个物料明细的XML文件时&#xff0c;可能需要将相同物料号的明细归为一组&#xff0c;或对相同物料号的数量进行求和计算。传统实现方式通常需要编写脚本代码&#xff0c;增加了开…

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器的上位机配置操作说明

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器专为工业环境精心打造&#xff0c;完美适配AGV和无人叉车。同时&#xff0c;集成以太网与语音合成技术&#xff0c;为各类高级系统&#xff08;如MES、调度系统、库位管理、立库等&#xff09;提供高效便捷的语音交互体验。 L…

(LeetCode 每日一题) 3442. 奇偶频次间的最大差值 I (哈希、字符串)

题目&#xff1a;3442. 奇偶频次间的最大差值 I 思路 &#xff1a;哈希&#xff0c;时间复杂度0(n)。 用哈希表来记录每个字符串中字符的分布情况&#xff0c;哈希表这里用数组即可实现。 C版本&#xff1a; class Solution { public:int maxDifference(string s) {int a[26]…

【大模型RAG】拍照搜题技术架构速览:三层管道、两级检索、兜底大模型

摘要 拍照搜题系统采用“三层管道&#xff08;多模态 OCR → 语义检索 → 答案渲染&#xff09;、两级检索&#xff08;倒排 BM25 向量 HNSW&#xff09;并以大语言模型兜底”的整体框架&#xff1a; 多模态 OCR 层 将题目图片经过超分、去噪、倾斜校正后&#xff0c;分别用…

【Axure高保真原型】引导弹窗

今天和大家中分享引导弹窗的原型模板&#xff0c;载入页面后&#xff0c;会显示引导弹窗&#xff0c;适用于引导用户使用页面&#xff0c;点击完成后&#xff0c;会显示下一个引导弹窗&#xff0c;直至最后一个引导弹窗完成后进入首页。具体效果可以点击下方视频观看或打开下方…

接口测试中缓存处理策略

在接口测试中&#xff0c;缓存处理策略是一个关键环节&#xff0c;直接影响测试结果的准确性和可靠性。合理的缓存处理策略能够确保测试环境的一致性&#xff0c;避免因缓存数据导致的测试偏差。以下是接口测试中常见的缓存处理策略及其详细说明&#xff1a; 一、缓存处理的核…

龙虎榜——20250610

上证指数放量收阴线&#xff0c;个股多数下跌&#xff0c;盘中受消息影响大幅波动。 深证指数放量收阴线形成顶分型&#xff0c;指数短线有调整的需求&#xff0c;大概需要一两天。 2025年6月10日龙虎榜行业方向分析 1. 金融科技 代表标的&#xff1a;御银股份、雄帝科技 驱动…

观成科技:隐蔽隧道工具Ligolo-ng加密流量分析

1.工具介绍 Ligolo-ng是一款由go编写的高效隧道工具&#xff0c;该工具基于TUN接口实现其功能&#xff0c;利用反向TCP/TLS连接建立一条隐蔽的通信信道&#xff0c;支持使用Let’s Encrypt自动生成证书。Ligolo-ng的通信隐蔽性体现在其支持多种连接方式&#xff0c;适应复杂网…

铭豹扩展坞 USB转网口 突然无法识别解决方法

当 USB 转网口扩展坞在一台笔记本上无法识别,但在其他电脑上正常工作时,问题通常出在笔记本自身或其与扩展坞的兼容性上。以下是系统化的定位思路和排查步骤,帮助你快速找到故障原因: 背景: 一个M-pard(铭豹)扩展坞的网卡突然无法识别了,扩展出来的三个USB接口正常。…

未来机器人的大脑:如何用神经网络模拟器实现更智能的决策?

编辑&#xff1a;陈萍萍的公主一点人工一点智能 未来机器人的大脑&#xff1a;如何用神经网络模拟器实现更智能的决策&#xff1f;RWM通过双自回归机制有效解决了复合误差、部分可观测性和随机动力学等关键挑战&#xff0c;在不依赖领域特定归纳偏见的条件下实现了卓越的预测准…

Linux应用开发之网络套接字编程(实例篇)

服务端与客户端单连接 服务端代码 #include <sys/socket.h> #include <sys/types.h> #include <netinet/in.h> #include <stdio.h> #include <stdlib.h> #include <string.h> #include <arpa/inet.h> #include <pthread.h> …

华为云AI开发平台ModelArts

华为云ModelArts&#xff1a;重塑AI开发流程的“智能引擎”与“创新加速器”&#xff01; 在人工智能浪潮席卷全球的2025年&#xff0c;企业拥抱AI的意愿空前高涨&#xff0c;但技术门槛高、流程复杂、资源投入巨大的现实&#xff0c;却让许多创新构想止步于实验室。数据科学家…

深度学习在微纳光子学中的应用

深度学习在微纳光子学中的主要应用方向 深度学习与微纳光子学的结合主要集中在以下几个方向&#xff1a; 逆向设计 通过神经网络快速预测微纳结构的光学响应&#xff0c;替代传统耗时的数值模拟方法。例如设计超表面、光子晶体等结构。 特征提取与优化 从复杂的光学数据中自…