重要的基础注解@import

@import是Spring中非常重要的基础注解，利用它可以高度自由的定制bean装载规则和注册逻辑。

在第三方模块和Spring进行整合场景下使用非常频繁，比如EnableAsync/EnableBatchProcessing和EnableCaching都是通过Import来生效的。

它的作用总结来说有下面4种：

• 导入容器@Configuration修饰的配置bean
• 实例ImportBeanDefinitionRegistrar的实现类，调用其registerBeanDefinitions方法
• 实例ImportSelector的实现类，调用其selectImports方法；
• 可以导入一个普通的java对象，spring4.2版本之后才支持

使用举例

@Data
public class A {
    private String name = "a";
}

@Data
public class Boy {
    private String name = "boy";
}

public class BoyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.sail.appstart.myimport.Boy"};
    }
}

@Data
public class Dog {
    private String name = "dog";
}

public class DogBeanDefinition implements ImportBeanDefinitionRegistrar {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        RootBeanDefinition beanDefinition = new RootBeanDefinition(Dog.class);
        registry.registerBeanDefinition("Dog22", beanDefinition);
    }
}
           

这里使用@import导入上面的三个类，效果就是将A,Boy，Dog三个java对象注入到spring容器中，当然也就可以通过@Autowired使用这三个bean。

@Retention(RetentionPolicy.RUNTIME)
@Import({A.class, BoyImportSelector.class, DogBeanDefinition.class})
public @interface EnableAppConfig {
}
           

@EnableAppConfig // 注意要声明这个注解，才会生效注解上面的@Import
@Component
public class TestImport {
    @Autowired
    private A a;

    @Autowired
    private Boy boy;

    @Autowired
    private Dog dog;

    @PostConstruct
    public void init() {
        System.out.println(a.getName());
        System.out.println(boy.getName());
        System.out.println(dog.getName());
    }
}
           

使用场景

虽然声明bean的功能可以由@Component或者@bean来实现，但是利用@Import可以控制类的注入时机，如上面只有添加@EnableAppConfig，才会导入这些bean。

所以经常出现在一些框架的自动配置里，如

• Spring-Mybatis的@MapperScan注解，是由@Import注解所修饰，并注入了MapperScannerRegistrar类：会去扫描用户指定的基础包，然后提取mapper产生代理类，最后注册到容器当中

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(MapperScannerRegistrar.class)
public @interface MapperScan {
 、、、
}

public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {

  private ResourceLoader resourceLoader;

  @Override
  public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
  	 List<String> basePackages = new ArrayList<String>();
    for (String pkg : annoAttrs.getStringArray("value")) {
      if (StringUtils.hasText(pkg)) {
        basePackages.add(pkg);
      }
    }
    for (String pkg : annoAttrs.getStringArray("basePackages")) {
      if (StringUtils.hasText(pkg)) {
        basePackages.add(pkg);
      }
    }
    for (Class<?> clazz : annoAttrs.getClassArray("basePackageClasses")) {
      basePackages.add(ClassUtils.getPackageName(clazz));
    }
    scanner.registerFilters();
    scanner.doScan(StringUtils.toStringArray(basePackages));
  }
           

• @EnableCaching缓存开启

  添加@EnableCaching 开启后，才会去导入相应的包。

  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.RUNTIME)
  @Documented
  @Import(CachingConfigurationSelector.class)
  public @interface EnableCaching {
      
  }
  
  public class CachingConfigurationSelector extends AdviceModeImportSelector<EnableCaching> {
      @Override
  	public String[] selectImports(AdviceMode adviceMode) {
  		switch (adviceMode) {
  			case PROXY:
  				return getProxyImports();
  			case ASPECTJ:
  				return getAspectJImports();
  			default:
  				return null;
  		}
  	}
  }