什么是注解?其原理是什么?如何自定义一个注解?

答案:注解是Java中一种声明式元数据机制,通过@Retention等元注解控制生命周期,利用反射在运行时获取信息,实现如日志、权限等横切关注点的自动化处理,提升代码可读性与可维护性。

什么是注解?其原理是什么?如何自定义一个注解?

在我看来,注解(Annotation)是一种非常优雅且强大的元数据机制,它允许我们以声明式的方式向代码中添加信息,而这些信息并不会直接影响代码的执行逻辑本身。简单来说,它就像是给你的代码贴上了一个标签,这个标签里包含了额外的数据或指令,供编译器、IDE或者运行时环境来读取和处理。它的核心原理在于利用Java的反射机制,在程序运行期间动态地获取这些标签信息,并据此执行相应的操作。至于如何自定义,那无非是定义一个特殊的接口,并赋予它特定的元注解来控制其生命周期和作用范围。

解决方案

注解的出现,极大地提升了代码的可读性、可维护性和扩展性。它将那些原本散落在XML配置、硬编码逻辑甚至冗余的接口实现中的元数据,集中且直观地表达出来。想象一下,你不再需要为每个需要日志记录的方法手动添加try-catch块,也不必为每个需要权限检查的控制器方法编写重复的判断逻辑。取而代之的是,一个简单的

@Loggable

@RequiresPermission

标签就能搞定一切。这不仅仅是代码量的减少,更是一种设计思想的转变:从命令式(告诉程序怎么做)到声明式(告诉程序是什么)。它让框架和工具能够更好地理解你的意图,并代劳那些繁琐的横切关注点。

注解的底层原理到底是什么?它又是如何工作的?

当我们谈论注解的底层原理时,其实我们是在探讨Java虚拟机(JVM)和Java编译器是如何处理这些“标签”的。从本质上讲,注解在编译后会被转换成特殊的接口,这些接口的实现类由JVM在运行时动态生成。而真正决定注解生命周期和可见性的,是

java.lang.annotation

包中的几个元注解,尤其是

@Retention

@Retention

有三个值:

RetentionPolicy.SOURCE

: 这种注解只在源代码中存在,在编译成

.class

文件时会被编译器丢弃。它通常用于编译前的代码检查、警告抑制(如

@SuppressWarnings

)或代码生成工具。我们IDE里那些代码检查,很多就是基于这种注解。

RetentionPolicy.CLASS

: 这种注解会被编译器记录在

.class

文件中,但在JVM加载类时,它不会被保留到运行时。它主要用于编译时或类加载时的处理,例如某些字节码增强工具可能会用到。

RetentionPolicy.RUNTIME

: 这是最常用,也是最强大的一个。它不仅会被记录在

.class

文件中,而且在JVM加载类后,这些注解信息仍然可以通过反射机制被程序访问到。Spring、JUnit等绝大多数依赖注解的框架,都是通过这种方式在运行时动态地读取和处理注解的。

因此,注解工作的核心就在于反射。当一个类或方法被

@Retention(RUNTIME)

的注解标记时,我们可以在程序运行时通过

java.lang.reflect

包提供的API(如

Class.getAnnotation()

Method.isAnnotationPresent()

等)来检查这些注解是否存在,并获取其属性值。框架就是利用这些信息,在不改变业务代码逻辑的前提下,实现各种功能增强,比如AOP切面、依赖注入、数据校验等等。可以说,没有反射,注解的运行时威力将大打折扣。

为什么我们需要自定义注解?以及它能解决哪些实际痛点?

虽然Java提供了许多内置注解,但很多时候,它们并不能完全满足我们特定业务场景的需求。自定义注解的必要性,往往源于我们希望将一些业务相关的元数据横切关注点以声明式的方式融入代码中。

我个人觉得,自定义注解主要解决了以下几个痛点:

降低耦合,提升可维护性:设想一下,你有一个复杂的权限系统,需要根据用户角色和资源类型来判断访问权限。如果每次都写

if (user.hasRole("ADMIN") && resource.getType().equals("CONFIDENTIAL"))

,那代码会变得非常冗余且难以维护。通过自定义

@RequiresPermission(role = "ADMIN", resource = "CONFIDENTIAL")

,你可以将权限逻辑从业务代码中抽离,交给一个统一的权限处理器去执行。业务代码只关注业务本身,而权限控制则通过注解声明,职责分离得非常清晰。减少样板代码,提高开发效率:在很多场景下,我们会有重复性的操作,比如日志记录、缓存管理、事务控制、数据校验等。如果每次都手动编写这些逻辑,不仅效率低下,还容易出错。自定义注解可以将这些重复性逻辑封装起来,通过AOP或代理模式,在运行时自动“织入”到被注解的方法上。开发者只需要简单地添加一个注解,就能获得相应的功能。构建领域特定语言(DSL):在某些复杂的业务领域,自定义注解可以作为一种轻量级的DSL元素,让业务规则在代码中以更贴近自然语言的方式表达。例如,在数据校验框架中,你可以定义

@Min(10)

@Max(100)

@Email

等注解,让校验规则一目了然。提供配置替代方案:传统上,很多配置信息会放在XML文件或属性文件中。虽然这些方式很灵活,但有时会造成配置与代码分离,难以追踪。自定义注解可以将部分配置直接绑定到代码元素上,使得配置更加内聚,更易于理解和管理。

总的来说,自定义注解提供了一种强大的机制,让我们能够以更优雅、更高效的方式来处理代码中的元数据和横切关注点,让代码更“聪明”,也更易于管理。

手把手教你如何设计并实现一个实用的自定义注解

自定义注解其实并不复杂,它本质上就是定义一个特殊的接口。我们来设计一个简单的日志注解

@Loggable

,用于标记需要自动记录方法执行耗时和参数的方法。

第一步:定义注解接口

首先,我们需要创建一个注解接口。这里有一些关键的元注解需要用到:

@Target(ElementType.METHOD)

:指定这个注解可以应用于方法上。你也可以选择

TYPE

(类、接口)、

FIELD

(字段)、

PARAMETER

(参数)等。

@Retention(RetentionPolicy.RUNTIME)

:这是最重要的,确保注解在运行时可以通过反射访问。

@Documented

:可选,表示这个注解会被包含在Javadoc中。

@Inherited

:可选,表示子类会继承父类上的注解。

import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;import java.lang.annotation.Documented;/** * 标记一个方法,表示需要记录其执行耗时和参数。 */@Target(ElementType.METHOD) // 只能用在方法上@Retention(RetentionPolicy.RUNTIME) // 运行时可见@Documented // 会被包含在 Javadoc 中public @interface Loggable {    // 注解的属性,类似于方法,但没有参数    String value() default "default"; // 日志的名称,默认值为"default"    LogLevel level() default LogLevel.INFO; // 日志级别,使用枚举}// 定义一个枚举作为注解的属性类型enum LogLevel {    DEBUG, INFO, WARN, ERROR}

这里我们定义了两个属性:

value

(字符串类型,默认”default”)和

level

LogLevel

枚举类型,默认

INFO

)。注解的属性可以有默认值,也可以没有。没有默认值的属性在使用注解时必须显式赋值。

第二步:编写注解处理器(核心逻辑)

注解本身是没有任何功能的,它只是一个标记。真正有用的地方在于我们如何去处理这些标记。通常,我们会通过反射机制来查找并解析这些注解,然后执行相应的逻辑。在实际项目中,这通常通过AOP(如Spring AOP或AspectJ)来实现,但为了演示原理,我们这里用一个简单的反射例子。

import java.lang.reflect.Method;import java.util.Arrays;public class LoggableProcessor {    public static void process(Object targetObject) throws Exception {        Class clazz = targetObject.getClass();        // 获取类中所有的方法        for (Method method : clazz.getDeclaredMethods()) {            // 检查方法上是否有 @Loggable 注解            if (method.isAnnotationPresent(Loggable.class)) {                Loggable loggable = method.getAnnotation(Loggable.class);                // 打印注解信息                System.out.println("--- 发现 @Loggable 注解 ---");                System.out.println("方法名: " + method.getName());                System.out.println("日志名称: " + loggable.value());                System.out.println("日志级别: " + loggable.level());                // 模拟方法执行并记录耗时                long startTime = System.currentTimeMillis();                // 假设这里调用了被注解的方法,并传入了参数                // 为了简化,我们这里不实际调用,只模拟                System.out.println("模拟执行方法: " + method.getName());                // Object result = method.invoke(targetObject, /* method arguments */);                long endTime = System.currentTimeMillis();                System.out.println("方法执行耗时: " + (endTime - startTime) + "ms");                System.out.println("-------------------------");            }        }    }    public static void main(String[] args) throws Exception {        MyService service = new MyService();        process(service);    }}class MyService {    @Loggable(value = "用户登录", level = LogLevel.INFO)    public void login(String username, String password) {        System.out.println("执行登录逻辑 for " + username);        try {            Thread.sleep(150); // 模拟耗时操作        } catch (InterruptedException e) {            Thread.currentThread().interrupt();        }    }    @Loggable(level = LogLevel.DEBUG) // 使用默认的value    public String getUserInfo(long userId) {        System.out.println("获取用户信息 for ID: " + userId);        try {            Thread.sleep(50);        } catch (InterruptedException e) {            Thread.currentThread().interrupt();        }        return "User " + userId;    }    public void doSomethingElse() {        System.out.println("执行其他不需日志记录的逻辑");    }}

在这个例子中,

LoggableProcessor

process

方法遍历了

MyService

类中的所有方法,查找带有

@Loggable

注解的方法。一旦找到,它就获取注解实例,并读取其

value

level

属性,然后模拟记录日志。在实际应用中,

method.invoke()

会真正调用被注解的方法,并在其前后添加日志、性能监控等逻辑。

通过这种方式,我们成功地将日志记录的逻辑与业务逻辑解耦。

MyService

类只关心自己的业务功能,而日志记录的“怎么做”则完全由

@Loggable

注解和

LoggableProcessor

来处理。这正是自定义注解的魅力所在。

以上就是什么是注解?其原理是什么?如何自定义一个注解?的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/88038.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
华为已申请多个鸿蒙电脑相关商标 5 月 8 日正式亮相
上一篇 2025年11月17日 20:56:44
在Java中如何使用ForkJoinTask执行并行计算
下一篇 2025年11月17日 20:58:47

相关推荐

  • windows怎么解决蓝屏问题_windows蓝屏故障排查与修复方法

    蓝屏问题通常由驱动冲突、硬件故障或系统文件损坏引起,需记录错误代码并进入安全模式排查;通过设备管理器检查驱动、使用SFC和DISM修复系统文件,并运行内存与硬盘检测工具确认硬件健康,必要时清洁硬件接触点。 如果您在使用Windows系统时遇到电脑突然黑屏并显示蓝色错误界面,这通常意味着系统遇到了无法…

    2026年9月21日
    000
  • 小红书零基础赚钱攻略(精准选题+涨粉秘籍+账号运营+高转化变现方法)

    找到自己真正擅长或有热情的领域,结合用户需求和竞争情况确定细分赛道;2. 通过优质内容、高互动数据、精准关键词和话题标签提升曝光;3. 利用品牌合作、带货佣金、知识付费等方式实现变现,核心是建立在信任基础上的持续价值输出,最终将流量转化为实际收益。 小红书零基础赚钱,核心在于找到自己的定位,持续输出…

    2026年9月21日
    000
  • mysql如何排查排序异常

    排查MySQL排序异常需先确认ORDER BY是否生效,检查子查询、UNION及应用层逻辑是否覆盖排序;通过EXPLAIN分析是否使用索引排序,避免Using filesort;确保字段类型、字符集和排序规则(collation)符合预期,处理NULL值和大小写敏感性;关注sort_buffer_s…

    2026年9月21日
    000
  • 《绝地潜兵2》开发商坚决否认反作弊软件影响性能

    如果你仍在《绝地潜兵2》中奋勇杀敌,可能已经察觉到一些逐渐浮现的稳定性问题。层出不穷的bug仿佛代码深处埋藏着虫族巢穴,而开发团队也已厌倦于反复澄清哪些并非核心症结。 自《绝地潜兵2》发售以来的20个月里,箭头游戏工作室的旅程并不轻松。游戏热度远超预期,迫使团队频繁推出更新与维护补丁,只为确保每位玩…

    2026年9月21日
    000
  • 如何配置VSCode与Jupyter Notebook进行交互式数据科学编程?

    首先安装Python、VSCode及Python扩展,再通过pip安装jupyter;接着在VSCode中创建或打开.ipynb文件,使用Shift+Enter运行单元格;然后通过Ctrl+Shift+P选择Python解释器并确保安装ipykernel以匹配内核;最后启用变量查看器、代码块分隔符和…

    2026年9月21日
    000
  • 即梦AI运镜控制怎么控制_即梦AI视频镜头移动技巧详解

    掌握即梦AI运镜需四步:一、用“镜头缓慢推进”等预设提示词生成标准运动;二、通过动效画板框选主体并绘制运动路径;三、设置首尾帧引导转场,实现穿越或循环效果;四、结合“希区柯克式变焦”“时间冻结环绕”等高级技巧增强视觉表现。 ☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 免费无限量使用 Dee…

    2026年9月21日
    000
  • windows怎么查看电脑型号_Windows查看电脑硬件型号方法

    通过系统信息工具查看:按Win+R输入msinfo32,查找“系统型号”获取电脑型号;2. 使用命令提示符执行wmic csproduct get name查询型号;3. 在Windows 11设置中进入“系统-关于”,查看“设备规格”下的“设备型号”;4. 利用PowerShell运行Get-Wm…

    2026年9月21日
    100
  • 华为Mate 70优享版明日开启预约 10月20日开售

    华为Mate 70优享版明日开启预约 10月20日开售华为Mate 70优享版明日开启预约 10月20日开售华为Mate 70优享版明日开启预约 10月20日开售华为Mate 70优享版明日开启预约 10月20日开售

    近日,有数码博主透露,华为mate 70优享版将于10月14日启动预约,并在10月20日正式发售。 在核心配置上,消息称该机型将搭载麒麟9010S处理器。 据悉,这款新机的整体硬件规格与标准版Mate 70保持高度一致,配备一块6.7英寸的1.5K OLED直屏,支持120Hz LTPO自适应刷新率…

    2026年9月21日 用户投稿
    000
  • Linux如何检查系统中缺失的依赖库

    使用ldd和readelf检查依赖,通过包管理器安装缺失库。ldd显示not found时,用apt-file或yum provides查找并安装对应软件包,必要时添加库路径至/etc/ld.so.conf并运行ldconfig更新缓存。 在Linux系统中,程序运行时依赖各种共享库(.so文件),…

    2026年9月21日
    000
  • .com网站安全维护_保障.com网站稳定的措施

    答案:保障.com网站稳定需加强安全防护、定期备份、实时监控和应急准备。部署防火墙、更新系统、使用HTTPS、限制端口;制定自动备份并异地存储,定期恢复测试;利用监控工具检测可用性与异常流量,优化加载速度;建立应急流程,严格权限管理,定期演练。细节执行到位才能确保长期安全稳定运行。 确保.com网站…

    2026年9月21日
    100
  • 三星电视携手京东开启艺术视听盛典以科技美学重塑家居生活新模式

    三星电视携手京东开启艺术视听盛典以科技美学重塑家居生活新模式三星电视携手京东开启艺术视听盛典以科技美学重塑家居生活新模式三星电视携手京东开启艺术视听盛典以科技美学重塑家居生活新模式三星电视携手京东开启艺术视听盛典以科技美学重塑家居生活新模式

    随着消费理念升级与需求日益多样化,电视已不再仅仅是观看节目和影音娱乐的工具,而是逐渐演变为承载家居美学、传递情感温度、连接智慧生活的艺术载体。在这一变革浪潮中,三星率先引领艺术电视领域的创新风向,theframe画壁艺术电视与theserif画境艺术电视成功打破科技与艺术之间的界限,将电视升华为可观…

    2026年9月21日 用户投稿
    100
  • 分布式锁(Redis)解决数据竞争

    使用redis实现分布式锁来解决数据竞争可以通过setnx和expire命令。1)使用setnx尝试获取锁,并通过expire设置锁的过期时间防止死锁。2)释放锁时使用watch命令确保锁未被其他客户端获取。需要注意redis的单点故障、高并发性能瓶颈和锁的过期时间设置。 在处理高并发的应用场景中,…

    2026年9月21日
    000
  • 如何在Weka中处理向量属性:ARFF格式的限制与解决方案

    本文探讨了weka中arff格式对直接向量属性表示的限制,并提供了两种主要解决方案。对于时间序列数据,建议利用weka的内置时间序列分析功能。对于非时间序列数据,核心在于通过特征工程(如使用addexpression、multifilter等)将向量拆解并转换为可被weka有效处理的独立特征,以揭示…

    2026年9月21日
    000
  • 蝴蝶号内容创作不露脸的五大绝技与执行方法 | 快速提升曝光率的实用操作流程

    不露脸也能玩转蝴蝶号内容创作,关键在于将焦点从个人形象转移到内容本身与观众体验上,通过声音叙事、动态文字、手部特写、数据可视化和场景搭建五大核心策略构建吸引力,结合高质量音画配合、精准的受众定位、稳定更新与算法互动,提升曝光率;同时规避素材版权、声音质量与画面单调等技术挑战,善用免费或付费正版素材、…

    2026年9月21日
    100
  • 哪些Docker扩展能让你在VSCode内轻松管理容器?

    Docker官方扩展是VSCode中管理容器的核心工具,提供容器、镜像、卷、网络的可视化操作,结合Remote-Containers可实现容器内开发,辅以YAML、GitLens等扩展提升效率,需确保本地Docker daemon运行。 在 VSCode 中管理 Docker 容器,最核心的扩展是 …

    2026年9月21日
    000
  • windows10如何解决“找不到恢复环境”的问题_windows10恢复环境修复方法

    首先启用恢复环境,若失败则修复BCD引导配置,最后检查并恢复Winre.wim文件以解决“找不到恢复环境”问题。 如果您尝试在Windows 10系统中使用“重置此电脑”或“高级启动”功能,但收到“找不到恢复环境”的提示,则可能是由于恢复环境被禁用、引导配置错误或核心文件丢失。以下是解决此问题的步骤…

    2026年9月21日
    200
  • PostgreSQL地理位置数据按距离排序的最佳实践:数据库层优化策略

    在处理大量地理位置数据并按距离排序时,将排序逻辑下推至数据库层(如postgresql)是更优的选择。这种方法能有效减少应用层的数据传输和内存消耗,充分利用数据库的计算能力,从而提升整体性能和资源利用率,而非在spring boot应用服务层进行排序。 1. 地理位置排序的需求与挑战 在现代Web应…

    2026年9月21日
    100
  • REDMI K90标准版外观预热:两款低饱和配色

    今日,redmi k90标准版正式开启预热,并首次公开完整外观设计。 官方称其为REDMI K系列历史上最为精致的标准版机型。从目前已公布的信息来看,新机将推出两种低饱和度配色:通透紫与纯净白,机身采用一体化包裹式金属中框,搭配同色系对称天线带设计,正面配备一块6.59英寸显示屏,凭借高达94%的屏…

    2026年9月21日
    100
  • win11系统搜索索引损坏导致搜索缓慢怎么办_Win11搜索索引损坏修复方法

    首先运行搜索和索引疑难解答,然后重启Windows搜索服务;若问题依旧,需重建搜索索引数据库并重置Windows搜索应用组件,最后使用SFC和DISM命令修复系统文件,以彻底解决Windows 11搜索功能响应缓慢或结果不完整的问题。 如果您尝试在Windows 11中使用搜索功能,但发现响应缓慢或…

    2026年9月21日
    000
  • Flyway配置中安全使用环境变量的实践指南

    flyway配置中直接暴露数据库连接参数存在安全隐患。本文详细阐述了如何通过命令行参数和api调用两种主要方式,将环境变量安全地集成到flyway配置流程中。通过外部化管理敏感信息,可以有效提升数据库迁移配置的安全性、灵活性和可维护性,避免将凭证硬编码到配置文件中。 在数据库迁移实践中,将敏感的数据…

    2026年9月21日
    100

发表回复

登录后才能评论
关注微信