SpringBoot中@Import注解的使用方式
前言:
@Import注解用來(lái)幫助我們把一些需要定義為Bean的類(lèi)導(dǎo)入到IOC容器里面。下面我們就對(duì)@Import注解的使用做一個(gè)簡(jiǎn)單的總結(jié)。
一、 @Import引入普通類(lèi)
@Import引入普通的類(lèi)可以幫助我們把普通的類(lèi)定義為Bean。@Import可以添加在@SpringBootApplication(啟動(dòng)類(lèi))、@Configuration(配置類(lèi))、@Component(組件類(lèi))對(duì)應(yīng)的類(lèi)上。
注意:@RestController、@Service、@Repository都屬于@Component
@SpringBootApplication @Import(ImportBean.class) // 通過(guò)@Import注解把ImportBean添加到IOC容器里面去 public class MyBatisApplication { public static void main(String[] args) { SpringApplication.run(MyBatisApplication.class, args); } }
二、 @Import引入配置類(lèi)(@Configuration修飾的類(lèi))
@Import除了可以把普通的類(lèi)定義為Bean,@Import還可以引入一個(gè)@Configuration修飾的類(lèi)(引入配置類(lèi)),從而把讓配置類(lèi)生效(配置類(lèi)下的所有Bean添加到IOC容器里面去)。在自定義starter的時(shí)候經(jīng)常會(huì)用到。
如果配置類(lèi)在標(biāo)準(zhǔn)的SpringBoot包結(jié)構(gòu)下(SpringBootApplication啟動(dòng)類(lèi)包的根目錄下)。是不需要@Import導(dǎo)入配置類(lèi)的,SpringBoot自動(dòng)幫做了。上面的情況一般用于@Configuration配置類(lèi)不在標(biāo)準(zhǔn)的SpringBoot包結(jié)構(gòu)下面。所以一般在自定義starter的時(shí)候用到。
@Configuration(proxyBeanMethods = false) @Import({ // import了兩個(gè)哈 XXXDataConfiguration.XXXPartOneConfiguration.class, XXXDataConfiguration.XXXPartTwoConfiguration.class }) public class XXXDataAutoConfiguration { } public class XXXDataConfiguration { @Configuration(proxyBeanMethods = false) static class XXXPartOneConfiguration { @Bean @ConditionalOnMissingBean public BeanForIoc beanForIoc() { return new BeanForIoc(); } } @Configuration(proxyBeanMethods = false) static class XXXPartTwoConfiguration { /** * 省略了@Bean的使用 */ } }
三 、@Import引入ImportSelector的實(shí)現(xiàn)類(lèi)
@Import還可以引入ImportSelector的實(shí)現(xiàn)類(lèi),把ImportSelector接口selectImports()方法返回的Class名稱(chēng)都定義為bean。注意selectImports()方法的參數(shù)AnnotationMetadata,通過(guò)這個(gè)參數(shù)我們可以獲取到@Import標(biāo)注的Class的各種信息。這一點(diǎn)特別有用,用于做一些參數(shù)的傳遞。在SpringBoot的自動(dòng)化配置和@EnableXXX(功能性注解)都有它的存在。
public interface ImportSelector { /** * 用于指定需要注冊(cè)為bean的Class名稱(chēng) * 當(dāng)在@Configuration標(biāo)注的Class上使用@Import引入了一個(gè)ImportSelector實(shí)現(xiàn)類(lèi)后,會(huì)把實(shí)現(xiàn)類(lèi)中返回的Class名稱(chēng)都定義為bean。 * * 通過(guò)其參數(shù)AnnotationMetadata importingClassMetadata可以獲取到@Import標(biāo)注的Class的各種信息, * 包括其Class名稱(chēng),實(shí)現(xiàn)的接口名稱(chēng)、父類(lèi)名稱(chēng)、添加的其它注解等信息,通過(guò)這些額外的信息可以輔助我們選擇需要定義為Spring bean的Class名稱(chēng) */ String[] selectImports(AnnotationMetadata importingClassMetadata); }
關(guān)于@Import引入ImportSelector的實(shí)現(xiàn)類(lèi)的使用,我們舉幾個(gè)簡(jiǎn)單的使用場(chǎng)景(實(shí)際開(kāi)發(fā)肯定比這復(fù)雜的多的)。
3.1 靜態(tài)import場(chǎng)景(注入已知的類(lèi))
靜態(tài)場(chǎng)景(注入已知的類(lèi)),很簡(jiǎn)單通過(guò)實(shí)現(xiàn)ImportSelector類(lèi)把我們需要定義為bean的類(lèi)直接返回就好, 比如下面的例子。我們來(lái)一個(gè)EnableXXX的注解,通過(guò)XXXConfigurationSelector注入一個(gè)已知的類(lèi)XXX。
/** * XXXConfigurationSelector一定要配合@Import使用 */ public class XXXConfigurationSelector implements ImportSelector { @Override @NonNull public String[] selectImports(@NonNull AnnotationMetadata importingClassMetadata) { // 把XXX對(duì)應(yīng)的類(lèi),定義為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); } }
3.2 動(dòng)態(tài)import場(chǎng)景(注入指定條件的類(lèi))
我們做一個(gè)這樣的功能,我們需要把指定包路徑下所有實(shí)現(xiàn)了HelloService接口的類(lèi)做為bean添加到IOC容器里面去。@ComponentScan注解用來(lái)幫我們指定路徑。具體實(shí)現(xiàn)如下:
public interface HelloService { void function(); } public class DynamicSelectImport implements ImportSelector { /** * DynamicSelectImport需要配合@Import()注解使用 * <p> * 通過(guò)其參數(shù)AnnotationMetadata importingClassMetadata可以獲取到@Import標(biāo)注的Class的各種信息, * 包括其Class名稱(chēng),實(shí)現(xiàn)的接口名稱(chēng)、父類(lèi)名稱(chēng)、添加的其它注解等信息,通過(guò)這些額外的信息可以輔助我們選擇需要定義為Spring bean的Class名稱(chēng) */ @Override public String[] selectImports(AnnotationMetadata importingClassMetadata) { // 第一步:獲取到通過(guò)ComponentScan指定的包路徑 String[] basePackages = null; // @Import注解對(duì)應(yīng)的類(lèi)上的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默認(rèn)為空數(shù)組 String basePackage = null; try { // @Import注解對(duì)應(yīng)的類(lèi)的包名 basePackage = Class.forName(importingClassMetadata.getClassName()).getPackage().getName(); } catch (ClassNotFoundException e) { e.printStackTrace(); } basePackages = new String[]{basePackage}; } // 第er步,知道指定包路徑下所有實(shí)現(xiàn)了HelloService接口的類(lèi)(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]); } } @Configuration @ComponentScan("com.tuacy.collect.mybatis") // 指定路徑 @Import(DynamicSelectImport.class) public class DynamicSelectConfig { }
四、 @Import引入ImportBeanDefinitionRegistrar的實(shí)現(xiàn)類(lèi)
@Import引入ImportBeanDefinitionRegistrar的實(shí)現(xiàn)類(lèi)。一般用來(lái)動(dòng)態(tài)注冊(cè)bean。最重要的一點(diǎn)是還可以對(duì)這些BeanDefinition進(jìn)行額外的修改或增強(qiáng)。咱們經(jīng)常使用的mybatis @MapperScan就是用這種方式實(shí)現(xiàn)的。
/** * ImportBeanDefinitionRegistrar,我們一般會(huì)實(shí)現(xiàn)ImportBeanDefinitionRegistrar類(lèi),然后配合一個(gè)自定義的注解一起使用。而且在注解類(lèi)上@Import我們的這個(gè)實(shí)現(xiàn)類(lèi)。 * 通過(guò)自定義注解的配置,拿到注解的一些元數(shù)據(jù)。然后在ImportBeanDefinitionRegistrar的實(shí)現(xiàn)類(lèi)里面做相應(yīng)的邏輯處理,比如把自定義注解標(biāo)記的類(lèi)添加到Spring IOC容器里面去。 */ public interface ImportBeanDefinitionRegistrar { /** * 根據(jù)注解的給定注釋元數(shù)據(jù),根據(jù)需要注冊(cè)bean定義 * @param importingClassMetadata 可以拿到@Import的這個(gè)class的Annotation Metadata * @param registry BeanDefinitionRegistry 就可以拿到目前所有注冊(cè)的BeanDefinition,然后可以對(duì)這些BeanDefinition進(jìn)行額外的修改或增強(qiáng)。 */ void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry); }
關(guān)于@Import引入ImportBeanDefinitionRegistrar的使用強(qiáng)烈建議大家去看看mybatis關(guān)于@MapperScan的處理源碼。特別有意思。我們也舉一個(gè)非常簡(jiǎn)單的實(shí)例,來(lái)讓大家直觀的看到ImportBeanDefinitionRegistrar的使用,比如我們想把指定包路徑下所有添加了BeanIoc注解的類(lèi)注冊(cè)為bean。
具體實(shí)現(xiàn)如下:
/** * 我們會(huì)把添加了該注解的類(lèi)作為bean */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @Documented public @interface BeanIoc { } /** * 定義包路徑。(指定包下所有添加了BeanIoc注解的類(lèi)作為bean) * 注意這里 @Import(BeanIocScannerRegister.class) 的使用 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @Documented @Import(BeanIocScannerRegister.class) public @interface BeanIocScan { String[] basePackages() default ""; } /** * 搜索指定包下所有添加了BeanIoc注解的類(lèi),并且把這些類(lèi)添加到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注解的類(lèi),并且把這些類(lèi)添加到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 { }
到此這篇關(guān)于SpringBoot中@Import注解的使用方式的文章就介紹到這了,更多相關(guān)@Import注解使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- SpringBoot @Import與@Conditional注解使用詳解
- SpringBoot超詳細(xì)講解@Enable*注解和@Import
- SpringBoot中@Import注解如何正確使用
- SpringBoot2底層注解@Import用法詳解
- 淺析SpringBoot2底層注解@Conditional@ImportResource
- SpringBoot如何讀取xml配置bean(@ImportResource)
- 詳解SpringBoot開(kāi)發(fā)使用@ImportResource注解影響攔截器
- Springboot @Import 詳解
- SpringBoot自動(dòng)裝配之@Import深入講解
相關(guān)文章
深入解析Java的Hibernate框架中的持久對(duì)象
Hibernate的持久對(duì)象在數(shù)據(jù)庫(kù)數(shù)據(jù)操作中有著重要作用,這里我們就來(lái)深入解析Java的Hibernate框架中的持久對(duì)象,首先必須從理解持久化對(duì)象的生命周期開(kāi)始:2016-07-07Java經(jīng)典快排思想以及快排的改進(jìn)講解
今天小編就為大家分享一篇關(guān)于Java經(jīng)典快排思想以及快排的改進(jìn)講解,小編覺(jué)得內(nèi)容挺不錯(cuò)的,現(xiàn)在分享給大家,具有很好的參考價(jià)值,需要的朋友一起跟隨小編來(lái)看看吧2019-01-01通過(guò)實(shí)例解析POJO和JavaBean的區(qū)別
這篇文章主要介紹了通過(guò)實(shí)例解析POJO和JavaBean的區(qū)別,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07淺談Java設(shè)計(jì)模式之開(kāi)放封閉原則
本篇文章主要介紹了淺談Java設(shè)計(jì)模式之開(kāi)放封閉原則,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-03-03淺談Mybatis中resultType為hashmap的情況
這篇文章主要介紹了淺談Mybatis中resultType為hashmap的情況,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-12-12Spring?Boot?Admin?添加報(bào)警提醒和登錄驗(yàn)證功能的具體實(shí)現(xiàn)
報(bào)警提醒功能是基于郵箱實(shí)現(xiàn)的,當(dāng)然也可以使用其他的提醒功能,如釘釘或飛書(shū)機(jī)器人提醒也是可以的,但郵箱報(bào)警功能的實(shí)現(xiàn)成本最低,所以本文我們就來(lái)看郵箱的報(bào)警提醒功能的具體實(shí)現(xiàn)2022-01-01Java元素排序Comparable與Comparator的區(qū)別
這篇文章主要介紹了Java元素排序Comparable與Comparator的區(qū)別,二者都是頂級(jí)的接口,但擁有的方法和用法是不同的,下面我們分別來(lái)看看具體是怎樣的區(qū)別吧2022-05-05使用JPA+querydsl如何實(shí)現(xiàn)多條件動(dòng)態(tài)查詢(xún)
這篇文章主要介紹了使用JPA+querydsl如何實(shí)現(xiàn)多條件動(dòng)態(tài)查詢(xún),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03