首页 > Java > java教程 > 正文

java怎么自定义注解 创建与使用自定义注解的完整示例

php中文网
发布: 2025-12-06 19:34:52
原创
359人浏览过
Java自定义注解通过@interface定义,结合@Retention和@Target等元注解设置作用范围与生命周期,可在运行时通过反射读取方法上的注解信息并执行相应逻辑,如权限校验。示例中RequireAuth注解用于标记需权限验证的方法,配合反射机制实现运行时检查,广泛应用于框架中的AOP、依赖注入、序列化等场景。

java怎么自定义注解 创建与使用自定义注解的完整示例

Java 中的自定义注解是一种强大的元数据工具,可以用于在代码中添加额外信息,供编译器、框架或运行时使用。下面通过一个完整的示例来演示如何创建和使用自定义注解。

1. 创建自定义注解

使用 @interface 关键字来定义注解。你可以为注解添加属性(方法),并设置默认值和元注解(meta-annotations)。

示例:定义一个用于标记需要权限验证的方法的注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)  // 注解在运行时保留,可通过反射读取
@Target(ElementType.METHOD)          // 注解只能用于方法上
public @interface RequireAuth {
    String value() default "USER";   // 权限等级,默认为 USER
    boolean logAccess() default true; // 是否记录访问日志
}
登录后复制

说明:

立即学习Java免费学习笔记(深入)”;

  • @Retention(RetentionPolicy.RUNTIME):表示该注解在运行时可通过反射获取。
  • @Target(ElementType.METHOD):限制此注解只能用在方法上。
  • 注解中的方法相当于配置项,可带默认值。

2. 使用自定义注解

在实际类的方法上使用刚刚定义的注解。

灵思AI
灵思AI

专业的智能写作辅助平台

灵思AI 163
查看详情 灵思AI
public class UserService {

    @RequireAuth("ADMIN")
    public void deleteUser(String userId) {
        System.out.println("删除用户: " + userId);
    }

    @RequireAuth(value = "USER", logAccess = false)
    public void viewProfile(String userId) {
        System.out.println("查看用户资料: " + userId);
    }

    public void login(String username, String password) {
        System.out.println("用户登录: " + username);
    }
}
登录后复制

3. 在运行时通过反射读取注解信息

利用反射机制,可以在程序运行时检查某个方法是否被特定注解标记,并获取其属性值。

import java.lang.reflect.Method;

public class AuthChecker {

    public static void checkPermissions(Object obj) throws Exception {
        Class<?> clazz = obj.getClass();
        Method[] methods = clazz.getDeclaredMethods();

        for (Method method : methods) {
            if (method.isAnnotationPresent(RequireAuth.class)) {
                RequireAuth auth = method.getAnnotation(RequireAuth.class);
                System.out.println("方法: " + method.getName());
                System.out.println("  所需权限: " + auth.value());
                System.out.println("  是否记录日志: " + auth.logAccess());

                // 可在此处模拟权限校验逻辑
                simulateAuthCheck(auth.value(), method.getName());
            }
        }
    }

    private static void simulateAuthCheck(String role, String methodName) {
        String currentUserRole = "ADMIN"; // 模拟当前用户角色
        if (!currentUserRole.equals(role)) {
            System.out.println("  ⚠ 警告: 当前用户无权执行方法 '" + methodName + "'");
        } else {
            System.out.println("  ✅ 权限通过");
        }
    }

    public static void main(String[] args) throws Exception {
        UserService service = new UserService();
        checkPermissions(service);
    }
}
登录后复制

输出结果:

方法: deleteUser
  所需权限: ADMIN
  是否记录日志: true
  ✅ 权限通过
方法: viewProfile
  所需权限: USER
  是否记录日志: false
  ✅ 权限通过
登录后复制

4. 注解的其他常见用途

自定义注解广泛应用于:

  • Spring 框架:如 @Controller、@Service 等都是自定义注解,配合扫描机制实现依赖注入。
  • AOP 切面编程:通过注解标记切点,实现日志、事务、安全等功能。
  • 序列化/反序列化:如 Jackson 的 @JsonProperty。
  • 参数校验:如 Hibernate Validator 提供的 @NotNull、@Size 等。

基本上就这些。通过定义注解、使用注解、再通过反射处理注解,你可以构建出灵活的框架级功能。不复杂但容易忽略的是元注解的选择和保留策略。

以上就是java怎么自定义注解 创建与使用自定义注解的完整示例的详细内容,更多请关注php中文网其它相关文章!

java速学教程(入门到精通)
java速学教程(入门到精通)

java怎么学习?java怎么入门?java在哪学?java怎么学才快?不用担心,这里为大家提供了java速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号