前两篇文章咱聊了深入了解了 Spring 注解编程一些原理,这篇文章我们关注注解属性方法,聊聊 Spring 为注解的带来的功能,属性别名与覆盖。
注解属性方法在进入了解 Spring 注解属性功能之前,我们先看一个正常 Java 注解。
在注解中,属性方法与其他类/接口方法写法类似,但是存在一些区别。
注解属性方法的返回类型仅限为八种基本类型(包装类不支持),字符串,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,并且两个互相指向对方。
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注解。
SpringBootApplication#scanBasePackages 别名与 ComponentScan#basePackages。设置前者间接为后者赋值。
Spring Boot 就是使用 @Aliasfor 与组合注解功能,使用 SpringBootApplication一个注解代替 Configuration,EnableAutoConfiguration,ComponentScan。
Spring 注解属性覆盖与别名使用 @AliasFor 注解,可以做到别名的功能。
在 Spring 中别名可以分为以下几类:
显式别名(xplicit Aliases)
隐式别名(Implicit Aliases)
传递隐式别名(Transitive Implicit Aliases)
以上三类都需要满足以下条件:
属性类型相同
属性方法必须存在默认值
属性默认值必须相同
否则运行过程中将会出错。
显式别名如果一个注解中的两个成员通过 @AliasFor声明后互为别名,那么它们是显式别名
。
显示别名的关系如图所示。
隐式别名如果一个注解中的两个或者更多成员通过@AliasFor声明去覆盖同一个元注解的成员值,它们就是隐式别名
。
隐式别名如图所示。
上图中,@One 的 name 属性与 nameAlias 别名与 @Two nameAlias 属性。由于 @One 注解中并未直接使用 @AliasFor,所以与 @One 注解隐式别名。
隐式别名类似于数学的等式。可以将其看做以下推导过程。
@One.name=@Two.nameAlias @One.nameAlias=@Two.nameAlias 可以推导出 @One.name=@One.nameAlias 传递式隐式别名