0

0

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

畫卷琴夢

畫卷琴夢

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

|

378人浏览过

|

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

Q.AI视频生成工具
Q.AI视频生成工具

支持一分钟生成专业级短视频,多种生成方式,AI视频脚本,在线云编辑,画面自由替换,热门配音媲美真人音色,更多强大功能尽在QAI

下载
  • @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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

156

2025.08.06

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

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

88

2026.01.26

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

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

158

2024.02.23

Hibernate框架介绍
Hibernate框架介绍

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

93

2025.08.06

Java Hibernate框架
Java Hibernate框架

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

39

2025.09.02

Hibernate框架搭建
Hibernate框架搭建

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

72

2025.10.14

go中interface用法
go中interface用法

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

78

2025.09.10

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

9

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

22

2026.03.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 4.3万人学习

C# 教程
C# 教程

共94课时 | 11.1万人学习

Java 教程
Java 教程

共578课时 | 80.6万人学习

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

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