spring @import注解,spring boot import 注解原理

　　00-1010简介一，功能简介二，例1。介绍公共类2。ImportSelector的实现类介绍(1)静态导入场景(注入已知类)(2)动态导入场景(注入指定条件的类)3。引入ImportBeanDefinitionRegister的实现类。

　　00-1010由于最近的项目需求，我们需要将配置类导入到容器中。这个功能可以通过查询和使用@Import注释来实现。@Import注释可以帮助我们将公共配置类(定义为Bean类)导入IOC容器。这个注释，我们经常可以在源代码中看到，是框架层实现的重要注释。以下是我对@import注释使用的简要总结。希望能帮到你，有什么问题请给我宝贵意见。

　　00-1010介绍普通类和介绍配置类(由@Configuration批注修饰)

　　介绍ImportSelector的实现类。

　　静态导入场景(注入一个已知的类)动态导入场景(注入一个具有指定条件的类)引入ImportBeanDefinitionRegister的实现类。

简介

@Import class引入普通类可以帮助我们将普通类定义为Bean。

　　@Import可以添加到@SpringBootApplication、@Configuration和@Component对应的类中。

　　注意：@RestController、@Service和@Repository都属于@Component。

　　//通过@ Import annotation @ Import(importannotationtest . class)@ spring boot application public类spring boot demo application { public static void main(String[]args){ ConfigurableApplicationContext context=spring application . run(spring boot demo application . class，args)向IOC容器添加普通；ImportAnnotationTest bean=context . get bean(ImportAnnotationTest . class)；context . close()；}}

　　配置类介绍(由@Configuration注释修饰)

　　除了将普通类定义为bean之外，@Import还可以引入一个由@Configuration修饰的类(引入配置类)，从而使配置类生效(将配置类下的所有bean添加到IOC容器中)。它经常在定制启动器时使用。

　　如果配置类在标准SpringBoot包结构下(SpringBootApplication启动类包的根目录)。不需要@Import来导入配置类，SpringBoot会自动完成。

　　默认情况下，springboot项目会将startup similar目录及其子目录中的组件扫描到ioc容器中，无需手动扫描。

　　以上情况一般用于不在标准SpringBoot包结构下的@Configuration配置类。所以通常在定制启动器时使用。

　　@ configuration(proxybean methods=false)@ import({//导入两个ha xxxdataconfiguration . xxxpartoneconfiguration . class，xxxdata configuration。XXXPartTwoConfiguration.class})公共类XXXDataAutoConfiguration {}公共类xxxdata Configuration { @ Configuration(proxybean methods=false)静态类XXXPartOneConfiguration { @ Bean @ ConditionalOnMissingBean公共Bean forioc Bean forioc(){ return new BeanForIoc()；} } @ Configuration(proxybean methods=false)静态cla

　　ss XXXPartTwoConfiguration { /** * 省略了@Bean的使用 */ }}

2.引入ImportSelector的实现类

@Import还可以引入ImportSelector的实现类，把ImportSelector接口selectImports()方法返回的Class名称都定义为bean。

　　注意selectImports()方法的参数AnnotationMetadata，通过这个参数我们可以获取到@Import标注的Class的各种信息。这一点特别有用，用于做一些参数的传递。在SpringBoot的自动化配置和@EnableXXX(功能性注解)都有它的存在。

public interface ImportSelector { /** * 用于指定需要注册为bean的Class名称 * 当在@Configuration标注的Class上使用@Import引入了一个ImportSelector实现类后，会把实现类中返回的Class名称都定义为bean。 * * 通过其参数AnnotationMetadata importingClassMetadata可以获取到@Import标注的Class的各种信息， * 包括其Class名称，实现的接口名称、父类名称、添加的其它注解等信息，通过这些额外的信息可以辅助我们选择需要定义为Spring bean的Class名称 */ String[] selectImports(AnnotationMetadata importingClassMetadata);}

用例如下：

@Configuration@Import(value = {Person.class,MyImportSelector.class})public class MyBeanDefinitionRegister {}

配置类中导入实现了ImportSelector 的类

　　实现了ImportSelector接口的类

public class MyImportSelector implements ImportSelector { @Override public String[] selectImports(AnnotationMetadata importingClassMetadata) { return new String[]{"com.example.importannotation.importSelector.Dog","com.example.importannotation.importSelector.Cat"}; }}

（1）静态import场景（注入已知的类）

/** * XXXConfigurationSelector一定要配合@Import使用 */public class XXXConfigurationSelector implements ImportSelector { @Override @NonNull public String[] selectImports(@NonNull AnnotationMetadata importingClassMetadata) { // 把XXX对应的类，定义为Bean return new String[]{XXX.class.getName()}; }}/** * 注意 @Import(XXXConfigurationSelector.class) */@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Import(XXXConfigurationSelector.class)public @interface EnableXXX {}@SpringBootApplication@EnableXXX // 使之生效public class MyBatisApplication { public static void main(String[] args) { SpringApplication.run(MyBatisApplication.class, args); }}

（2）动态import场景（注入指定条件的类）

我们做一个这样的功能，我们需要把指定包路径下所有实现了HelloService接口的类做为bean添加到IOC容器里面去。@ComponentScan注解用来帮我们指定路径。具体实现如下：

@Configuration@ComponentScan("com.example.importannotation") // 指定路径@Import(DynamicSelectImport.class)public class DynamicSelectConfig {}

动态实现将实现某个接口的实现类加载到容器中

public class DynamicSelectImport implements ImportSelector { /** * DynamicSelectImport需要配合@Import()注解使用 * <p> * 通过其参数AnnotationMetadata importingClassMetadata可以获取到@Import标注的Class的各种信息， * 包括其Class名称，实现的接口名称、父类名称、添加的其它注解等信息， * 通过这些额外的信息可以辅助我们选择需要定义为Spring bean的Class名称 */ @Override public String[] selectImports(AnnotationMetadata importingClassMetadata) { // 第一步：获取到通过ComponentScan指定的包路径 String[] basePackages = null; // @Import注解对应的类上的ComponentScan注解 if (importingClassMetadata.hasAnnotation(ComponentScan.class.getName())) { Map<String, Object> annotationAttributes = importingClassMetadata .getAnnotationAttributes(ComponentScan.class.getName()); basePackages = (String[]) annotationAttributes.get("basePackages"); } if (basePackages == null basePackages.length == 0) { //ComponentScan的basePackages默认为空数组 String basePackage = null; try { // @Import注解对应的类的包名 basePackage = Class.forName(importingClassMetadata.getClassName()).getPackage().getName(); } catch (ClassNotFoundException e) { e.printStackTrace(); } basePackages = new String[]{basePackage}; } // 第2步，知道指定包路径下所有实现了HelloService接口的类 // （ClassPathScanningCandidateComponentProvider的使用） ClassPathScanningCandidateComponentProvider scanner = new ClassPathScanningCandidateComponentProvider(false); TypeFilter helloServiceFilter = new AssignableTypeFilter(HelloService.class); scanner.addIncludeFilter(helloServiceFilter); Set<String> classes = new HashSet<>(); for (String basePackage : basePackages) { scanner.findCandidateComponents(basePackage) .forEach(beanDefinition -> classes.add(beanDefinition.getBeanClassName())); } // 第三步，返回添加到IOC容器里面去 return classes.toArray(new String[0]); }}

接口

public interface HelloService { void function();}

接口的实现类

public class DemoaClass implements HelloService{ @Override public void function() { }}

public class DemobClass implements HelloService{ @Override public void function() { }}

测试结果如下，两个实现类都加入到了IOC容器当中

3.引入ImportBeanDefinitionRegister的实现类

@Import引入ImportBeanDefinitionRegistrar的实现类。一般用来动态注册bean。最重要的一点是还可以对这些BeanDefinition进行额外的修改或增强。咱们经常使用的mybatis @MapperScan就是用这种方式实现的。

　　ImportBeanDefinitionRegistrar，我们一般会实现ImportBeanDefinitionRegistrar类，然后配合一个自定义的注解一起使用。而且在注解类上@Import我们的这个实现类。

　　通过自定义注解的配置，拿到注解的一些元数据。然后在ImportBeanDefinitionRegistrar的实现类里面做相应的逻辑处理，比如把自定义注解标记的类添加到Spring IOC容器里面去。

/** * ImportBeanDefinitionRegistrar，我们一般会实现ImportBeanDefinitionRegistrar类，然后配合一个自定义的注解一起使用。而且在注解类上@Import我们的这个实现类。 * 通过自定义注解的配置，拿到注解的一些元数据。然后在ImportBeanDefinitionRegistrar的实现类里面做相应的逻辑处理，比如把自定义注解标记的类添加到Spring IOC容器里面去。 */public interface ImportBeanDefinitionRegistrar { /** * 根据注解的给定注释元数据，根据需要注册bean定义 * @param importingClassMetadata 可以拿到@Import的这个class的Annotation Metadata * @param registry BeanDefinitionRegistry 就可以拿到目前所有注册的BeanDefinition，然后可以对这些BeanDefinition进行额外的修改或增强。 */ void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);}

关于@Import引入ImportBeanDefinitionRegistrar的使用强烈建议大家去看看mybatis关于@MapperScan的处理源码。特别有意思。我们也举一个非常简单的实例，来让大家直观的看到ImportBeanDefinitionRegistrar的使用，比如我们想把指定包路径下所有添加了BeanIoc注解的类注册为bean。具体实现如下：

/** * 我们会把添加了该注解的类作为bean */@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)@Documentedpublic @interface BeanIoc {}

/** * 定义包路径。(指定包下所有添加了BeanIoc注解的类作为bean) * 注意这里 @Import(BeanIocScannerRegister.class) 的使用 */@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)@Documented@Import(BeanIocScannerRegister.class)public @interface BeanIocScan { String[] basePackages() default "";}

/** * 搜索指定包下所有添加了BeanIoc注解的类，并且把这些类添加到ioc容器里面去 */public class BeanIocScannerRegister implements ImportBeanDefinitionRegistrar, ResourceLoaderAware { private final static String PACKAGE_NAME_KEY = "basePackages"; private ResourceLoader resourceLoader; @Override public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) { //1. 从BeanIocScan注解获取到我们要搜索的包路径 AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(annotationMetadata.getAnnotationAttributes(BeanIocScan.class.getName())); if (annoAttrs == null annoAttrs.isEmpty()) { return; } String[] basePackages = (String[]) annoAttrs.get(PACKAGE_NAME_KEY); // 2. 找到指定包路径下所有添加了BeanIoc注解的类，并且把这些类添加到IOC容器里面去 ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(beanDefinitionRegistry, false); scanner.setResourceLoader(resourceLoader); scanner.addIncludeFilter(new AnnotationTypeFilter(BeanIoc.class)); scanner.scan(basePackages); } @Override public void setResourceLoader(ResourceLoader resourceLoader) { this.resourceLoader = resourceLoader; }}

/** * 使用，使BeanIocScan生效 */@Configuration@BeanIocScan(basePackages = "com.tuacy.collect.mybatis")public class BeanIocScanConfig {}

下面是一个具体的实现：

@Datapublic class Car { private String id; private String name;}

public class MyBeanDefinitionRegister implements ImportBeanDefinitionRegistrar { @Override public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) { RootBeanDefinition catDef = new RootBeanDefinition(Cat.class); RootBeanDefinition carDef = new RootBeanDefinition(Car.class); registry.registerBeanDefinition("cat", catDef); registry.registerBeanDefinition("car", carDef); }}

@Configuration@Import(value = {Person.class, MyBeanDefinitionRegister.class})public class MyImportBeanDefinitionRegistrarConfig {}

　　今天的@Import注解就讲解完了

　　到此这篇关于SpringBoot中@Import注解如何正确使用的文章就介绍到这了,更多相关SpringBoot @Import内容请搜索盛行IT以前的文章或继续浏览下面的相关文章希望大家以后多多支持盛行IT！

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。

目录

简介

2.引入ImportSelector的实现类

（1）静态import场景（注入已知的类）

（2）动态import场景（注入指定条件的类）

3.引入ImportBeanDefinitionRegister的实现类

相关文章阅读