掌握Java自定义注解（从零开始的Java注解开发实战教程）

第一步：了解元注解

在创建自定义注解前，你需要先了解几个Java元注解，它们是用来“注解注解”的：

• @Retention：指定注解的保留策略（SOURCE / CLASS / RUNTIME）
• @Target：指定注解可以应用的目标（如方法、类、字段等）
• @Documented：是否包含在JavaDoc中
• @Inherited：是否可被子类继承

第二步：定义一个简单的自定义注解

下面我们将创建一个名为 @Author 的注解，用于标记代码作者信息。

import java.lang.annotation.*;@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)public @interface Author {    String name();    String email() default "";    // 可以有默认值}

解释：

• @Retention(RetentionPolicy.RUNTIME) 表示该注解在运行时可通过反射获取
• @Target(ElementType.METHOD) 表示该注解只能用在方法上
• name() 是一个必填参数
• email() 是一个可选参数，默认为空字符串

第三步：使用自定义注解

现在我们可以在方法上使用这个注解了：

public class UserService {    @Author(name = "张三", email = "zhangsan@example.com")    public void saveUser() {        System.out.println("保存用户信息...");    }    @Author(name = "李四")    public void deleteUser() {        System.out.println("删除用户信息...");    }}

第四步：通过反射读取注解

要让注解真正发挥作用，我们需要在运行时通过反射读取它：

import java.lang.reflect.Method;public class AnnotationProcessor {    public static void main(String[] args) throws Exception {        Class<UserService> clazz = UserService.class;        Method[] methods = clazz.getDeclaredMethods();        for (Method method : methods) {            if (method.isAnnotationPresent(Author.class)) {                Author author = method.getAnnotation(Author.class);                System.out.println("方法: " + method.getName());                System.out.println("作者: " + author.name());                System.out.println("邮箱: " + author.email());                System.out.println("------------------------");            }        }    }}

运行结果：

方法: saveUser作者: 张三邮箱: zhangsan@example.com------------------------方法: deleteUser作者: 李四邮箱: ------------------------

常见应用场景

掌握自定义注解示例后，你可以将其应用于以下场景：

• 权限验证（如 @RequiresRole("admin")）
• 日志记录（如 @Loggable）
• 数据校验（如 @NotNull、@Range）
• 缓存控制（如 @Cacheable）

总结

通过本篇Java注解教程，你已经学会了如何定义、使用和处理Java自定义注解。注解是Java高级开发的重要工具，结合反射机制，能极大提升代码的灵活性和可维护性。建议你在实际项目中多尝试使用注解，逐步掌握这一强大特性。

记住：理解元注解、合理设计注解参数、正确使用反射，是掌握自定义注解的三大关键！