SpringBoot教程(2) @Import和ImportSelector的使用

一、@Import的作用

@Import修饰在类名上，给容器中自动创建出对应class类型的组件、默认组件的名字就是$全类名$。

二、@Import的使用

创建2个类

public class PiggUser {
    
    

    private String name;

    private Integer age;

    public PiggUser() {
    
    
        System.out.println("初始化了PiggUser()");
    }
    //省略get，set
}

public class PiggPet {
    
    

    private String name;

    private Integer age;

    public PiggPet() {
    
    
        System.out.println("初始化了PiggPet()");
    }
    //省略get，set
}

创建一个有@Configuration的类

@Configuration
@Import({
    
    PiggUser.class, PiggPet.class})
public class PiggMainConfig {
    
    
	System.out.println("初始化了PiggMainConfig()");
}

运行结果

初始化了PiggMainConfig()
初始化了PiggUser()
初始化了PiggPet()

三、@Import+ImportSelector的使用

ImportSelector是一个接口，它定义如下：

public interface ImportSelector {
    
    

	String[] selectImports(AnnotationMetadata importingClassMetadata);

	@Nullable
	default Predicate<String> getExclusionFilter() {
    
    
		return null;
	}
}

通常我们要定义一个类实现ImportSelector ，它的selectImports方法返回的是String[]，就是需要初始化的类的全类名数组。

public class MyImportSelector implements ImportSelector {
    
    

    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    
    
        return new String[]{
    
    "info.pigg.dict.entity.PiggPet","info.pigg.dict.entity.PiggUser"};
    }
}

修改PiggMainConfig ，改成@Import(MyImportSelector.class)

@Configuration
@Import(MyImportSelector.class)
public class PiggMainConfig {
    
    

    public PiggMainConfig() {
    
    
        System.out.println("初始化了PiggMainConfig()");
    }
}

运行结果如下：

初始化了PiggMainConfig()
初始化了PiggUser()
初始化了PiggPet()

在SpringBoot中典型的ImportSelector用例就是EnableAutoConfiguration注解：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    
    
///省略
}

@AutoConfigurationPackage代码如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
    
    
///省略
}

下面代码是获取SpringBoot主启动类Application类所在包，这样SpringBoot会加载这个包和其子包所有组件。

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
    
    

	@Override
	public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
    
    
		register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));
	}

	@Override
	public Set<Object> determineImports(AnnotationMetadata metadata) {
    
    
		return Collections.singleton(new PackageImports(metadata));
	}

}

AutoConfigurationImportSelector类selectImports方法会获取META-INF文件夹下spring.factories文件里的org.springframework.boot.autoconfigure.EnableAutoConfiguration配置的值。