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

答案:注解是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)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年11月17日 20:44:32
下一篇 2025年11月17日 20:58:47

相关推荐

  • CSS mask属性无法获取图片:为什么我的图片不见了?

    CSS mask属性无法获取图片 在使用CSS mask属性时,可能会遇到无法获取指定照片的情况。这个问题通常表现为: 网络面板中没有请求图片:尽管CSS代码中指定了图片地址,但网络面板中却找不到图片的请求记录。 问题原因: 此问题的可能原因是浏览器的兼容性问题。某些较旧版本的浏览器可能不支持CSS…

    2025年12月24日
    900
  • Uniapp 中如何不拉伸不裁剪地展示图片?

    灵活展示图片:如何不拉伸不裁剪 在界面设计中,常常需要以原尺寸展示用户上传的图片。本文将介绍一种在 uniapp 框架中实现该功能的简单方法。 对于不同尺寸的图片,可以采用以下处理方式: 极端宽高比:撑满屏幕宽度或高度,再等比缩放居中。非极端宽高比:居中显示,若能撑满则撑满。 然而,如果需要不拉伸不…

    2025年12月24日
    400
  • 如何让小说网站控制台显示乱码,同时网页内容正常显示?

    如何在不影响用户界面的情况下实现控制台乱码? 当在小说网站上下载小说时,大家可能会遇到一个问题:网站上的文本在网页内正常显示,但是在控制台中却是乱码。如何实现此类操作,从而在不影响用户界面(UI)的情况下保持控制台乱码呢? 答案在于使用自定义字体。网站可以通过在服务器端配置自定义字体,并通过在客户端…

    2025年12月24日
    800
  • SASS 中的 Mixins

    mixin 是 css 预处理器提供的工具,虽然它们不是可以被理解的函数,但它们的主要用途是重用代码。 不止一次,我们需要创建多个类来执行相同的操作,但更改单个值,例如字体大小的多个类。 .fs-10 { font-size: 10px;}.fs-20 { font-size: 20px;}.fs-…

    2025年12月24日
    000
  • 如何在地图上轻松创建气泡信息框?

    地图上气泡信息框的巧妙生成 地图上气泡信息框是一种常用的交互功能,它简便易用,能够为用户提供额外信息。本文将探讨如何借助地图库的功能轻松创建这一功能。 利用地图库的原生功能 大多数地图库,如高德地图,都提供了现成的信息窗体和右键菜单功能。这些功能可以通过以下途径实现: 高德地图 JS API 参考文…

    2025年12月24日
    400
  • 如何使用 scroll-behavior 属性实现元素scrollLeft变化时的平滑动画?

    如何实现元素scrollleft变化时的平滑动画效果? 在许多网页应用中,滚动容器的水平滚动条(scrollleft)需要频繁使用。为了让滚动动作更加自然,你希望给scrollleft的变化添加动画效果。 解决方案:scroll-behavior 属性 要实现scrollleft变化时的平滑动画效果…

    2025年12月24日
    000
  • 如何为滚动元素添加平滑过渡,使滚动条滑动时更自然流畅?

    给滚动元素平滑过渡 如何在滚动条属性(scrollleft)发生改变时为元素添加平滑的过渡效果? 解决方案:scroll-behavior 属性 为滚动容器设置 scroll-behavior 属性可以实现平滑滚动。 html 代码: click the button to slide right!…

    2025年12月24日
    500
  • 为什么设置 `overflow: hidden` 会导致 `inline-block` 元素错位?

    overflow 导致 inline-block 元素错位解析 当多个 inline-block 元素并列排列时,可能会出现错位显示的问题。这通常是由于其中一个元素设置了 overflow 属性引起的。 问题现象 在不设置 overflow 属性时,元素按预期显示在同一水平线上: 不设置 overf…

    2025年12月24日 好文分享
    400
  • 网页使用本地字体:为什么 CSS 代码中明明指定了“荆南麦圆体”,页面却仍然显示“微软雅黑”?

    网页中使用本地字体 本文将解答如何将本地安装字体应用到网页中,避免使用 src 属性直接引入字体文件。 问题: 想要在网页上使用已安装的“荆南麦圆体”字体,但 css 代码中将其置于第一位的“font-family”属性,页面仍显示“微软雅黑”字体。 立即学习“前端免费学习笔记(深入)”; 答案: …

    2025年12月24日
    000
  • 如何选择元素个数不固定的指定类名子元素?

    灵活选择元素个数不固定的指定类名子元素 在网页布局中,有时需要选择特定类名的子元素,但这些元素的数量并不固定。例如,下面这段 html 代码中,activebar 和 item 元素的数量均不固定: *n *n 如果需要选择第一个 item元素,可以使用 css 选择器 :nth-child()。该…

    2025年12月24日
    200
  • 使用 SVG 如何实现自定义宽度、间距和半径的虚线边框?

    使用 svg 实现自定义虚线边框 如何实现一个具有自定义宽度、间距和半径的虚线边框是一个常见的前端开发问题。传统的解决方案通常涉及使用 border-image 引入切片图片,但是这种方法存在引入外部资源、性能低下的缺点。 为了避免上述问题,可以使用 svg(可缩放矢量图形)来创建纯代码实现。一种方…

    2025年12月24日
    100
  • 如何让“元素跟随文本高度,而不是撑高父容器?

    如何让 元素跟随文本高度,而不是撑高父容器 在页面布局中,经常遇到父容器高度被子元素撑开的问题。在图例所示的案例中,父容器被较高的图片撑开,而文本的高度没有被考虑。本问答将提供纯css解决方案,让图片跟随文本高度,确保父容器的高度不会被图片影响。 解决方法 为了解决这个问题,需要将图片从文档流中脱离…

    2025年12月24日
    000
  • 为什么我的特定 DIV 在 Edge 浏览器中无法显示?

    特定 DIV 无法显示:用户代理样式表的困扰 当你在 Edge 浏览器中打开项目中的某个 div 时,却发现它无法正常显示,仔细检查样式后,发现是由用户代理样式表中的 display none 引起的。但你疑问的是,为什么会出现这样的样式表,而且只针对特定的 div? 背后的原因 用户代理样式表是由…

    2025年12月24日
    200
  • inline-block元素错位了,是为什么?

    inline-block元素错位背后的原因 inline-block元素是一种特殊类型的块级元素,它可以与其他元素行内排列。但是,在某些情况下,inline-block元素可能会出现错位显示的问题。 错位的原因 当inline-block元素设置了overflow:hidden属性时,它会影响元素的…

    2025年12月24日
    000
  • 为什么 CSS mask 属性未请求指定图片?

    解决 css mask 属性未请求图片的问题 在使用 css mask 属性时,指定了图片地址,但网络面板显示未请求获取该图片,这可能是由于浏览器兼容性问题造成的。 问题 如下代码所示: 立即学习“前端免费学习笔记(深入)”; icon [data-icon=”cloud”] { –icon-cl…

    2025年12月24日
    200
  • 为什么使用 inline-block 元素时会错位?

    inline-block 元素错位成因剖析 在使用 inline-block 元素时,可能会遇到它们错位显示的问题。如代码 demo 所示,当设置了 overflow 属性时,a 标签就会错位下沉,而未设置时却不会。 问题根源: overflow:hidden 属性影响了 inline-block …

    2025年12月24日
    000
  • 如何利用 CSS 选中激活标签并影响相邻元素的样式?

    如何利用 css 选中激活标签并影响相邻元素? 为了实现激活标签影响相邻元素的样式需求,可以通过 :has 选择器来实现。以下是如何具体操作: 对于激活标签相邻后的元素,可以在 css 中使用以下代码进行设置: li:has(+li.active) { border-radius: 0 0 10px…

    2025年12月24日
    100
  • 为什么我的 CSS 元素放大效果无法正常生效?

    css 设置元素放大效果的疑问解答 原提问者在尝试给元素添加 10em 字体大小和过渡效果后,未能在进入页面时看到放大效果。探究发现,原提问者将 CSS 代码直接写在页面中,导致放大效果无法触发。 解决办法如下: 将 CSS 样式写在一个单独的文件中,并使用 标签引入该样式文件。这个操作与原提问者观…

    2025年12月24日
    000
  • 如何模拟Windows 10 设置界面中的鼠标悬浮放大效果?

    win10设置界面的鼠标移动显示周边的样式(探照灯效果)的实现方式 在windows设置界面的鼠标悬浮效果中,光标周围会显示一个放大区域。在前端开发中,可以通过多种方式实现类似的效果。 使用css 使用css的transform和box-shadow属性。通过将transform: scale(1.…

    2025年12月24日
    200
  • 为什么我的 em 和 transition 设置后元素没有放大?

    元素设置 em 和 transition 后不放大 一个 youtube 视频中展示了设置 em 和 transition 的元素在页面加载后会放大,但同样的代码在提问者电脑上没有达到预期效果。 可能原因: 问题在于 css 代码的位置。在视频中,css 被放置在单独的文件中并通过 link 标签引…

    2025年12月24日
    100

发表回复

登录后才能评论
关注微信