Spring注解@Import

Spring注解@Import

一、@Import注解的作用

1、注解方式注册Bean到容器的几种方式

​ （1）包扫描（@ComponentScan）+组件标注注解（@Controller、@Service、@Repository、@Component），常用于将我们自己写的组件注册到容器

（2）注解@Bean，常用于将我们导入第三方包里面的组件注册到容器

（3）@Import，快速给容器导入一个组件

2、@Import

注解@Import用于给容器快速的导入一个组件，标注于类上

注解@Import的参数是一个类数组，数组中的类可以是普通类、ImportSelector实现类、ImportBeanDefinitionRegistrar实现类

使用注解@Import注册的Bean，Bean的名称为：全类名（包名+类名）

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {

   /**
    * {@link Configuration @Configuration}, {@link ImportSelector},
    * {@link ImportBeanDefinitionRegistrar}, or regular component classes to import.
    */
   Class<?>[] value();

}

二、@Import快速导入Bean案例

1、项目结构

2、Persion和User

public class Persion {
}

public class User {
}

3、Bean注册配置类 BeanConfig

import com.dashu.bean.Persion;
import com.dashu.bean.User;
import org.springframework.context.annotation.*;

/**
 * @Configuration 注解：告诉Spring这是一个配置类
 *
 * 配置类 == 配置文件（beans.xml文件）
 *
 */
@Import({Persion.class, User.class})
@Configuration
public class BeanConfig {
}

4、测试类Main

import com.dashu.config.BeanConfig;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Main {

    public static void main(String[] args) {

        //加载配置类
        AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);

        //获取成功注册到容器中的所有Bean的名称
        String[] beanDefinitionNames = annotationConfigApplicationContext.getBeanDefinitionNames();

        //遍历Bean的名称
        for (String name : beanDefinitionNames){
            System.out.println(name);
        }


    }

}

5、测试结果

三、使用接口ImportSelector的实现类作为注解@Import的参数

1、ImportSelector实现类

import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;

public class MyImportSelector implements ImportSelector {

    /**
     * 该方法返回值不可以返回null，否则会报错
     * 无Bean注册时，可返回一个空数组，切不可返回null
     *
     * @param importingClassMetadata    标注了@Import注解类的所有注解信息
     * @return  返回值为导入到容器中的组件全类名数组
     */
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.dashu.bean.Persion","com.dashu.bean.User"};
    }
}

2、Bean注册配置类 BeanConfig

package com.dashu.config;
import com.dashu.bean.Persion;
import com.dashu.bean.User;
import org.springframework.context.annotation.*;

/**
 * @Configuration 注解：告诉Spring这是一个配置类
 *
 * 配置类 == 配置文件（beans.xml文件）
 *
 */
@Import({MyImportSelector.class})
@Configuration
public class BeanConfig {
}

3、测试结果

四、使用接口ImportBeanDefinitionRegistrar的实现类作为注解@Import的参数

1、ImportBeanDefinitionRegistrar的实现类

import com.dashu.bean.Persion;
import com.dashu.bean.User;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {


    /**
     *
     * @param importingClassMetadata    标注了@Import注解类的所有注解信息
     * @param registry  BeanDefinition注册类，可将需要添加到容器的Bean,通过调用BeanDefinitionRegistry.registerBeanDefinition手工注册
     */
   @Override
   public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

       //判断容器中是否存在name为Persion的Bean，存在返回true，不存在返回false
       boolean persion = registry.containsBeanDefinition("Persion");

       //不存在则手动注册Bean
       if (!persion){

           //根据类获取Bean的信息
           RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Persion.class);

           //第一个参数是Bean的名称，第二个参数是Bean的信息
           registry.registerBeanDefinition("Persion",rootBeanDefinition);
       }
       //判断容器中是否存在name为User的Bean，存在返回true，不存在返回false
       boolean user = registry.containsBeanDefinition("User");

       //不存在则手动注册Bean
       if (!user){

           //根据类获取Bean的信息
           RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(User.class);

           //第一个参数是Bean的名称，第二个参数是Bean的信息
           registry.registerBeanDefinition("User",rootBeanDefinition);
       }


   }

}

2、Bean注册配置类BeanConfig

import org.springframework.context.annotation.*;

/**
 * @Configuration 注解：告诉Spring这是一个配置类
 *
 * 配置类 == 配置文件（beans.xml文件）
 *
 */
@Import({MyImportBeanDefinitionRegistrar.class})
@Configuration
public class BeanConfig {
}

3、测试结果