夯实spring(十九):@Import 注解详解

淡淡的烟草味﹌ 2024-03-26 23:13 104阅读 0赞

本文来说一下另外一个注册bean的注解：@Import 。

前面的文章中讲了注解的方式批量注册bean介绍了2种方式：

*  @Configuration结合@Bean注解的方式
 *  @CompontentScan扫描包的方式

#### 1，@Import的使用 ####

@Target({
        ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Import {
        
    //一个Class数组，设置需要导入的类，可以是@Configuration标注的列，可以是ImportSelector接口或者ImportBeanDefinitionRegistrar接口类型的，或者需要导入的普通组件类
        Class<?>[] value();
    }

> @Import注解的作用和xml配置的 标签作用一样，允许通过它引入@Configuration标注的类 ， 引入ImportSelector接口和ImportBeanDefinitionRegistrar接口的实现， @Component注解的普通类。@Import可以用来批量导入需要注册的各种类，如普通的类、配置类，完成普通类和配置类中所有bean的注册。

@Import的value常见的用法

1.  value为普通的类
2.  value为@Configuration标注的类
3.  value为@CompontentScan标注的类
4.  value为ImportBeanDefinitionRegistrar接口类型
5.  value为ImportSelector接口类型
6.  value为DeferredImportSelector接口类型

使用步骤

1.  将@Import标注在类上，设置value参数
2.  将@Import标注的类作为AnnotationConfigApplicationContext构造参数创建AnnotationConfigApplicationContext对象
3.  使用AnnotationConfigApplicationContext对象

**下面通过例子来看一下上面的用法**

##### 1.1，value为普通的类 #####

public class User {
        
    }

public class Car {
        
    }

使用@Import标注

@Import(value = {
        User.class,Car.class})
    public class MyConfig {
        
    }

测试输出：

public class Main {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
            for (String name : context.getBeanDefinitionNames()) {
        
                System.out.println(context.getBean(name));
            }
        }
    }

org.springframework.context.annotation.ConfigurationClassPostProcessor@3e57cd70
    org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@9a7504c
    org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@2c039ac6
    org.springframework.context.event.EventListenerMethodProcessor@587d1d39
    org.springframework.context.event.DefaultEventListenerFactory@58c1670b
    com.chen.MyConfig@6b57696f
    com.chen.User@5bb21b69
    com.chen.Car@6b9651f3

> 可以看到User和Car都被注册到容器了，通过@Import导入的2个类，bean名称为完整的类名

##### 1.2，value为@Configuration标注的配置类 #####

@Configuration
    public class MyConfig2 {
        
        @Bean
        public Car car(){
        
            return new Car();
        }
    }

测试输出：

public class Main {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfig2.class);
            for (String name : context.getBeanDefinitionNames()) {
        
                System.out.println(context.getBean(name));
            }
        }
    }

org.springframework.context.annotation.ConfigurationClassPostProcessor@1b68b9a4
    org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@4f9a3314
    org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@3b2c72c2
    org.springframework.context.event.EventListenerMethodProcessor@491666ad
    org.springframework.context.event.DefaultEventListenerFactory@176d53b2
    com.chen.MyConfig2$$EnhancerBySpringCGLIB$$2b174d6d@971d0d8
    com.chen.Car@51931956

> 可以看到Car注册到容器了。

##### 1.3，value为@CompontentScan标注的类 #####

把User 和 Car 加上注解@Component

@Component
    public class User {
        
    }

@Component
    public class Car {
        
    }

来个组件扫描类，和User 、Car 同一级包

@ComponentScan
    public class MyComponentScan {
        
    }

来个配置类，使用@Import导入@CompontentScan标注的配置类

@Import(MyComponentScan.class)
    public class MyConfig3 {
        
    
    }

测试输出：

public class Main {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfig3.class);
            for (String name : context.getBeanDefinitionNames()) {
        
                System.out.println(context.getBean(name));
            }
        }
    }

org.springframework.context.annotation.ConfigurationClassPostProcessor@2aa5fe93
    org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@5c1a8622
    org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@5ad851c9
    org.springframework.context.event.EventListenerMethodProcessor@6156496
    org.springframework.context.event.DefaultEventListenerFactory@3c153a1
    com.chen.MyConfig3@b62fe6d
    com.chen.Car@13acb0d1
    com.chen.MyConfig2$$EnhancerBySpringCGLIB$$ca2d0f8d@3e3047e6
    com.chen.User@37e547da
    com.chen.MyComponentScan@2b6856dd

##### 1.4，value为ImportSelector接口类型 #####

ImportSelector接口

public interface ImportSelector {
        
    	/**
         * 返回需要导入的类名的数组，可以是任何普通类，配置类（@Configuration、@Bean、@CompontentScan等标注的类）
         * @importingClassMetadata：用来获取被@Import标注的类上面所有的注解信息
         */
        String[] selectImports(AnnotationMetadata importingClassMetadata);
    
        @Nullable
        default Predicate<String> getExclusionFilter() {
        
            return null;
        }
    }

用法：

1.  定义ImportSelector接口实现类，在selectImports返回需要导入的类的名称数组
2.  使用@Import来导入步骤1中定义的类
3.  使用步骤2中@Import标注的类作为AnnotationConfigApplicationContext构造参数创建spring容器
4.  使用AnnotationConfigApplicationContext操作bean

来一个类实现ImportSelector接口，接口方法selectImports返回User和Car

public class MyImportSelector implements ImportSelector {
        
        @Override
        public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        
            return new String[]{
        User.class.getName(),Car.class.getName()};
        }
    }

配置类，使用@Import导入MyImportSelector

@Import(MyImportSelector.class)
    public class MyConfig4 {
        
    
    }

测试输出：

public class Main {
        
        public static void main(String[] args) {
        
            AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfig4.class);
            for (String name : context.getBeanDefinitionNames()) {
        
                System.out.println(context.getBean(name));
            }
        }
    }

org.springframework.context.annotation.ConfigurationClassPostProcessor@43738a82
    org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@c81cdd1
    org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@1fc2b765
    org.springframework.context.event.EventListenerMethodProcessor@75881071
    org.springframework.context.event.DefaultEventListenerFactory@2a70a3d8
    com.chen.MyConfig4@289d1c02
    com.chen.User@22eeefeb
    com.chen.Car@17d0685f