@AliasFor

发布时间:2023年12月19日

@AliasFor

@AliasFor 注解用于声明注解属性的别名,主要有两种应用场景:注解内的别名和元数据的别名。

注解内的别名

首先,让我们深入了解 @AliasFor 的源码以理解其在注解内别名的应用。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface AliasFor {

   @AliasFor("attribute")
   String value() default "";

   String attribute() default "";

   Class<? extends Annotation> annotation() default Annotation.class;
}

在这里,我们看到了 @AliasFor 注解自身使用了注解内别名的特性。具体而言,当我们使用这个注解时,@AliasFor(value="xxx")@AliasFor(attribute="xxx") 是等价的。

举例来说,假设有一个注解 @MyAnnotationA

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface MyAnnotationA {
   
   String a1() default "";
}

使用这个注解时,我们可以这样写: @MyAnnotationA(a1="xxx"),表示将属性 a1 设置为 “xxx”。

现在,如果我们想以另一种方式使用这个注解,例如 @MyAnnotationA(a2="xxx"),我们可以通过别名的方式实现。修改 @MyAnnotationA 如下:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface MyAnnotationA {

   @AliasFor("a2")
   String a1() default "";

   @AliasFor("a1")
   String a2() default "";
}

在这个用法中需要注意几点:

  • 组成别名对的每个属性都必须加上注解 @AliasForattribute()value() 属性必须引用该对中另一个属性。
  • 别名属性必须声明相同的返回类型。
  • 别名属性必须声明一个默认值。
  • 别名属性必须声明相同的默认值。

元数据的别名

其次,我们来看元数据的别名的应用。直接以一个例子说明:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@MyAnnotationA
public @interface MyAnnotationB {

   @AliasFor(annotation = MyAnnotationA.class, value = "a2")
   String value() default "";
}

在这个例子中,@MyAnnotationB("vvv")@MyAnnotationA(a2="vvv") 是等价的。这里可以理解为,MyAnnotationBvalue 属性重写了 MyAnnotationAa2 属性,但重新的属性的返回类型必须相同。

在 Spring 框架中,这种用法很常见。例如,以 @Component@Configuration 为例:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {

   @AliasFor(annotation = Component.class)
   String value() default "";

   boolean proxyBeanMethods() default true;
}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Indexed
public @interface Component {

   String value() default "";
}

对于 value 这个属性来说,@Configuration 注解中的值会重写 @Componentvalue 属性值。这可以理解为 @Configuration 注解是 @Component 的子注解。

文章来源:https://blog.csdn.net/weixin_61281255/article/details/135064934
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。