Spring @AliasFor用法

同注解内属性互为alias

  • @AliasFor的两端必须对称使用,如下name和value互为alias
  • 且两端的类型、默认值必须相同,
  • 在实际使用时仅赋值一个属性即可,若同时设置多个属性则要求值必须都相同
  • 通过Spring AnnotationUtils工具解析注解支持@AliasFor,直接使用Java Reflect机制不支持@AliasFor
java 复制代码
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno {
	//注:@AliasFor的两端必须对称使用,如下name和value互为alias
	//且两端的类型、默认值必须相同,
	//在实际使用时仅赋值一个属性即可,若同时设置多个属性则要求值必须都相同
    @AliasFor("value")
    String name() default "biz";

    @AliasFor("name")
    String value() default "biz";
}

如下为AOP 切面内解析注解的示例,原生Java反射不支持解析@AliasFor,需要通过Spring工具类AnnotationUtils进行支持:

java 复制代码
@Aspect
@Component
public class MyAnnoAspect {

    @Pointcut("@annotation(com.luo.MyAnno)")
    public void myAnnoCut() {
    }

 
    @Before("myAnnoCut()")
    public Object before(ProceedingJoinPoint joinPoint) throws Throwable {
       MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
       //不支持:直接使用Java Reflect机制不支持@AliasFor
       MyAnno myAnno1 = methodSignature.getMethod().getAnnotation(MyAnno.class)
       //支持:通过Spring AnnotationUtils工具解析注解支持@AliasFor
       //即name和value值相同
       MyAnno myAnno2 = AnnotationUtils.getAnnotation(methodSignature.getMethod(), MyAnno.class);
    }
   //...
}

覆盖元注解属性

  • 当前注解需在定义处引用元注解
  • 当前注解属性作为元注解的属性的别名,标注了当前注解即相当于同时亦标注了元注解
  • 当前注解属性的默认值可以和元注解属性的默认值不同
  • AnnotationUtils.getAnnotation支持解析元注解,但是不支持@AliasFor
  • AnnotatedElementUtils.getMergedAnnotation支持解析元注解,并且支持@AliasFor
java 复制代码
//当前注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@MyMetaAnno //引用元注解
public @interface MyAnno {
    @AliasFor("value")
    String name() default "biz";

    @AliasFor("name")
    String value() default "biz";
	
	//当前注解内属性作为元注解属性的别名,即当前属性值会自动赋值到元注解相应属性中
	//注:当前注解属性的默认值可以和元注解属性的默认值不同
    @AliasFor(attribute = "keyAttr", annotation = MyMetaAnno.class)
    String keyAttr() default "myBizid";
}


//此为元注解(可作用于其他注解定义上)
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyMetaAnno {  
    String keyAttr() default "id";
}

如下为AOP 切面内解析注解的示例,AnnotationUtils.getAnnotation支持解析元注解,但是不支持@AliasFor,需通过AnnotatedElementUtils.getMergedAnnotation支持解析元注解且支持@AliasFor:

java 复制代码
@Aspect
@Component
public class MyAnnoAspect {

    @Pointcut("@annotation(com.luo.MyAnno)")
    public void myAnnoCut() {
    }

 
    @Before("myAnnoCut()")
    public Object before(ProceedingJoinPoint joinPoint) throws Throwable {
       MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();

       //通过Spring AnnotationUtils工具解析注解支持@AliasFor,
       //支持同注解内属性互为alias,即name和value值相同
       MyAnno myAnno = AnnotationUtils.getAnnotation(methodSignature.getMethod(), MyAnno.class);
		
	   //通过Spring AnnotatedElementUtils工具解析元注解,
	   //支持元注解@AliasFor属性,即MyAnno.keyAttr会自动赋值给MyMetaAnno.keyAttr,
	   //仅在切点方法上标注了MyAnno注解,但可以通过AnnotatedElementUtils解析MyAnno的关联的元注解MyMetaAnno,并支持属性的覆盖
       MyMetaAnno myMetaAnno = AnnotatedElementUtils.getMergedAnnotation(methodSignature.getMethod(), MyMetaAnno.class);
    }

   //...
}

参考:
https://www.cnblogs.com/ken-jl/p/9705502.html
https://www.baeldung.com/spring-aliasfor-annotation

相关推荐
草莓base5 分钟前
【手写一个spring】spring源码的简单实现--bean对象的创建
java·spring·rpc
乌啼霜满天24933 分钟前
Spring 与 Spring MVC 与 Spring Boot三者之间的区别与联系
java·spring boot·spring·mvc
Elaine2023911 小时前
零碎04 MybatisPlus自定义模版生成代码
java·spring·mybatis
.生产的驴3 小时前
SpringCloud OpenFeign用户转发在请求头中添加用户信息 微服务内部调用
spring boot·后端·spring·spring cloud·微服务·架构
码蜂窝编程官方6 小时前
【含开题报告+文档+PPT+源码】基于SpringBoot+Vue的虎鲸旅游攻略网的设计与实现
java·vue.js·spring boot·后端·spring·旅游
AuroraI'ncoding7 小时前
时间请求参数、响应
java·后端·spring
计算机毕设指导69 小时前
基于 SpringBoot 的作业管理系统【附源码】
java·vue.js·spring boot·后端·mysql·spring·intellij-idea
ExiFengs10 小时前
实际项目Java1.8流处理, Optional常见用法
java·开发语言·spring
瓜牛_gn11 小时前
依赖注入注解
java·后端·spring
一元咖啡12 小时前
SpringCloud Gateway转发请求到同一个服务的不同端口
spring·spring cloud·gateway