如何在Java中自定义注解？

注解的本质

注解是继承java.lang.annotation.Annotation的接口，通过@interface关键字定义：

public @interface MyAnnotation {
    // 注解元素定义在此
}

自定义注解步骤

定义注解

import java.lang.annotation.*;
// 元注解配置作用范围（类/方法）
@Target({ElementType.TYPE, ElementType.METHOD})
// 元注解配置保留策略（运行时可用）
@Retention(RetentionPolicy.RUNTIME)
public @interface DeveloperInfo {
    String name();          // 必需元素
    String department() default "Engineering"; // 默认值
    int version() default 1;
}

元注解说明

使用注解

@DeveloperInfo(name = "张三", version = 2)
public class PaymentService {
    @DeveloperInfo(name = "李四", department = "Finance")
    public void processPayment() {
        // 业务逻辑
    }
}

通过反射解析注解（关键步骤）

public class AnnotationProcessor {
    public static void main(String[] args) {
        Class<PaymentService> clazz = PaymentService.class;
        // 获取类上的注解
        if (clazz.isAnnotationPresent(DeveloperInfo.class)) {
            DeveloperInfo info = clazz.getAnnotation(DeveloperInfo.class);
            System.out.println("开发者: " + info.name() + 
                              ", 部门: " + info.department() +
                              ", 版本: " + info.version());
        }
        // 获取方法上的注解
        for (Method method : clazz.getDeclaredMethods()) {
            if (method.isAnnotationPresent(DeveloperInfo.class)) {
                DeveloperInfo methodInfo = method.getAnnotation(DeveloperInfo.class);
                System.out.println("方法 " + method.getName() + " 的负责人: " + methodInfo.name());
            }
        }
    }
}

核心规则

1. 元素类型限制：
   注解元素仅支持基本类型、String、Class、枚举、其他注解或这些类型的数组

   String[] tags();  // 合法
   List<String> list(); // 非规！不支持泛型

2. 默认值约束：
   元素不能为null，默认值需用default指定：

   

   String description() default "No description"; // 正确
   String url() default null; // 编译错误！

3. 快捷语法：
   若注解名为value且是唯一元素，可省略名称：

   public @interface Status {
       String value();
   }
   @Status("Active") // 等效于@Status(value="Active")
   class User {}

应用场景

• 框架集成：Spring的@Autowired、JUnit的@Test
• 代码生成：Lombok注解在编译时生成代码
• 配置管理：替代XML配置（如Swagger注解）
• 权限控制：自定义@RequiresPermission注解
• 日志跟踪：自动添加操作日志

常见问题

1. 注解继承无效？
   检查是否添加@Inherited元注解，且仅对类有效（方法注解不继承）

2. 反射获取不到注解？
   确认@Retention设置为RUNTIME，且使用isAnnotationPresent()正确检测

3. 默认值不生效？
   确保使用注解时不覆盖默认值元素（未显式赋值时自动应用默认值）

自定义注解需通过@interface声明，配合元注解控制行为，并依赖反射实现运行时处理，其核心价值在于：

• 解耦：分离业务逻辑与辅助功能
• 可读性：声明式配置提升代码清晰度
• 可扩展性：支持AOP、代码分析等高级应用

引用说明：本文内容基于Oracle官方Java注解规范（JLS 9.6）及反射API文档编写，遵循Java 17语法标准。