Spring 注解编程之注解属性别名与覆盖

简介: 前两篇文章咱聊了深入了解了 Spring 注解编程一些原理,这篇文章我们关注注解属性方法,聊聊 Spring 为注解的带来的功能,属性别名与覆盖。

注解属性方法


在进入了解 Spring 注解属性功能之前,我们先看一个正常 Java 注解。70.jpg在注解中,属性方法与其他类/接口方法写法类似,但是存在一些区别。


注解属性方法的返回类型仅限为八种基本类型(包装类不支持),字符串,class,enum,Annotation以及前面类型的数组。


复习一下,java 八种基本类型分别为,byte(字节型)、short(短整型)、int(整型)、long(长整型)、float(单精度浮点型)、double(双精度浮点型)、boolean(布尔型)、char(字符型)。


其次,注解属性方法可以使用 default 设置默认值。如果没有设置默认值,声明注解时必须显式设置属性,否则编译将会出错。


另外 Java 注解无法继承类,也无法实现接口。


Spring 属性方法特性


在 Spring 中,有一些注解,使用不同属性方法,却能到达相同结果。典型的如  RequestMapping 。


在 WEB 项目中,设置 url 路径,我们可以在方法是这样声明:

 @RequestMapping("hello")
    public String helloAnnotation() {
  。。。。
    }

上面方法本质使用注解 value 属性。当注解声明时只需要设置一个方法时,如果属性方法为 value,不需要使用 key=value 的语法,只需要直接设置属性值即可。


另外也可以使用  path  属性方法设置。

@RequestMapping(path = "hello")
    public String helloAnnotation() {
  。。。。
    }

两种方式,最后运行效果一致。


查看 RequestMapping 注解源码,可以发现在  value  与  path  属性方法上使用 @AliasFor,并且两个互相指向对方。

71.jpg

Spring 4.2 加入 @AliasFor 注解,并使用 @AliasFor 重新更新  RequestMapping 等注解,为它们内部带来了别名的功能。


@AliasFor 使用方式


在 Spring 中,@AliasFor 可以在同一注解中使用,使用方法如 RequestMapping 注解。


这种方式,带来含义明确属性方法。如 RequestMapping,path 属性方法,这个属性方法含义就比较明确,不同的人理解不会有偏差。而 value 属性含义就不是很明确,不能一下子就将它真正含义产生联系。


日常开发中,我们也要避免 i,a,b 这些无意义的命名,尽量使用含义明确的命名。这样利用维护代码的人理解。


第二点,同一注解属性方法相互别名,这样就兼容之前版本用法。


RequestMapping 注解如果仅新增 path 属性,然后根据其解析 url 路径,这样就会导致升级 Spring 版本过程,运行错误的。


一个好软件版本需要时向前兼容,如 JDK 8 兼容 JDK 6一样。


另外 @AliasFor 注解还可以作用与不同注解之前,典型的如 SpringBootApplication 注解。

72.jpg

SpringBootApplication#scanBasePackages

别名与 ComponentScan#basePackages 。设置前者间接为后者赋值。


Spring Boot 就是使用 @Aliasfor 与组合注解功能,使用 SpringBootApplication一个注解代替Configuration,EnableAutoConfiguration,ComponentScan。


Spring 注解属性覆盖与别名


使用 @AliasFor 注解,可以做到别名的功能。


在 Spring 中别名可以分为以下几类:


1. 显式别名(xplicit Aliases)

2. 隐式别名(Implicit Aliases)

3. 传递隐式别名(Transitive Implicit Aliases)


以上三类都需要满足以下条件:


1. 属性类型相同

2. 属性方法必须存在默认值

3. 属性默认值必须相同


否则运行过程中将会出错。


显式别名


如果一个注解中的两个成员通过 @AliasFor声明后互为别名,那么它们是显式别名。


显示别名的关系如图所示。

73.jpg

隐式别名


如果一个注解中的两个或者更多成员通过@AliasFor声明去覆盖同一个元注解的成员值,它们就是隐式别名。


隐式别名如图所示。

74.jpg

上图中,@One 的 name 属性与 nameAlias 别名与 @Two ,nameAlias属性。由于 @One 注解中并未直接使用 @AliasFor,所以与 @One 注解隐式别名。



隐式别名类似于数学的等式。可以将其看做以下推导过程。

@One.name=@Two.nameAlias
@One.nameAlias=@Two.nameAlias
可以推导出
@One.name=@One.nameAlias

传递式隐式别名


如果一个注解中的两个或者更多成员通过@AliasFor声明去覆盖元注解中的不同成员,但是实际上因为[覆盖的传递性](https://en.wikipedia.org/wiki/Transitive_relation)导致最终覆盖的是元注解中的同一个成员,那么它们就是传递隐式别名。


传递式隐式别名如图所示。

75.jpg

这种类型涉及了多个注解,@One#name 别名了 @Two#nameAlias 属性,然后在 @One#nameAlias 属性又别名了 @Three#nameAliasThree 属性。然后由于 @Two#nameAlias又别名了 @Three#nameAliasThree 属性,这就导致 @One#name 与  @One#nameAlias 间接发生了关系。这种依靠传递性才生别名关系,称为 传递式隐式别名。


隐式别名类似于数学的等式。大家也可以将其用上面等式推导。


属性覆盖


属性覆盖指的是注解的一个成员覆盖另一个成员,最后两者成员属性值一致。


属性覆盖可以分为三类:


1. 隐式覆盖(Implicit Overrides)

2. 显示覆盖(Explicit Overrides)

3. 传递式显式覆盖(Transitive Explicit Overrides)


隐式覆盖


当一个注解 @One 被元注解  @Two 标注,两个注解存在同样的属性方法 name。@Two#name 将会被 @One#name 属性覆盖。76.jpg

两个看似不来自不同注解的成员 name 指向了同一个成员 name。


显示覆盖


显示覆盖就比较简单了,使用 @AliasFor 注解之后,就成为显示覆盖。

77.jpg

传递式显式覆盖


如果注解 @One#name  显示覆盖了 @Two#nameAlias,而 @Two#nameAlias显示覆盖了 @Three#nameAlias,最后因为传递性,@One#name 实际覆盖了@Three#nameAlias。

78.jpg

总结


Spring 4.2 新增 @AliasFor 注解,带来一些特性。但是要注意的是仅仅存在 @AliasFor 不会执行任何语义别名。


底层原理可以参考 AnnotationUtils 与 AnnotatedElementUtils。


相关文章
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
1059 0
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
1911 128
|
XML Java 数据格式
《深入理解Spring》:AOP面向切面编程深度解析
Spring AOP通过代理模式实现面向切面编程,将日志、事务等横切关注点与业务逻辑分离。支持注解、XML和编程式配置,提供五种通知类型及丰富切点表达式,助力构建高内聚、低耦合的可维护系统。
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
1354 1
使用Spring的@Retryable注解进行自动重试
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
841 12
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
1041 2
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
863 0
探索Spring Boot的@Conditional注解的上下文配置
|
智能设计 Java 测试技术
Spring中最大化@Lazy注解,实现资源高效利用
本文深入探讨了 Spring 框架中的 `@Lazy` 注解,介绍了其在资源管理和性能优化中的作用。通过延迟初始化 Bean,`@Lazy` 可显著提升应用启动速度,合理利用系统资源,并增强对 Bean 生命周期的控制。文章还分析了 `@Lazy` 的工作机制、使用场景、最佳实践以及常见陷阱与解决方案,帮助开发者更高效地构建可扩展、高性能的 Spring 应用程序。
551 0
Spring中最大化@Lazy注解,实现资源高效利用
|
Java 测试技术 编译器
@GrpcService使用注解在 Spring Boot 中开始使用 gRPC
本文介绍了如何在Spring Boot应用中集成gRPC框架,使用`@GrpcService`注解实现高效、可扩展的服务间通信。内容涵盖gRPC与Protocol Buffers的原理、环境配置、服务定义与实现、测试方法等,帮助开发者快速构建高性能的微服务系统。
2106 0
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
1646 0