首页 > 编程知识 正文

spring 自定义注解,spring 注解实现原理

时间:2023-05-04 04:28:17 阅读:107854 作者:3078

前言: @Conditional是Spring4新提供的注释,用于根据一定条件进行判断,满足条件在容器中注册bean。

@Conditional的定义:

//此注释对类和方法@target(elementtype.type,ElementType.METHOD} ) ) retention ) retentionpolicy.runtime ) document }从代码中可以看出,必须传递Class数组,并且必须继承Condition接口。

publicinterfacecondition { boolean matches (conditioncontextvar 1,AnnotatedTypeMetadata var2); } Condition是一个接口,必须实现matches方法。 如果返回true,则会注入bean,而不会注入false。

示例:首先,创建人员类。

public class person { privatestring name; 私有整合者; 公共字符串获取名称() { return name; }publicvoidsetname(stringname ) { this.name=name; } public Integer getAge () { return age; }公共void setage (integer age ) { this.age=age; }publicperson(stringname,Integer age ) { this.name=name; this.age=age; } @Override public String toString () return ' person ' ' name=' ' name '' ',age=' age ' ' ); }创建BeanConfig类以配置和注入两个人员实例。 一个是撒娇的蜜粉,另一个是zrdfy。

@ configurationpublicclassbeanconfig (@ bean ) name=' bill ' (public person person1) ) returnnewperson ) ' billgates,bill }然后编写测试类以验证是否成功注入了两个Bean。

publicclassconditionaltest { annotationconfigapplicationcontext=newannotationconfigapplicationcontext (benotation ) ontext @Test public void test1 () { MapString,person map=application context.getbeansoftype (person.class ); system.out.println(map; }执行,输出结果如下所示,两个人员实例被注入容器中。

这是一个简单的例子,现在出了问题。 如果我想在根据当前操作系统来注入Person实例,windows上用bill,linux注入linus,怎么实现呢?

这需要@Conditional注释。 首先,我提到了必须实现Condition接口并重写方法以定制match规则。

首先,创建WindowsCondition类。

publicclasswindowsconditionimplementscondition {/* * * @ paramconditioncontex

t:判断条件能使用的上下文环境 * @param annotatedTypeMetadata:注解所在位置的注释信息 * */ @Override public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { //获取ioc使用的beanFactory ConfigurableListableBeanFactory beanFactory = conditionContext.getBeanFactory(); //获取类加载器 ClassLoader classLoader = conditionContext.getClassLoader(); //获取当前环境信息 Environment environment = conditionContext.getEnvironment(); //获取bean定义的注册类 BeanDefinitionRegistry registry = conditionContext.getRegistry(); //获得当前系统名 String property = environment.getProperty("os.name"); //包含Windows则说明是windows系统,返回true if (property.contains("Windows")){ return true; } return false; }}

matches方法的两个参数的意思在注释中讲述了,值得一提的是,conditionContext提供了多种方法,方便获取各种信息,也是SpringBoot中 @ConditonalOnXX注解多样扩展的基础。

接着,创建LinuxCondition类:

public class LinuxCondition implements Condition { @Override public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { Environment environment = conditionContext.getEnvironment(); String property = environment.getProperty("os.name"); if (property.contains("Linux")){ return true; } return false; }}

接着就是使用这两个类了,因为此注解可以标注在方法上和类上,所以分开测试:

标注在方法上:

修改BeanConfig:

@Configurationpublic class BeanConfig { //只有一个类时,大括号可以省略 //如果WindowsCondition的实现方法返回true,则注入这个bean @Conditional({WindowsCondition.class}) @Bean(name = "bill") public Person person1(){ return new Person("Bill Gates",62); } //如果LinuxCondition的实现方法返回true,则注入这个bean @Conditional({LinuxCondition.class}) @Bean("linus") public Person person2(){ return new Person("Linus",48); }}

修改测试方法,使其可以打印当前系统名:

@Test public void test1(){ String osName = applicationContext.getEnvironment().getProperty("os.name"); System.out.println("当前系统为:" + osName); Map<String, Person> map = applicationContext.getBeansOfType(Person.class); System.out.println(map); }

 

运行结果如下:

我是运行在windows上的所以只注入了bill,嗯,没毛病。

接着实验linux下的情况,不能运行在linux下,但可以修改运行时参数:

修改后启动测试方法:

 一个方法只能注入一个bean实例,所以@Conditional标注在方法上只能控制一个bean实例是否注入。

标注在类上:

一个类中可以注入很多实例,@Conditional标注在类上就决定了一批bean是否注入。

我们试一下,将BeanConfig改写,这时,如果WindowsCondition返回true,则两个Person实例将被注入(注意:上一个测试将os.name改为linux,这是我将把这个参数去掉):

@Conditional({WindowsCondition.class})@Configurationpublic class BeanConfig { @Bean(name = "bill") public Person person1(){ return new Person("Bill Gates",62); } @Bean("linus") public Person person2(){ return new Person("Linus",48); }}

结果两个实例都被注入: 

如果将类上的WindowsCondition.class改为LinuxCondition.class,结果应该可以猜到:

结果就是空的,类中所有bean都没有注入。

多个条件类:

前言中说,@Conditional注解传入的是一个Class数组,存在多种条件类的情况。

这种情况貌似判断难度加深了,测试一波,新增新的条件类,实现的matches返回false(这种写死返回false的方法纯属测试用,没有实际意义O(∩_∩)O)

public class ObstinateCondition implements Condition { @Override public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { return false; }}

 BeanConfig修改一下:

@Conditional({WindowsCondition.class,ObstinateCondition.class})@Configurationpublic class BeanConfig { @Bean(name = "bill") public Person person1(){ return new Person("Bill Gates",62); } @Bean("linus") public Person person2(){ return new Person("Linus",48); }}

结果:

现在如果将ObstinateCondition的matches方法返回值改成true,两个bean就被注入进容器:

结论得:

第一个条件类实现的方法返回true,第二个返回false,则结果false,不注入进容器。

第一个条件类实现的方法返回true,第二个返回true,则结果true,注入进容器中。

 

 

 

 

版权声明:该文观点仅代表作者本人。处理文章:请发送邮件至 三1五14八八95#扣扣.com 举报,一经查实,本站将立刻删除。