Java 注解与反射实战:自定义注解从入门到精通

Java 注解与反射实战:自定义注解从入门到精通

前言:注解到底是什么?

        你是否经常在 Java 代码中看到@Override@Deprecated这样的标记?这些就是注解 —— 一种给代码 "贴标签" 的机制。注解本身不直接影响代码执行,但能通过工具(如编译器)或框架(如 Spring)赋予代码额外含义。

        自定义注解则是让我们根据业务需求创建专属 "标签",结合反射机制能实现强大的动态逻辑(比如日志记录、权限校验、ORM 映射等)。本文将从基础到实战,带你掌握自定义注解的定义、元注解的作用,以及如何通过反射让注解 "生效"。

一、自定义注解基础:@interface 关键字

        自定义注解使用 @interface 关键字定义,本质上是一种特殊的接口(编译后会生成继承 java.lang.annotation.Annotation 的接口)。

1.1 最简单的自定义注解

// 定义一个空注解 public @interface MyFirstAnnotation { } 

这个注解没有任何属性,仅作为标记使用。可以直接标注在类、方法等元素上:

@MyFirstAnnotation public class Demo { @MyFirstAnnotation public void test() {} } 

1.2 带属性的注解

注解可以包含 "属性"(类似接口的抽象方法),使用时需要为属性赋值(除非有默认值)。

public @interface UserInfo { // 字符串属性 String name(); // 整数属性,带默认值 int age() default 18; // 数组属性 String[] hobbies() default {"coding"}; } 

使用时的语法(属性名 = 值):

@UserInfo(name = "张三", age = 20, hobbies = {"篮球", "游戏"}) public class Person {} 

💡 特殊规则:

若属性名是 value,且只有这一个属性需要赋值,可省略属性名:@MyAnnotation("test")数组属性若只有一个元素,可省略大括号:hobbies = "足球"

二、元注解:注解的 "注解"

        元注解是用于修饰注解的注解,规定了自定义注解的使用范围生命周期等特性。Java 内置了 4 种元注解:@Target@Retention@Documented@Inherited

2.1 @Target:指定注解能修饰哪些元素

   @Target 限制注解可标注的目标(如类、方法、字段等),参数是 ElementType 枚举数组,常用值:

ElementType作用范围
TYPE类、接口、枚举
METHOD方法
FIELD成员变量(包括枚举常量)
PARAMETER方法参数
CONSTRUCTOR构造方法
LOCAL_VARIABLE局部变量

示例:限制注解只能用于类和方法

import java.lang.annotation.Target; import java.lang.annotation.ElementType; @Target({ElementType.TYPE, ElementType.METHOD}) // 可修饰类和方法 public @interface Log { } 

如果把 @Log 标注在字段上,编译器会直接报错:

public class Demo { @Log // 编译错误:@Log不适用于字段 private String name; } 

💡 图示:@Target 的作用范围限制

2.2 @Retention:指定注解的生命周期

@Retention 决定注解保留到哪个阶段(源码、字节码、运行时),参数是 RetentionPolicy 枚举,必须指定:

RetentionPolicy生命周期说明能否被反射获取
SOURCE仅存在于源码中,编译后丢弃(如@Override不能
CLASS保留到字节码中,但 JVM 运行时不加载(默认值)不能
RUNTIME保留到运行时,JVM 加载,可通过反射获取

示例:让注解在运行时可被反射获取

import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) // 关键:保留到运行时 public @interface Permission { String value(); } 

💡 为什么 RUNTIME 重要?反射是在程序运行时动态获取类信息的机制,只有 RUNTIME 级别的注解才能被反射读取,这是注解与反射结合的核心前提。

💡 图示:注解的生命周期流程

2.3 @Documented:让注解出现在 API 文档中

        默认情况下,javadoc 生成的文档不会包含注解信息。@Documented 修饰的注解会被包含在文档中。

示例

import java.lang.annotation.Documented; @Documented // 生成文档时包含该注解 public @interface Description { String value(); } /** * 测试类 * @Description 这是一个测试类 */ @Description("测试类") public class Test {} 

生成的 javadoc 中,Test 类的文档会显示 @Description("测试类")

2.4 @Inherited:让注解可被继承

@Inherited 表示注解具有继承性:如果父类被该注解标注,子类会自动继承该注解(仅对类注解有效,方法 / 字段注解不继承)。

示例

import java.lang.annotation.Inherited; @Inherited // 允许继承 @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface InheritedAnnotation {} // 父类标注注解 @InheritedAnnotation class Parent {} // 子类未标注,但会继承父类的@InheritedAnnotation class Child extends Parent {} 

通过反射验证:

public class Test { public static void main(String[] args) { System.out.println(Child.class.isAnnotationPresent(InheritedAnnotation.class)); // 输出:true } } 

💡 图示:@Inherited 的继承效果

三、注解 + 反射:让注解 "生效"

        注解本身只是标记,必须通过反射获取注解信息并执行逻辑,才能真正发挥作用。反射提供了以下核心方法(在 ClassMethodField 等类中):

方法作用
getAnnotation(Class)获取指定类型的注解实例
getAnnotations()获取所有注解(包括继承的)
isAnnotationPresent(Class)判断是否存在指定注解

实战案例:用注解实现方法权限校验

需求:定义 @RequiresPermission 注解,标记方法需要的权限;通过反射调用方法前检查当前用户是否有权限,无权限则抛出异常。

步骤 1:定义注解
import java.lang.annotation.*; @Target(ElementType.METHOD) // 仅用于方法 @Retention(RetentionPolicy.RUNTIME) // 运行时可反射获取 public @interface RequiresPermission { String[] value(); // 所需权限列表 } 
步骤 2:使用注解标注方法
public class UserService { // 需要"user:query"权限 @RequiresPermission("user:query") public void queryUser() { System.out.println("查询用户成功"); } // 需要"user:add"或"admin"权限 @RequiresPermission({"user:add", "admin"}) public void addUser() { System.out.println("新增用户成功"); } } 
步骤 3:反射 + 注解实现权限校验
import java.lang.reflect.Method; import java.util.Arrays; import java.util.HashSet; import java.util.Set; public class PermissionChecker { // 模拟当前用户拥有的权限 private static final Set<String> CURRENT_USER_PERMISSIONS = new HashSet<>(Arrays.asList("user:query")); // 反射调用方法并校验权限 public static void invokeWithCheck(Object obj, String methodName) throws Exception { // 1. 获取方法对象 Method method = obj.getClass().getMethod(methodName); // 2. 检查方法是否有@RequiresPermission注解 if (method.isAnnotationPresent(RequiresPermission.class)) { // 3. 获取注解实例 RequiresPermission annotation = method.getAnnotation(RequiresPermission.class); // 4. 获取注解的权限列表 String[] requiredPermissions = annotation.value(); // 5. 校验权限 boolean hasPermission = false; for (String permission : requiredPermissions) { if (CURRENT_USER_PERMISSIONS.contains(permission)) { hasPermission = true; break; } } if (!hasPermission) { throw new SecurityException("权限不足,需要:" + Arrays.toString(requiredPermissions)); } } // 6. 权限通过,调用方法 method.invoke(obj); } public static void main(String[] args) throws Exception { UserService service = new UserService(); invokeWithCheck(service, "queryUser"); // 成功:查询用户成功 invokeWithCheck(service, "addUser"); // 失败:抛出SecurityException } } 

执行结果:

查询用户成功 Exception in thread "main" java.lang.SecurityException: 权限不足,需要:[user:add, admin] 

四、底层原理:注解本质与反射获取机制

  1. 注解实例的生成:当 JVM 加载被注解的类时,会通过动态代理生成注解接口的实现类实例(保存注解属性值)。
  2. 反射获取注解的过程:反射通过 getAnnotation() 方法从类 / 方法的元数据中获取代理实例,从而读取属性值。

注解的本质@interface 编译后会生成一个继承 java.lang.annotation.Annotation 的接口,例如:

// 编译后自动生成的代码(简化) public interface MyAnnotation extends Annotation { String value(); int age() default 18; } 

五、应用场景总结

注解 + 反射的组合在框架中被广泛使用:

日志记录:通过注解标记需要记录日志的方法,反射拦截并打印日志(如 Spring 的@Log)。ORM 映射:用注解关联 Java 类与数据库表(如 JPA 的@Entity@Column)。依赖注入:标记需要注入的对象(如 Spring 的@Autowired)。AOP 切面:通过注解定义切入点(如 Spring 的@Before@After)。参数校验:验证方法参数合法性(如 Jakarta 的@NotNull@Size)。

结语

        自定义注解是 Java 中 "声明式编程" 的核心体现,结合反射能极大简化代码逻辑、提高灵活性。掌握元注解的作用(尤其是@Target@Retention)是定义有效注解的前提,而反射则是让注解从 "标记" 变为 "可执行逻辑" 的桥梁。

尝试在项目中用注解解决重复逻辑(如日志、权限),你会感受到它的强大!

互动问题:你在项目中用过哪些自定义注解场景?欢迎在评论区分享~

Read more

【OpenClaw从入门到精通】第10篇:OpenClaw生产环境部署全攻略:性能优化+安全加固+监控运维(2026实测版)

【OpenClaw从入门到精通】第10篇:OpenClaw生产环境部署全攻略:性能优化+安全加固+监控运维(2026实测版)

摘要:本文聚焦OpenClaw从测试环境走向生产环境的核心痛点,围绕“性能优化、安全加固、监控运维”三大维度展开实操讲解。先明确生产环境硬件/系统选型标准,再通过硬件层资源管控、模型调度策略、缓存优化等手段提升响应速度(实测响应效率提升50%+);接着从网络、权限、数据三层构建安全防护体系,集成火山引擎安全方案拦截高危操作;最后落地TenacitOS可视化监控与Prometheus告警体系,配套完整故障排查清单和虚拟实战案例。全文所有配置、代码均经实测验证,兼顾新手入门实操性和进阶读者的生产级部署需求,帮助开发者真正实现OpenClaw从“能用”到“放心用”的跨越。 优质专栏欢迎订阅! 【DeepSeek深度应用】【Python高阶开发:AI自动化与数据工程实战】【YOLOv11工业级实战】 【机器视觉:C# + HALCON】【大模型微调实战:平民级微调技术全解】 【人工智能之深度学习】【AI 赋能:Python 人工智能应用实战】【数字孪生与仿真技术实战指南】 【AI工程化落地与YOLOv8/v9实战】【C#工业上位机高级应用:高并发通信+性能优化】 【Java生产级避坑指南:

By Ne0inhk
ARM Linux 驱动开发篇--- Linux 并发与竞争实验(互斥体实现 LED 设备互斥访问)--- Ubuntu20.04互斥体实验

ARM Linux 驱动开发篇--- Linux 并发与竞争实验(互斥体实现 LED 设备互斥访问)--- Ubuntu20.04互斥体实验

🎬 渡水无言:个人主页渡水无言 ❄专栏传送门: 《linux专栏》《嵌入式linux驱动开发》《linux系统移植专栏》 ❄专栏传送门: 《freertos专栏》《STM32 HAL库专栏》 ⭐️流水不争先,争的是滔滔不绝  📚博主简介:第二十届中国研究生电子设计竞赛全国二等奖 |国家奖学金 | 省级三好学生 | 省级优秀毕业生获得者 | ZEEKLOG新星杯TOP18 | 半导纵横专栏博主 | 211在读研究生 在这里主要分享自己学习的linux嵌入式领域知识;有分享错误或者不足的地方欢迎大佬指导,也欢迎各位大佬互相三连 目录 前言  一、实验基础说明 1.1、互斥体简介 1.2 本次实验设计思路 二、硬件原理分析(看过之前博客的可以忽略) 三、实验程序编写 3.1 互斥体 LED 驱动代码(mutex.c) 3.2.1、设备结构体定义(28-39

By Ne0inhk
Flutter for OpenHarmony:swagger_dart_code_generator 接口代码自动化生成的救星(OpenAPI/Swagger) 深度解析与鸿蒙适配指南

Flutter for OpenHarmony:swagger_dart_code_generator 接口代码自动化生成的救星(OpenAPI/Swagger) 深度解析与鸿蒙适配指南

欢迎加入开源鸿蒙跨平台社区:https://openharmonycrossplatform.ZEEKLOG.net 前言 后端工程师扔给你一个 Swagger (OpenAPI) 文档地址,你会怎么做? 1. 对着文档,手写 Dart Model 类(容易写错字段类型)。 2. 手写 Retrofit/Dio 的 API 接口定义(容易拼错 URL)。 3. 当后端修改了字段名,你对着报错修半天。 这是重复劳动的地狱。 swagger_dart_code_generator 可以将 Swagger (JSON/YAML) 文件直接转换为高质量的 Dart 代码,包括: * Model 类:支持 json_serializable,带 fromJson/

By Ne0inhk
Linux 开发别再卡壳!makefile/git/gdb 全流程实操 + 作业解析,新手看完直接用----《Hello Linux!》(5)

Linux 开发别再卡壳!makefile/git/gdb 全流程实操 + 作业解析,新手看完直接用----《Hello Linux!》(5)

文章目录 * 前言 * make/makefile * 文件的三个时间 * Linux第一个小程序-进度条 * 回车和换行 * 缓冲区 * 程序的代码展示 * git指令 * 关于gitee * Linux调试器-gdb使用 * 作业部分 前言 做 Linux 开发时,你是不是也遇到过这些 “卡脖子” 时刻?写 makefile 时,明明语法没错却报错,最后发现是依赖方法行没加 Tab;想提交代码到 gitee,记不清 git add/commit/push 的 “三板斧”,还得反复搜教程;用 gdb 调试程序,输了命令没反应,才想起编译时没加-g生成 debug 版本;甚至连写个进度条,都搞不懂\r和\n的区别,导致进度条乱跳…… 其实这些问题,

By Ne0inhk