Java注解（Annotation）

一、注解的定义

• 核心概念
  注解是Java中一种特殊形式的“元数据”，用于为类、方法、字段、参数等代码元素附加说明信息。它不会直接影响代码逻辑，但可以通过编译器、框架或反射机制进行解析和处理。

• 与注释（Comment）的区别

  • 注释：仅供开发者阅读，编译器忽略。
  • 注解：携带可被程序读取的结构化数据（如配置、校验规则等）。

---

二、Java内置的核心注解

Java提供了一些基础注解，分为两类：

1. 元注解（Meta-Annotation）
   用于定义其他注解的行为：

   • @Retention：指定注解的保留范围（源码、Class文件、运行时）。

     @Retention(RetentionPolicy.RUNTIME) // 运行时可通过反射读取 public @interface MyAnnotation {} 

   • @Target：限制注解可应用的位置（类、方法、字段等）。

     @Target(ElementType.METHOD) // 只能标注在方法上 public @interface LogExecutionTime {} 

   • @Documented：注解是否出现在JavaDoc中。
   • @Inherited：是否允许子类继承父类的注解。
   • @Repeatable（Java 8+）：允许同一位置重复使用注解。

2. 功能型注解

   • @Override：标记方法重写父类或接口方法（编译器校验）。
   • @Deprecated：标记过时的代码元素（编译时警告）。
   • @SuppressWarnings：抑制编译器警告（如@SuppressWarnings("unchecked")）。
   • @FunctionalInterface（Java 8+）：声明接口为函数式接口。

---

三、自定义注解

通过@interface关键字定义注解：

@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface AuthRequired { String role() default "user"; // 注解属性（可设置默认值） int priority() default 1; } 

• 属性类型：仅支持基本类型、String、Class、枚举、注解及其数组。
• 默认值：通过default关键字指定。

---

四、注解的处理方式

1. 反射处理（Runtime）
   通过反射API（如getAnnotation()）在运行时解析注解：

   Method method = obj.getClass().getMethod("myMethod"); if (method.isAnnotationPresent(AuthRequired.class)) { AuthRequired auth = method.getAnnotation(AuthRequired.class); String requiredRole = auth.role(); // 权限校验逻辑... } 

2. 编译时处理
   使用注解处理器（AbstractProcessor）在编译期生成代码或校验逻辑（如Lombok）。

3. 框架集成

   • Spring：@Autowired（依赖注入）、@RequestMapping（定义HTTP端点）。
   • Hibernate：@Entity（标记JPA实体类）、@Column（映射数据库字段）。
   • JUnit：@Test（标记测试方法）。

---

五、典型应用场景

1. 配置简化
   Spring Boot的@SpringBootApplication整合多个配置注解。

2. 代码生成
   Lombok的@Data自动生成Getter/Setter和构造函数。

3. 数据校验
   JSR-303规范的@NotNull、@Size注解结合Hibernate Validator。

4. API文档生成
   Swagger的@ApiOperation生成接口文档。

---

六、最佳实践

1. 明确目标
   避免过度使用注解，优先保持代码可读性。
2. 结合工具链
   如通过注解处理器生成代码（减少模板代码）。
3. 兼容性
   注意注解的保留策略（如RUNTIME注解可能影响性能）。

---

示例代码：自定义权限校验注解

// 定义注解 @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface RequiresRole { String value() default "user"; } // 使用注解 public class UserController { @RequiresRole("admin") public void deleteUser(String userId) { // 删除用户逻辑... } } // 通过AOP或拦截器处理注解 @Aspect public class RoleCheckAspect { @Before("@annotation(RequiresRole)") public void checkRole(JoinPoint joinPoint) { Method method = ((MethodSignature) joinPoint.getSignature()).getMethod(); RequiresRole annotation = method.getAnnotation(RequiresRole.class); String requiredRole = annotation.value(); // 校验当前用户角色是否匹配... } } 

通过注解，Java实现了配置、逻辑和元数据的高度解耦，极大提升了代码的可维护性和扩展性。