Java注解原理与自定义注解详细教程

java注解的核心在于作为元数据提升代码可读性与框架扩展性,其底层机制依赖@retention定义生命周期、@target指定作用目标,并通过反射实现运行时访问。1. @retention有source、class、runtime三种策略,决定注解存活阶段;2. @target限制注解应用范围如方法、字段等;3. 反射机制使运行时获取注解信息成为可能;4. 自定义注解设计需明确用途、作用位置及携带信息;5. 注解广泛用于权限校验、配置简化、验证规则封装及框架构建,有效剥离横切逻辑,提升代码质量。

Java注解原理与自定义注解详细教程

Java注解,在我看来,它不仅仅是一堆附着在代码上的标签,更像是一种高级的、声明式的编程工具,它允许我们在不改变代码逻辑本身的情况下,为代码添加元数据,从而在编译期、类加载期乃至运行时,被工具、框架或我们自己的程序所读取和处理。它极大地提升了代码的可读性、可维护性,并为框架的扩展性提供了无限可能。

Java注解原理与自定义注解详细教程

解决方案

理解Java注解的核心,在于认识到它是一种元数据(metadata),即“关于数据的数据”。它不会直接影响程序的运行逻辑,而是作为一种标记或配置信息存在。我们常见的@Override@Deprecated就是最直观的例子。它们分别告诉编译器“这是一个重写方法”和“这个方法已经过时了”。更深层次的应用则体现在Spring的@Autowired、Junit的@Test等,它们在运行时被框架解析,进而驱动依赖注入、测试执行等复杂行为。要掌握注解,我们首先要理解它的生命周期(RetentionPolicy)和作用目标(ElementType),这是自定义注解的基础。

Java注解原理与自定义注解详细教程

Java注解的底层机制是怎样的?

当我们谈论Java注解的底层机制时,其实是在探讨它们是如何被定义、如何被存储以及如何在运行时被访问的。这背后离不开几个关键的“元注解”和Java的反射机制。

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

首先是@Retention,它决定了注解的生命周期。我第一次接触到这个概念的时候,脑子里就冒出个词:“魔法!”因为它直接决定了你的注解能活多久:

Java注解原理与自定义注解详细教程RetentionPolicy.SOURCE: 注解只在源代码中存在,编译时会被丢弃,比如@Override。这意味着你无法在运行时通过反射获取它。RetentionPolicy.CLASS: 注解会被编译到.class文件中,但在JVM加载类时会被丢弃。这通常用于一些编译时或字节码增强工具。RetentionPolicy.RUNTIME: 这是最常用的,也是真正让注解“活”起来的关键。注解不仅会保留在源代码和.class文件中,还会在JVM加载类后,在运行时仍然可用。这意味着我们可以通过反射机制来获取并处理这些注解信息。比如Spring框架的@Autowired@Transactional,它们都是在运行时被解析的。

接着是@Target,它定义了注解可以被应用到哪些Java元素上,比如类、方法、字段、参数等等。如果你想让你的注解只作用于方法上,那@Target(ElementType.METHOD)就是你的守门员。它避免了注解被错误地应用到不合适的地方,增强了代码的语义清晰度。

还有几个不那么常用但同样重要的元注解:

通义视频 通义视频

通义万相AI视频生成工具

通义视频 70 查看详情 通义视频 @Documented: 如果一个注解被@Documented修饰,那么当你在生成Javadoc文档时,这个注解也会被包含进去。这对于API文档的完整性很有帮助。@Inherited: 这个元注解比较特殊,它只对类(ElementType.TYPE)上的注解有效。如果一个被@Inherited修饰的注解A应用在一个父类上,那么它的子类将默认继承这个注解A。但需要注意的是,这只对类有效,方法或字段上的注解不会被继承。@Repeatable: Java 8引入的新特性,允许同一个注解在同一个元素上重复出现多次。比如,你可能想给一个方法标记多个不同的权限。

真正让注解在运行时发挥作用的,是Java的反射机制。当一个类被加载到JVM中后,我们可以通过ClassMethodField等反射对象,调用像isAnnotationPresent()getAnnotation()getAnnotations()这样的方法,来检查某个元素上是否存在特定的注解,并获取注解实例及其属性值。正是这种“运行时可查”的能力,使得注解成为了各种框架(如Spring AOP、ORM框架)实现核心功能的重要基石。

如何从零开始设计和实现自定义注解?

设计和实现一个自定义注解,其实远没有想象中那么复杂,它更像是在定义一个特殊的接口。我通常会先问自己几个问题:这个注解是给谁看的?它要附着在哪里?它需要携带哪些信息?

我们通过一个简单的例子来一步步实现一个自定义的“权限校验”注解:@RequiredPermission

定义注解:注解的定义看起来像一个接口,但前面多了一个@符号。

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 RequiredPermission {    String[] value() default {}; // 权限值,可以有多个    String description() default ""; // 描述信息}

@Retention(RetentionPolicy.RUNTIME): 这是关键,它确保我们的注解在程序运行时仍然可用,这样我们才能通过反射去读取它。@Target(ElementType.METHOD): 我们希望这个权限注解只作用于方法上,所以这里指定了METHOD。如果你想让它作用于类上,就用ElementType.TYPEString[] value() default {};: 这定义了注解的一个成员(或称属性)。注解的成员看起来像方法,但没有参数,没有抛出异常,并且只能返回基本类型、String、Class、枚举、注解以及它们的数组。default {}表示这个属性有一个默认值,这样在使用注解时就可以省略它。String description() default "";: 另一个属性,用于提供更详细的描述。

使用自定义注解:现在,我们可以在任何方法上使用这个注解了。

public class UserService {    @RequiredPermission({"USER_READ", "ADMIN"})    public void getUserInfo(String userId) {        System.out.println("Fetching user info for: " + userId);        // 实际的业务逻辑    }    @RequiredPermission(value = {"USER_WRITE"}, description = "创建新用户")    public void createUser(String userName) {        System.out.println("Creating user: " + userName);        // 实际的业务逻辑    }    public void publicMethod() {        System.out.println("This is a public method, no permission required.");    }}

处理自定义注解(通过反射):这是最重要的一步,我们如何让这个注解真正“工作”起来。通常,我们会编写一个处理器,在运行时检查方法上的注解。这可以是一个AOP切面,或者一个简单的工具类。

import java.lang.reflect.Method;public class AnnotationProcessor {    public static void checkPermission(Method method) {        // 检查方法上是否存在RequiredPermission注解        if (method.isAnnotationPresent(RequiredPermission.class)) {            RequiredPermission annotation = method.getAnnotation(RequiredPermission.class);            String[] requiredPermissions = annotation.value();            String description = annotation.description();            System.out.println("--- 权限检查开始 ---");            System.out.println("方法: " + method.getName());            System.out.println("所需权限: " + String.join(", ", requiredPermissions));            System.out.println("描述: " + description);            // 模拟权限验证逻辑            boolean hasPermission = false;            // 假设当前用户有 "ADMIN" 权限            String[] currentUserPermissions = {"USER_READ", "ADMIN"};            for (String reqPerm : requiredPermissions) {                for (String userPerm : currentUserPermissions) {                    if (reqPerm.equals(userPerm)) {                        hasPermission = true;                        break;                    }                }                if (hasPermission) break;            }            if (hasPermission) {                System.out.println("权限验证通过!");            } else {                System.err.println("权限不足,操作被拒绝!");                // 实际应用中可以抛出异常                throw new SecurityException("Permission denied for method: " + method.getName());            }            System.out.println("--- 权限检查结束 ---");        } else {            System.out.println("方法 " + method.getName() + " 无需权限检查。");        }    }    public static void main(String[] args) throws Exception {        UserService userService = new UserService();        Method getUserInfoMethod = UserService.class.getMethod("getUserInfo", String.class);        Method createUserMethod = UserService.class.getMethod("createUser", String.class);        Method publicMethod = UserService.class.getMethod("publicMethod");        try {            checkPermission(getUserInfoMethod);            userService.getUserInfo("123");        } catch (SecurityException e) {            System.out.println(e.getMessage());        }        System.out.println("n---");        try {            checkPermission(createUserMethod);            userService.createUser("Alice");        } catch (SecurityException e) {            System.out.println(e.getMessage());        }        System.out.println("n---");        checkPermission(publicMethod);        userService.publicMethod();    }}

在这个示例中,我们通过Method对象的isAnnotationPresent()getAnnotation()方法,在运行时获取了@RequiredPermission注解的实例,并读取了它的valuedescription属性,然后模拟了一个权限校验的逻辑。这只是一个非常简化的模型,实际应用中,这种处理逻辑通常会集成到框架的AOP(面向切面编程)模块中,在方法执行前后自动进行。

自定义注解在实际项目中能解决哪些痛点?

自定义注解在实际项目中的应用场景非常广泛,它们就像是代码中的“标签”或“指令”,让我们的程序变得更加智能和声明式。我个人最喜欢用自定义注解来做一些权限校验或者日志记录,因为它真的能让你的业务逻辑代码变得异常干净。

简化配置和消除样板代码:想想看,如果每次都要手动写一堆if/else来校验参数,或者为每个方法都加try-catch来处理异常,那代码得有多臃肿?自定义注解可以将这些重复的、模板化的代码逻辑抽离出来,变成一种声明式的配置。

示例: 我们上面实现的@RequiredPermission就是一个很好的例子。它将权限校验的逻辑从业务方法中剥离出来,业务方法只需要关注自己的核心功能,而权限问题则由注解处理器(通常是AOP切面)在外部统一管理。痛点: 大量重复的if/else、try-catch块,导致业务逻辑代码被“污染”,可读性差,维护成本高。解决: 通过注解标记,结合AOP或反射,将这些横切关注点(如日志、事务、权限、缓存)集中处理,业务代码更专注于“做什么”,而不是“如何做”。

实现自定义验证规则:在表单或API参数校验中,我们经常需要对输入数据进行各种复杂的验证。虽然有Hibernate Validator这样的强大工具,但有时我们需要一些项目特有的、业务相关的验证规则。

示例: 假设我们需要一个@ValidPhoneNumber注解来验证手机号格式,或者@UniqueUsername来检查用户名是否唯一。痛点: 每次遇到新的验证规则,都要手动编写复杂的正则表达式或数据库查询逻辑,并且分散在各处。解决: 自定义注解结合验证器,可以将验证逻辑封装起来,通过注解声明式地应用到字段上,使得验证代码高度复用且易于管理。

构建轻量级框架或工具:许多流行的Java框架,如Spring、JUnit、Lombok,都大量使用了注解来简化开发。我们也可以借鉴这种思想,为自己的项目构建一些小型的、领域特定的工具。

示例:RPC服务暴露: 定义一个@RpcService注解,标记哪些接口或类应该被暴露为RPC服务,然后通过扫描这些注解来自动注册服务。任务调度: 定义@ScheduledTask注解,标记哪些方法应该作为定时任务执行,并指定执行频率。数据映射: 在ORM框架中,自定义@ColumnName@TableName等注解来映射数据库表和字段。痛点: 复杂的配置XML文件、硬编码的依赖关系、代码可扩展性差。解决: 注解提供了一种声明式的配置方式,让框架能够通过扫描和反射来发现和处理组件,从而实现“约定优于配置”的原则,降低了学习和使用成本,提高了开发效率。

增强代码的可读性和语义性:一个设计良好的自定义注解本身就是一种文档,它能清晰地表达代码的意图。

示例:@BetaFeature: 标记一个功能尚处于测试阶段。@InternalApi: 标记一个API只供内部使用,不建议外部调用。@Author("YourName"): 标记代码的作者。痛点: 代码注释可能随着时间推移而过时,或者在代码重构时被忽略。解决: 注解作为代码的一部分,其生命周期与代码同步,可以更好地传达代码的元信息,帮助团队成员理解代码的约束和设计意图。

总而言之,自定义注解提供了一种强大的元编程能力,它让我们可以用更优雅、更声明式的方式来编写和组织代码,将那些重复的、非核心的逻辑从业务代码中剥离,从而提升代码质量,降低维护成本。它不仅仅是语法糖,更是一种设计思想的体现。

以上就是Java注解原理与自定义注解详细教程的详细内容,更多请关注创想鸟其它相关文章!

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

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年11月4日 07:19:12
下一篇 2025年11月4日 07:19:39

相关推荐

  • 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
  • 如何选择元素个数不固定的指定类名子元素?

    灵活选择元素个数不固定的指定类名子元素 在网页布局中,有时需要选择特定类名的子元素,但这些元素的数量并不固定。例如,下面这段 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
  • 为什么 CSS mask 属性未请求指定图片?

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

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

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

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

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

    2025年12月24日
    200
  • 为什么我的 Safari 自定义样式表在百度页面上失效了?

    为什么在 Safari 中自定义样式表未能正常工作? 在 Safari 的偏好设置中设置自定义样式表后,您对其进行测试却发现效果不同。在您自己的网页中,样式有效,而在百度页面中却失效。 造成这种情况的原因是,第一个访问的项目使用了文件协议,可以访问本地目录中的图片文件。而第二个访问的百度使用了 ht…

    2025年12月24日
    000
  • 如何用前端实现 Windows 10 设置界面的鼠标移动探照灯效果?

    如何在前端实现 Windows 10 设置界面中的鼠标移动探照灯效果 想要在前端开发中实现 Windows 10 设置界面中类似的鼠标移动探照灯效果,可以通过以下途径: CSS 解决方案 DEMO 1: Windows 10 网格悬停效果:https://codepen.io/tr4553r7/pe…

    2025年12月24日
    000
  • 使用CSS mask属性指定图片URL时,为什么浏览器无法加载图片?

    css mask属性未能加载图片的解决方法 使用css mask属性指定图片url时,如示例中所示: mask: url(“https://api.iconify.design/mdi:apple-icloud.svg”) center / contain no-repeat; 但是,在网络面板中却…

    2025年12月24日
    000
  • 如何用CSS Paint API为网页元素添加时尚的斑马线边框?

    为元素添加时尚的斑马线边框 在网页设计中,有时我们需要添加时尚的边框来提升元素的视觉效果。其中,斑马线边框是一种既醒目又别致的设计元素。 实现斜向斑马线边框 要实现斜向斑马线间隔圆环,我们可以使用css paint api。该api提供了强大的功能,可以让我们在元素上绘制复杂的图形。 立即学习“前端…

    2025年12月24日
    000
  • 图片如何不撑高父容器?

    如何让图片不撑高父容器? 当父容器包含不同高度的子元素时,父容器的高度通常会被最高元素撑开。如果你希望父容器的高度由文本内容撑开,避免图片对其产生影响,可以通过以下 css 解决方法: 绝对定位元素: .child-image { position: absolute; top: 0; left: …

    2025年12月24日
    000
  • CSS 帮助

    我正在尝试将文本附加到棕色框的左侧。我不能。我不知道代码有什么问题。请帮助我。 css .hero { position: relative; bottom: 80px; display: flex; justify-content: left; align-items: start; color:…

    2025年12月24日 好文分享
    200
  • 前端代码辅助工具:如何选择最可靠的AI工具?

    前端代码辅助工具:可靠性探讨 对于前端工程师来说,在HTML、CSS和JavaScript开发中借助AI工具是司空见惯的事情。然而,并非所有工具都能提供同等的可靠性。 个性化需求 关于哪个AI工具最可靠,这个问题没有一刀切的答案。每个人的使用习惯和项目需求各不相同。以下是一些影响选择的重要因素: 立…

    2025年12月24日
    300
  • 如何用 CSS Paint API 实现倾斜的斑马线间隔圆环?

    实现斑马线边框样式:探究 css paint api 本文将探究如何使用 css paint api 实现倾斜的斑马线间隔圆环。 问题: 给定一个有多个圆圈组成的斑马线图案,如何使用 css 实现倾斜的斑马线间隔圆环? 答案: 立即学习“前端免费学习笔记(深入)”; 使用 css paint api…

    2025年12月24日
    000

发表回复

登录后才能评论
关注微信