Java反射与自定义注解实战指南

Java反射与自定义注解实战指南

第一部分：Java反射核心机制

一、反射的本质与价值

反射是Java在运行时动态获取类信息并操作类的能力，它是框架设计的基石。通过反射，我们可以在运行时：

• 获取类的完整结构（类名、方法、属性等）
  
• 动态创建对象
  
• 调用方法和访问字段（包括私有成员）
  
• 实现动态代理
  

二、反射核心类

类名用途Class类的元数据入口Field类的成员变量Method类的方法Constructor类的构造方法三、获取Class对象的三种方式

1. // 1. 类名.class（最安全高效）
2. Class<String> clazz1 = String.class;
4. // 2. 对象.getClass()
5. String s = "";
6. Class<?> clazz2 = s.getClass();
8. // 3. Class.forName()（最灵活）
9. Class<?> clazz3 = Class.forName("java.lang.String");

复制代码

四、反射基础操作

1. 创建对象

1. // 无参构造
2. Class<?> clazz = User.class;
3. User user = clazz.getDeclaredConstructor().newInstance();
5. // 有参构造
6. Constructor<?> cons = clazz.getConstructor(String.class, int.class);
7. User user = (User) cons.newInstance("Alice", 25);

复制代码

2. 操作字段

1. Field field = clazz.getDeclaredField("name");
2. field.setAccessible(true); // 突破私有限制
4. // 设置值
5. field.set(user, "Bob");
7. // 获取值
8. String name = (String) field.get(user);

复制代码

3. 调用方法

1. Method method = clazz.getMethod("setName", String.class);
2. method.invoke(user, "Charlie"); // 调用方法

复制代码

五、反射应用场景

• 框架设计（如Spring IOC容器）
  
• 动态代理
  
• 注解处理器
  
• JSON序列化/反序列化
  

性能提示：反射操作比直接调用慢10-100倍，高频场景建议缓存Method/Field对象。

第二部分：自定义注解与Spring Boot实战

一、自定义注解基础

1. 元注解（定义注解的注解）

元注解作用@Target指定注解作用目标（类/方法/字段）@Retention指定注解保留策略（SOURCE/CLASS/RUNTIME）@Documented是否包含在Javadoc中@Inherited是否允许子类继承2. 定义注解

1. // 示例：方法耗时监控注解
2. @Target(ElementType.METHOD)
3. @Retention(RetentionPolicy.RUNTIME)
4. public @interface TimeMonitor {
5.     String taskName() default ""; // 属性带默认值
6.     int threshold() default 1000; // 超时阈值(毫秒)
7. }

复制代码

二、Spring Boot中自定义注解实战

1. 使用注解

1. @Service
2. public class OrderService {
3.    
4.     @TimeMonitor(taskName = "订单处理", threshold = 500)
5.     public void processOrder() {
6.         // 业务代码...
7.     }
8. }

复制代码

2. 处理注解（AOP方式）

1. @Aspect // 声明为切面
2. @Component // 纳入Spring容器
3. public class TimeMonitorAspect {
4.    
5.     /**
6.      * 环绕通知：拦截带@TimeMonitor注解的方法
7.      */
8.     @Around("@annotation(monitor)")
9.     public Object monitorTime(ProceedingJoinPoint pjp, TimeMonitor monitor) throws Throwable {
10.         long start = System.currentTimeMillis();
11.         Object result = pjp.proceed(); // 执行目标方法
12.         long cost = System.currentTimeMillis() - start;
13.         
14.         // 超过阈值打印警告
15.         if (cost > monitor.threshold()) {
16.             System.err.printf("[%s] 执行耗时 %dms (超过阈值 %dms)%n",
17.                 monitor.taskName(), cost, monitor.threshold());
18.         }
19.         return result;
20.     }
21. }

复制代码

三、实际应用场景

场景1：权限控制注解

1. // 定义注解
2. @Target(ElementType.METHOD)
3. @Retention(RetentionPolicy.RUNTIME)
4. public @interface Auth {
5.     String[] roles() default {"USER"}; // 允许的角色
6. }
8. // 使用
9. @RestController
10. public class AdminController {
11.     @Auth(roles = {"ADMIN"})
12.     @DeleteMapping("/users/{id}")
13.     public void deleteUser(@PathVariable Long id) { ... }
14. }
16. // AOP权限校验
17. @Around("@annotation(auth)")
18. public Object checkAuth(ProceedingJoinPoint pjp, Auth auth) {
19.     // 获取当前用户角色
20.     Set<String> userRoles = getCurrentUserRoles();
21.    
22.     // 检查权限
23.     if (!hasRequiredRole(userRoles, auth.roles())) {
24.         throw new AccessDeniedException("权限不足");
25.     }
26.     return pjp.proceed();
27. }

复制代码

场景2：自动日志注解

1. // 定义
2. @Target(ElementType.METHOD)
3. @Retention(RetentionPolicy.RUNTIME)
4. public @interface AutoLog {
5.     String value() default "";
6. }
8. // AOP处理
9. @Around("@annotation(log)")
10. public Object logMethod(ProceedingJoinPoint pjp, AutoLog log) throws Throwable {
11.     String methodName = pjp.getSignature().getName();
12.     System.out.println("【" + log.value() + "】开始执行: " + methodName);
13.     Object result = pjp.proceed();
14.     System.out.println("【" + log.value() + "】执行完成");
15.     return result;
16. }

复制代码

四、Spring Boot集成关键点

• 组件扫描：
  
  
  
  • 确保注解定义类在@SpringBootApplication扫描路径下
    
  • AOP处理类需添加@Component注解
    
  
  
• AOP代理配置：
  1. # application.properties
  2. spring.aop.auto=true # 启用AOP自动代理
  3. spring.aop.proxy-target-class=true # 使用CGLIB代理

  复制代码
• 注解属性设计原则：
  
  
  
  • 优先使用value作为主属性名
    
  • 为所有属性提供默认值
    
  • 复杂配置使用嵌套注解
    
  
  

五、反射与注解的协同工作

1. // 反射方式读取注解信息
2. public void scanAnnotations() {
3.     Class<?> clazz = OrderService.class;
4.    
5.     for (Method method : clazz.getDeclaredMethods()) {
6.         if (method.isAnnotationPresent(TimeMonitor.class)) {
7.             TimeMonitor monitor = method.getAnnotation(TimeMonitor.class);
8.             System.out.println("监控方法: " + monitor.taskName());
9.         }
10.     }
11. }

复制代码

总结对比

特性反射自定义注解主要目的运行时操作类为代码添加元数据核心类Class, Method, Field@interface使用场景框架开发、动态代理AOP增强、配置声明Spring Boot集成直接可用需配合AOP或反射处理性能影响较大（需缓存优化）较小（AOP有代理开销）典型应用Spring IOC容器Spring声明式事务(@Transactional)最佳实践建议：

• 优先使用注解+AOP实现通用功能
  
• 反射用于无法通过注解实现的动态场景
  
• 高频操作务必进行性能优化
  
• 合理设计注解属性，保持简洁性
  

掌握反射和自定义注解，将使你能够深入理解Java生态框架的工作原理，并能够设计和实现更加灵活、可扩展的系统架构。

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！