重要的基礎注解@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;
  		}
  	}
  }