Spring注解@Conditional和@Import使用

男娘i 2023-10-11 15:01 66阅读 0赞

*  在使用注解驱动开发时，@Bean注解是非常常用的，通常标注于方法上，被@Bean标注的方法的返回值会加入到容器中，***id默认是方法名***。但有时，我们在给容器中添加bean时需要动态判断一下，满足了一定条件以后才将这个bean加入到容器中，这就要用到@Conditional注解了。
 *  @Conditional作用在方法上

@Target({
        ElementType.TYPE, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Conditional {
        
        Class<? extends Condition>[] value();
    }

首先这个注解需要Condition类型的数组，Condition是一个接口，所以我们需要实现这个接口。

首先定义一个Person类

@Data
    public class Person {
        
    
        private String name;
        private String age;
    
        public Person(String name, String age) {
        
            this.name = name;
            this.age = age;
        }
    
        public Person() {
        
        }
    
        @Override
        public String toString() {
        
            return "Person{" +
                    "name='" + name + '\'' +
                    ", age='" + age + '\'' +
                    '}';
        }
    }

再编写一个配置类

@Configuration
    public class Config3 {
        
    
        @Bean
        public Person person(){
        
            return new Person("zs","25");
        }
    
        @Bean("james")
        public Person person03(){
        
            return new Person("James","48");
        }

编写测试类，查询容器中有哪些bean

@Test
        public void test04(){
        
            AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Config3.class);
            print(applicationContext);
        }
    
        public static void print(ApplicationContext applicationContext){
        
            for (String s : applicationContext.getBeanDefinitionNames()) {
        
                System.out.println(s);
            }
        }

![在这里插入图片描述][20201120165138542.png_pic_center]  
可以看到，容器中我们定义的两个person和config3这个配置类。

现在有一个需求，person03方法返回的bean需要判断容器中是否有person对象，如果有，则不再继续添加至容器，如果没有，则需要添加至容器。  
则我们可以自定义一个Condition的实现类来判断

public class BeanCondition implements Condition {
        
        @Override
        public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        
            BeanDefinitionRegistry registry = conditionContext.getRegistry();
            //可根据容器中是否有某个bean来动态添加
            boolean containsBeanDefinition = registry.containsBeanDefinition("person");
            return !containsBeanDefinition;
        }
    }

实现其matches方法，如果matches方法的返回值为true，则允许往容器中添加，否则不添加。

修改我们配置类中代码  
![在这里插入图片描述][20201120165550295.png_pic_center]  
继续测试，此时只有一个person  
![在这里插入图片描述][20201120165610178.png_pic_center]

*  @Import注解使用

**第一种用法**

1.  之前的方式给容器中添加User对象

@Configuration
    public class Config5 {
        
    
        @Bean
        public User user(){
        
            return new User();
        }
    
    }

1.  使用@Import方式

@Configuration
    @Import(value = {
        User.class})
    public class Config5 {
        
    
        
    }

可以直接省去写方法体的过程，直接标注要添加组件的类名即可，注意：\*\*\*@Import注解导入的组件的bean的id默认是bean的全类名\*\*\*

测试代码

@Test
        public void test04(){
        
            AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Config5.class);
            print(applicationContext);
        }
    
        public static void print(ApplicationContext applicationContext){
        
            for (String name : applicationContext.getBeanDefinitionNames()) {
        
                System.out.println("key:" + name + "====>" + "value:" + applicationContext.getBean(name));
            }
        }

![在这里插入图片描述][20201120182008766.png_pic_center]  
**第二种用法**

我们可以定义一个类，实现ImportSelector接口，这个接口的selectImports方法会返回一个String数组，数组中的值就是我们要添加的组件的全类名，  
例如现在要将User和Person添加至容器中。

/**
     * 配合Import注解使用， 给容器中返回需要导入的组件的全类名
     * @param
     * @return
     */
    public class MyImportSelector implements ImportSelector {
        
    
        @Override
        public String[] selectImports(AnnotationMetadata annotationMetadata) {
        
            List<String> list = new ArrayList();
            //给容器中导入这些组件
            list.add("com.wk.spring.annotation.beans.User");
            list.add("com.wk.spring.annotation.beans.Person");
            return list.toArray(new String[0]);
        }
    
    }

将导入的Class改为我们自定义的实现类  
![在这里插入图片描述][20201120182300578.png_pic_center]  
![在这里插入图片描述][20201120182316748.png_pic_center]  
**第三种用法**  
我们可以定义一个类，实现ImportBeanDefinitionRegistrar接口，在这个接口的registerBeanDefinitions方法中可以做一些逻辑判断，然后手动将一个bean添加至容器中。例如，判断容器中是否有User类型对象，如果有再给容器中添加一个Person类型对象。

public class MyBeanRegister implements ImportBeanDefinitionRegistrar {
        
    
        /**
         *
         * @param annotationMetadata 当前类的注解信息
         * @param registry IOC容器bean的定义信息
         */
        @Override
        public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry registry) {
        
            /**
             * 可以通过该方法进行手动注册
             */
            //判断容器中是否有Book对象
            boolean contains = registry.containsBeanDefinition("com.wk.spring.annotation.beans.User");
            if (contains){
        
                //注册个User对象
                BeanDefinition beanDefinition = new RootBeanDefinition(Person.class);
                registry.registerBeanDefinition("person",beanDefinition);
            }
    
        }
    }

修改Config5  
![在这里插入图片描述][2020112018262519.png_pic_center]此时我们没有给容器中导入User组件，所以User和Person都没有  
![在这里插入图片描述][20201120182702792.png_pic_center]

修改Config5，给容器中添加一个User组件  
![在这里插入图片描述][20201120182731127.png_pic_center]再次测试，发现User和Person都注册进了容器中  
![在这里插入图片描述][20201120182809528.png_pic_center]

[20201120165138542.png_pic_center]: https://img-blog.csdnimg.cn/20201120165138542.png#pic_center
[20201120165550295.png_pic_center]: https://img-blog.csdnimg.cn/20201120165550295.png#pic_center
[20201120165610178.png_pic_center]: https://img-blog.csdnimg.cn/20201120165610178.png#pic_center
[20201120182008766.png_pic_center]: https://img-blog.csdnimg.cn/20201120182008766.png#pic_center
[20201120182300578.png_pic_center]: https://img-blog.csdnimg.cn/20201120182300578.png#pic_center
[20201120182316748.png_pic_center]: https://img-blog.csdnimg.cn/20201120182316748.png#pic_center
[2020112018262519.png_pic_center]: https://img-blog.csdnimg.cn/2020112018262519.png#pic_center
[20201120182702792.png_pic_center]: https://img-blog.csdnimg.cn/20201120182702792.png#pic_center
[20201120182731127.png_pic_center]: https://img-blog.csdnimg.cn/20201120182731127.png#pic_center
[20201120182809528.png_pic_center]: https://img-blog.csdnimg.cn/20201120182809528.png#pic_center