讲师中心 微信公众号
AI工具推荐 视频效率加速

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

浅明姑娘_1236

浅明姑娘_1236

发布时间:2025-12-06 19:34:52

|

418人浏览过

|

来源于php中文网

原创

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免费学习笔记(深入)”;

Douyin Keyword Collector
Douyin Keyword Collector

通过浏览器自动化访问抖音首页,在搜索栏输入关键词并在自动化流程中收集相关关键词建议

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

2. 使用自定义注解

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

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速学教程(入门到精通)
java速学教程(入门到精通)

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

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2591

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

477

2026.01.26

hibernate和mybatis有哪些区别
hibernate和mybatis有哪些区别

hibernate和mybatis的区别:1、实现方式;2、性能;3、对象管理的对比;4、缓存机制。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

302

2024.02.23

Hibernate框架介绍
Hibernate框架介绍

本专题整合了hibernate框架相关内容,阅读专题下面的文章了解更多详细内容。

2653

2025.08.06

Java Hibernate框架
Java Hibernate框架

本专题聚焦 Java 主流 ORM 框架 Hibernate 的学习与应用,系统讲解对象关系映射、实体类与表映射、HQL 查询、事务管理、缓存机制与性能优化。通过电商平台、企业管理系统和博客项目等实战案例,帮助学员掌握 Hibernate 在持久层开发中的核心技能。

7460

2025.09.02

Hibernate框架搭建
Hibernate框架搭建

本专题整合了Hibernate框架用法,阅读专题下面的文章了解更多详细内容。

778

2025.10.14

go中interface用法
go中interface用法

本专题整合了go语言中int相关内容,阅读专题下面的文章了解更多详细内容。

3890

2025.09.10

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

Playwright 页面操作指南
Playwright 页面操作指南

Playwright页面操作专题汇集元素定位、点击与输入、等待响应、多页面切换、Iframe、事件监听及文件处理的已审核文章,便于按操作场景查阅示例与常见问题。

0

2026.10.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn