JAVA自定义注解的步骤示例详解

// 元注解
元注解1
元注解2
...
public @interface 注解名 {
    // 注解属性（本质是接口的抽象方法）
    类型 属性名() default 默认值; // 可选默认值，无默认值则使用时必须指定
}

import java.lang.annotation.*;
// 生命周期：运行时（可通过反射获取）
@Retention(RetentionPolicy.RUNTIME)
// 作用范围：类、方法
@Target({ElementType.TYPE, ElementType.METHOD})
// 生成 javadoc 文档
@Documented
public @interface LogAnnotation {
    // 无属性（标记型注解）
}

// 作用于类
@LogAnnotation
public class UserService {
    // 作用于方法
    @LogAnnotation
    public void addUser(String username) {
        System.out.println("添加用户：" + username);
    }
}

import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD) // 仅作用于字段
@Documented
public @interface NotNull {
    // 注解属性：提示信息，默认值为 "字段不能为空"
    String message() default "字段不能为空";
}

public class User {
    @NotNull(message = "用户名不能为空")
    private String username;
    @NotNull(message = "年龄不能为空")
    private Integer age;
    // getter/setter/构造器省略
}

import java.lang.reflect.Field;
public class ValidationUtil {
    // 校验对象的注解字段
    public static void validate(Object obj) throws IllegalAccessException {
        // 获取对象的类
        Class<?> clazz = obj.getClass();
        // 获取所有字段（包括私有字段）
        Field[] fields = clazz.getDeclaredFields();
        for (Field field : fields) {
            // 允许访问私有字段
            field.setAccessible(true);
            // 判断字段是否有 @NotNull 注解
            if (field.isAnnotationPresent(NotNull.class)) {
                // 获取注解实例
                NotNull notNull = field.getAnnotation(NotNull.class);
                // 获取字段值
                Object value = field.get(obj);
                // 校验逻辑：值为 null 则抛出异常
                if (value == null) {
                    throw new IllegalArgumentException(notNull.message());
                }
            }
        }
    }
    // 测试
    public static void main(String[] args) throws IllegalAccessException {
        User user1 = new User(null, 20); // 用户名 null
        try {
            validate(user1);
        } catch (IllegalArgumentException e) {
            System.out.println(e.getMessage()); // 输出：用户名不能为空
        }
        User user2 = new User("张三", null); // 年龄 null
        try {
            validate(user2);
        } catch (IllegalArgumentException e) {
            System.out.println(e.getMessage()); // 输出：年龄不能为空
        }
    }
}

import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Roles {
    // 容器注解必须包含一个返回目标注解数组的属性（名称固定为 value）
    Role[] value();
}

import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Repeatable(Roles.class) // 指定容器注解
public @interface Role {
    // 注解属性：角色名称
    String value();
}

public class PermissionService {
    // 重复使用 @Role 注解（等价于 @Roles({@Role("admin"), @Role("manager")})）
    @Role("admin")
    @Role("manager")
    public void deleteData() {
        System.out.println("删除数据成功");
    }
}

import java.lang.reflect.Method;
public class PermissionUtil {
    public static void checkRole(Method method, String userRole) {
        // 判断方法是否有 @Roles 注解（重复注解会被包装为容器注解）
        if (method.isAnnotationPresent(Roles.class)) {
            Roles roles = method.getAnnotation(Roles.class);
            Role[] roleArr = roles.value();
            // 校验用户角色是否在允许范围内
            boolean hasPermission = false;
            for (Role role : roleArr) {
                if (role.value().equals(userRole)) {
                    hasPermission = true;
                    break;
                }
            }
            if (!hasPermission) {
                throw new SecurityException("无权限执行该操作");
            }
        }
    }
    // 测试
    public static void main(String[] args) throws NoSuchMethodException {
        Method method = PermissionService.class.getMethod("deleteData");
        // 测试有权限（admin）
        checkRole(method, "admin");
        System.out.println("admin 执行成功");
        // 测试无权限（user）
        try {
            checkRole(method, "user");
        } catch (SecurityException e) {
            System.out.println(e.getMessage()); // 输出：无权限执行该操作
        }
    }
}