脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → @AliasFor注解的用法

基于@AliasFor注解的用法及说明

 更新时间：2023年02月27日 14:56:53   作者：怪 咖@  
这篇文章主要介绍了基于@AliasFor注解的用法及说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

一、前言

@AliasFor注解基本上都是在spring源码当中出现的，AliasFor是Spring提供的注解，Alias是别名的意思，For是为了，首先我们通过命名可以得出一个结论，他是为了别名而自定义的注解！

Spring中@AliasFor注解的作用有两点：

  • 将同一个注解类的属性设置互为别名
  • 将一个注解上的属性值传递给另一个注解

但这并不是java原生支持的，需要通过Spring中提供的工具类：org.springframework.core.annotation.AnnotationUtils或者org.springframework.core.annotation.AnnotatedElementUtils来解析。AnnotatedElementUtils内部还是调用的AnnotationUtils。

源码如下：它有三个属性value和attribute以及annotation，@AliasFor注解注释了自身，并且value和attribute互为别名，通过源码很容易知道，当我们使用这个注解，@AliasFor(value=“xxx”)和@AliasFor(attribute=“xxx”)是等价的。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface AliasFor {
    @AliasFor("attribute")
    String value() default "";

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

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

二、AnnotationUtils 和 AnnotatedElementUtils

Java 运行时读取Annotation 需要通过反射，Spring 提供AnnotationUtils ， AnnotationElementUtils 用于简化操作，其他特点如下：

  • 查询Meta Annotation（注解的注解）
  • 对@AliasFor 解析，生成指定注解的代理，并赋值。（注：定义其他Annotation 的别名）

Utils 调用涉及的元素：

  • Annotation: Annotation 元数据
  • AnnotatedElement: 被Annotation注解的对象，包括annotation ， class ， method等
  • Method: 类和接口中的方法信息

AnnotationUtils常用方法：

  • getAnnotation: 从某个类获取某个annotation
  • findAnnotation: 从类或方法中查找某个annotation。
  • isAnnotationDeclaredLocally: 验证annotation是否直接注释在类上而不是集成来的。
  • isAnnotationInherited: 验证annotation是否继承于另一个class。
  • getAnnotationAttributes: 获取annotation的所有属性。
  • getValue: 获取指定annotation的值.
  • getDefaultValue: 获取指定annotation或annotation 属性的默认值

AnnotatedElementUtils常用方法：

findMergedAnnotation：这个方法会合并@AliasFor传递的值

三、同一个注解类的属性设置互为别名

1.自定义一个EnableCVS 注解

一共有两个属性

import org.springframework.core.annotation.AliasFor;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface EnableCVS {
	
	// 这里就算是改成@AliasFor(attribute = "address")测试结果也是一样的
    @AliasFor(value = "address")
    String value() default "";

    @AliasFor(value = "value")
    String address() default "";
}

2.创建一个类

然后使用自定义的注解@EnableCVS修饰

@Configuration
@EnableCVS(address = "hhh")
public class AppConfig {

}

3.测试：通过两种方式获取自定义注解当中的属性值

import org.springframework.core.annotation.AnnotationUtils;

public class Test {
    public static void main(String[] args) {
    	// spring提供的
        EnableCVS annotation = AnnotationUtils.findAnnotation(AppConfig.class, EnableCVS.class);
        System.out.println("AnnotationUtils:address:" + annotation.address());
        System.out.println("AnnotationUtils:value:" + annotation.value());
		
		// jdk原生
        EnableCVS annotation1 = AppConfig.class.getAnnotation(EnableCVS.class);
        System.out.println("AppConfig:address:" + annotation1.address());
        System.out.println("AppConfig:value:" + annotation1.value());
    }
}

4.输出结果如下

首先我们设置的注解是@EnableCVS(address = "hhh") ，只设置了address属性，并没有设置value属性，会发现jdk原生方式获取value的时候是拿不到值的，而spring提供的AnnotationUtils却可以获取到，而且获取到的就是address的值！

其实就可以理解为，一旦value值设置了如下注解@AliasFor(value = "address")，也就意味着通过AnnotationUtils来获取value属性值的时候，当value值没有设置的时候，实际上会去获取address属性的值！

@AliasFor(value = "address")
String value() default "";

注意：如果@AliasFor注解当中两个属性互相设置了@AliasFor别名，并且使用自定义注解的时候，同时设置address和value的值，这时候通过AnnotationUtils#findAnnotation(Class<?>, annotationType)获取属性值，则会抛出异常！

示例如下：

@Configuration
@EnableCVS(value = "hhh",address = "222")
public class AppConfig {

}

四、将一个注解上的属性值传递给另一个注解

1.自定义注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Scope("singleton")
@Component
@Inherited
public @interface SingletonComponent {

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

2.声明一个类

使用@SingletonComponent修饰

@SingletonComponent("simpleService")
public class SimpleSingletonService {

}

3.通过AnnotationUtils和AnnotatedElementUtils获取注解

import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Scope;
import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.stereotype.Component;

import java.util.Map;

// 这个注解一定要加，不然getAllAnnocations方法获取不到值
@ComponentScan
public class AnnotationUtilsDemo {
    private static void annotationUtilsDemo() {

        // 获取类注解
        SingletonComponent singletonComponentAnnocation = AnnotationUtils.
                findAnnotation(SimpleSingletonService.class, SingletonComponent.class);

        System.out.println("@SingletonComponent : " + singletonComponentAnnocation);
        System.out.println("@SingletonComponent value: " + AnnotationUtils.getValue(singletonComponentAnnocation, "value"));


        System.out.println("----------------------------------------------");

        Scope scopeAnnocation = AnnotationUtils.findAnnotation(SimpleSingletonService.class, Scope.class);
        System.out.println("@Scope : " + scopeAnnocation);
        System.out.println("@Scope value: " + AnnotationUtils.getValue(scopeAnnocation, "scopeName"));

        System.out.println("----------------------------------------------");

        // 获取@AliasFor Marge 后的注解，直接调用 AnnotationUtils的方法不会组合@AliasFor的值,需要调用AnnotatedElementUtils
        Component componentAnnocation = AnnotatedElementUtils.findMergedAnnotation(SimpleSingletonService.class, Component.class);
        System.out.println("@Component : " + componentAnnocation);
        System.out.println("@Component value: " + AnnotationUtils.getValue(componentAnnocation, "value"));
    }

    private static void getAllAnnocations() {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AnnotationUtilsDemo.class);
        // 获取SingletonComponent注解修饰的类
        Map<String, Object> beans = context.getBeansWithAnnotation(SingletonComponent.class);
        for (Object bean : beans.values()) {
            System.out.println("bean : " + bean);
            // @SingletonComponent 继承了 @Component 所以存在实例,@Component的value值就是通过@AliasFor注解传递过去的
            Component componentAnnocation = AnnotatedElementUtils.findMergedAnnotation(bean.getClass(), Component.class);
            System.out.println(componentAnnocation);
        }
    }

    public static void main(String[] args) {
        AnnotationUtilsDemo.annotationUtilsDemo();

        System.out.println("----------------------------------------------");

        AnnotationUtilsDemo.getAllAnnocations();
    }
}

4.输出结果

Connected to the target VM, address: '127.0.0.1:49763', transport: 'socket'
@SingletonComponent : @com.gzl.cn.springbootnacos.aa.SingletonComponent(value="simpleService")
@SingletonComponent value: simpleService
----------------------------------------------
@Scope : @org.springframework.context.annotation.Scope(proxyMode=DEFAULT, scopeName="singleton", value="singleton")
@Scope value: singleton
----------------------------------------------
@Component : @org.springframework.stereotype.Component(value="simpleService")
@Component value: simpleService
----------------------------------------------
bean : com.gzl.cn.springbootnacos.aa.SimpleSingletonService@1b759d6
@org.springframework.stereotype.Component(value="simpleService")

五、@AliasFor注解应用场景

5.1. @SpringBootApplication源码

如下所示@SpringBootApplication并没有定义新的属性，而是复用其他注解已有的注解属性，并对其进行组合形成新的注解从而到达到便捷的目的。

这样的注解我们可以称之为复合注解。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
    @AliasFor(annotation = EnableAutoConfiguration.class)
    Class<?>[] exclude() default {};

    @AliasFor(annotation = EnableAutoConfiguration.class)
    String[] excludeName() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackages"
    )
    String[] scanBasePackages() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackageClasses"
    )
    Class<?>[] scanBasePackageClasses() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "nameGenerator"
    )
    Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;

    @AliasFor(annotation = Configuration.class)
    boolean proxyBeanMethods() default true;
}

所以在使用SpringBoot 时我们只需要@SpringBootApplication一个注解就能开启自动配置，自动扫描的功能。

而不再需要使下面三个注解来达到同样的目的。

@Configuration
@ComponentSan
@EnnableAutoConfiguration

5.2. @RequestMapping源码

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
    String name() default "";

    @AliasFor("path")
    String[] value() default {};

    @AliasFor("value")
    String[] path() default {};

    RequestMethod[] method() default {};

    String[] params() default {};

    String[] headers() default {};

    String[] consumes() default {};

    String[] produces() default {};
}

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • 基于Java Swing制作一个Pong小游戏

    基于Java Swing制作一个Pong小游戏

    《Pong》是美国雅达利公司（ATARI）开发的视频游戏，该作模拟了两个打乒乓球的人，就是在两条线中间有一个点在动，操纵器就是一个摇杆上有一个按钮的那种。本文就来用Java Swing制作一个Pong小游戏吧
    2023-01-01
  • java编写属于自己的线程池

    java编写属于自己的线程池

    这篇文章主要为大家详细介绍了java编写属于自己的线程池，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-03-03
  • 简单探索 Java 中的惰性计算

    简单探索 Java 中的惰性计算

    这篇文章主要介绍了简单探索 Java 中的惰性计算，惰性计算（尽可能延迟表达式求值）是许多函数式编程语言的特性。惰性集合在需要时提供其元素，无需预先计算它们，这带来了一些好处。,需要的朋友可以参考下
    2019-06-06
  • java模拟ajax访问另一个项目的controller代码实例

    java模拟ajax访问另一个项目的controller代码实例

    今天小编就为大家分享一篇关于java模拟ajax访问另一个项目的controller代码实例，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
    2019-03-03
  • 浅谈Java数据结构之稀疏数组知识总结

    浅谈Java数据结构之稀疏数组知识总结

    今天带大家了解一下Java稀疏数组的相关知识,文中有非常详细的介绍及代码示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-05-05
  • 微信小程序获取手机号的完整实例(Java后台实现)

    微信小程序获取手机号的完整实例(Java后台实现)

    我们在做小程序开发的过程中,经常会涉及到用户身份的问题,最普遍的就是我们要获取用户的手机号码,下面这篇文章主要给大家介绍了关于微信小程序获取手机号的完整实例,后台由Java实现,需要的朋友可以参考下
    2022-06-06
  • 一篇文章读懂Java哈希与一致性哈希算法

    一篇文章读懂Java哈希与一致性哈希算法

    下面是小编为大家分享的关于哈希与一致性哈希算法的一篇文章，结合了大量图片以及文字详细讲解，大家感兴趣的可以自己参考一下
    2021-08-08
  • java 抽象类与接口的区别总结

    java 抽象类与接口的区别总结

    这篇文章主要介绍了java 抽象类与接口的区别总结的相关资料,需要的朋友可以参考下
    2017-02-02
  • Kotlin Coroutines执行异步加载示例详解

    Kotlin Coroutines执行异步加载示例详解

    这篇文章主要给大家介绍了关于Kotlin Coroutines执行异步加载的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。
    2018-01-01
  • Java仿淘宝首页分类列表功能的示例代码

    Java仿淘宝首页分类列表功能的示例代码

    这篇文章主要介绍了仿淘宝分类管理功能的示例代码，具有很好的参考价值，希望对大家有所帮助，也给大家做个参考
    2018-05-05

最新评论