SpringBoot中@Import注解如何正確使用
簡介
由于最近的項目需求，需要在把配置類導(dǎo)入到容器中，通過查詢，使用@Import注解就能實現(xiàn)這個功能，@Import注解能夠幫我們吧普通配置類（定義為Bean的類）導(dǎo)入到IOC容器中。該注解我們也能過在源碼中經(jīng)?？吹?，是框架層實現(xiàn)的重要注解。下面是我對@import注解的使用做的簡單的總結(jié)。希望能夠幫助各位，同時如果有問題的話，也懇請各位提出寶貴的意見。
一、功能簡介
引入普通類 引入配置類（@Configuration注解修飾的）
引入ImportSelector的實現(xiàn)類
- 靜態(tài)import場景（注入已知的類）
- 動態(tài)import場景（注入指定條件的類）
引入ImportBeanDefinitionRegister的實現(xiàn)類
二、示例
1.引入普通類
@Import類引入普通的類可以幫我們把普通的類定義為Bean
@Import可以添加在@SpringBootApplication(啟動類)、@Configuration(配置類)、@Component(組件類)對應(yīng)的類上。
注意：@RestController、@Service、@Repository都屬于@Component
// 通過@Import注解把普通添加到IOC容器里面去
@Import(ImportAnnotationTest.class)
@SpringBootApplication
public class SpringBootDemoApplication {
public static void main(String[] args) {
ConfigurableApplicationContext context = SpringApplication.run(SpringBootDemoApplication.class, args);
ImportAnnotationTest bean = context.getBean(ImportAnnotationTest.class);
context.close();
}
}
引入配置類（@Configuration注解修飾的）
@Import除了可以把普通的類定義為Bean，@Import還可以引入一個@Configuration修飾的類(引入配置類)，從而把讓配置類生效(配置類下的所有Bean添加到IOC容器里面去)。在自定義starter的時候經(jīng)常會用到。
如果配置類在標(biāo)準(zhǔn)的SpringBoot包結(jié)構(gòu)下(SpringBootApplication啟動類包的根目錄下)。是不需要@Import導(dǎo)入配置類的，SpringBoot自動幫做了。
springboot項目會默認(rèn)將啟動類同目錄及其子目錄下的組件掃描到ioc容器當(dāng)中去，無需手動掃描。
上面的情況一般用于@Configuration配置類不在標(biāo)準(zhǔn)的SpringBoot包結(jié)構(gòu)下面。所以一般在自定義starter的時候用到。
@Configuration(proxyBeanMethods = false)
@Import({ // import了兩個哈
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的使用
*/
}
}
2.引入ImportSelector的實現(xiàn)類
@Import還可以引入ImportSelector的實現(xiàn)類，把ImportSelector接口selectImports()方法返回的Class名稱都定義為bean。
注意selectImports()方法的參數(shù)AnnotationMetadata，通過這個參數(shù)我們可以獲取到@Import標(biāo)注的Class的各種信息。這一點特別有用，用于做一些參數(shù)的傳遞。在SpringBoot的自動化配置和@EnableXXX(功能性注解)都有它的存在。
public interface ImportSelector {
/**
* 用于指定需要注冊為bean的Class名稱
* 當(dāng)在@Configuration標(biāo)注的Class上使用@Import引入了一個ImportSelector實現(xiàn)類后，會把實現(xiàn)類中返回的Class名稱都定義為bean。
*
* 通過其參數(shù)AnnotationMetadata importingClassMetadata可以獲取到@Import標(biāo)注的Class的各種信息，
* 包括其Class名稱，實現(xiàn)的接口名稱、父類名稱、添加的其它注解等信息，通過這些額外的信息可以輔助我們選擇需要定義為Spring bean的Class名稱
*/
String[] selectImports(AnnotationMetadata importingClassMetadata);
}用例如下：
@Configuration
@Import(value = {Person.class,MyImportSelector.class})
public class MyBeanDefinitionRegister {
}配置類中導(dǎo)入實現(xiàn)了ImportSelector 的類
實現(xiàn)了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）靜態(tài)import場景（注入已知的類）
/**
* XXXConfigurationSelector一定要配合@Import使用
*/
public class XXXConfigurationSelector implements ImportSelector {
@Override
@NonNull
public String[] selectImports(@NonNull AnnotationMetadata importingClassMetadata) {
// 把XXX對應(yīng)的類，定義為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）動態(tài)import場景（注入指定條件的類）
我們做一個這樣的功能，我們需要把指定包路徑下所有實現(xiàn)了HelloService接口的類做為bean添加到IOC容器里面去。@ComponentScan注解用來幫我們指定路徑。具體實現(xiàn)如下：
@Configuration
@ComponentScan("com.example.importannotation") // 指定路徑
@Import(DynamicSelectImport.class)
public class DynamicSelectConfig {
}動態(tài)實現(xiàn)將實現(xiàn)某個接口的實現(xiàn)類加載到容器中
public class DynamicSelectImport implements ImportSelector {
/**
* DynamicSelectImport需要配合@Import()注解使用
* <p>
* 通過其參數(shù)AnnotationMetadata importingClassMetadata可以獲取到@Import標(biāo)注的Class的各種信息，
* 包括其Class名稱，實現(xiàn)的接口名稱、父類名稱、添加的其它注解等信息，
* 通過這些額外的信息可以輔助我們選擇需要定義為Spring bean的Class名稱
*/
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
// 第一步：獲取到通過ComponentScan指定的包路徑
String[] basePackages = null;
// @Import注解對應(yīng)的類上的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注解對應(yīng)的類的包名
basePackage = Class.forName(importingClassMetadata.getClassName()).getPackage().getName();
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
basePackages = new String[]{basePackage};
}
// 第2步，知道指定包路徑下所有實現(xiàn)了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();
}接口的實現(xiàn)類
public class DemoaClass implements HelloService{
@Override
public void function() {
}
}public class DemobClass implements HelloService{
@Override
public void function() {
}
}測試結(jié)果如下，兩個實現(xiàn)類都加入到了IOC容器當(dāng)中
3.引入ImportBeanDefinitionRegister的實現(xiàn)類
@Import引入ImportBeanDefinitionRegistrar的實現(xiàn)類。一般用來動態(tài)注冊bean。最重要的一點是還可以對這些BeanDefinition進(jìn)行額外的修改或增強(qiáng)。咱們經(jīng)常使用的mybatis @MapperScan就是用這種方式實現(xiàn)的。
ImportBeanDefinitionRegistrar，我們一般會實現(xiàn)ImportBeanDefinitionRegistrar類，然后配合一個自定義的注解一起使用。而且在注解類上@Import我們的這個實現(xiàn)類。
通過自定義注解的配置，拿到注解的一些元數(shù)據(jù)。然后在ImportBeanDefinitionRegistrar的實現(xiàn)類里面做相應(yīng)的邏輯處理，比如把自定義注解標(biāo)記的類添加到Spring IOC容器里面去。
/**
* ImportBeanDefinitionRegistrar，我們一般會實現(xiàn)ImportBeanDefinitionRegistrar類，然后配合一個自定義的注解一起使用。而且在注解類上@Import我們的這個實現(xiàn)類。
* 通過自定義注解的配置，拿到注解的一些元數(shù)據(jù)。然后在ImportBeanDefinitionRegistrar的實現(xiàn)類里面做相應(yīng)的邏輯處理，比如把自定義注解標(biāo)記的類添加到Spring IOC容器里面去。
*/
public interface ImportBeanDefinitionRegistrar {
/**
* 根據(jù)注解的給定注釋元數(shù)據(jù)，根據(jù)需要注冊bean定義
* @param importingClassMetadata 可以拿到@Import的這個class的Annotation Metadata
* @param registry BeanDefinitionRegistry 就可以拿到目前所有注冊的BeanDefinition，然后可以對這些BeanDefinition進(jìn)行額外的修改或增強(qiáng)。
*/
void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);
}關(guān)于@Import引入ImportBeanDefinitionRegistrar的使用強(qiáng)烈建議大家去看看mybatis關(guān)于@MapperScan的處理源碼。特別有意思。我們也舉一個非常簡單的實例，來讓大家直觀的看到ImportBeanDefinitionRegistrar的使用，比如我們想把指定包路徑下所有添加了BeanIoc注解的類注冊為bean。具體實現(xiàn)如下：
/**
* 我們會把添加了該注解的類作為bean
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @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 {
}下面是一個具體的實現(xiàn)：
@Data
public 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注解就講解完了
到此這篇關(guān)于SpringBoot中@Import注解如何正確使用的文章就介紹到這了,更多相關(guān)SpringBoot @Import內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
SpringBoot使用Validation進(jìn)行參數(shù)校驗的示例詳解
在 SpringBoot項目開發(fā)中，有一個觀點是不要相信前端傳入的參數(shù)，因為你不知道用戶是怎么操作我們接口的，所以在后端也需要對參數(shù)進(jìn)行校驗，這篇文章主要講講我們項目中最常使用的驗證方案2023-05-05
可以清楚的看到在互斥鎖和共享鎖的拿鎖過程中都是有調(diào)用此方法的,而cancelAcquire()方法是寫在finally代碼塊中,并且使用failed標(biāo)志位來控制cancelAcquire()方法的執(zhí)行2023-04-04
Jenkins作為一個開源的自動化服務(wù)器,廣泛用于持續(xù)集成、持續(xù)部署(CI/CD)流程中,這篇文章主要給大家介紹了關(guān)于Jenkins配置前端自動打包部署（若依項目）的相關(guān)資料,文中通過圖文介紹的非常詳細(xì),需要的朋友可以參考下2024-09-09
Java基礎(chǔ)之FileInputStream和FileOutputStream流詳解
這篇文章主要介紹了Java基礎(chǔ)之FileInputStream和FileOutputStream流詳解,文中有非常詳細(xì)的代碼示例,對正在學(xué)習(xí)java基礎(chǔ)的小伙伴們有非常好的幫助,需要的朋友可以參考下2021-04-04
Jmeter內(nèi)置變量vars和props的使用詳解
JMeter是一個功能強(qiáng)大的負(fù)載測試工具,它提供了許多有用的內(nèi)置變量來支持測試過程,其中最常用的變量是 vars 和 props,本文通過代碼示例詳細(xì)給大家介紹了Jmeter內(nèi)置變量vars和props的使用,需要的朋友可以參考下2024-08-08
Java 數(shù)據(jù)結(jié)構(gòu)與算法系列精講之字符串暴力匹配
字符串暴力匹配算法是指在一個長字符串中暴力尋找是否包含某一子串所謂暴力匹配，就是不使用任何其他算法，將兩個字符串中的字符一一進(jìn)行比對2022-02-02
解析XML文件時的嵌套異常SAXParseException問題
這篇文章主要介紹了解析XML文件時的嵌套異常SAXParseException問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-04-04
ConcurrentHashMap是Java中的一種線程安全的哈希表實現(xiàn)，它提供了與Hashtable和HashMap類似的API，是一個高效且可靠的多線程環(huán)境下的哈希表實現(xiàn)，非常適合在并發(fā)場景中使用，本文就簡單介紹一下ConcurrentHashMap原理及使用,需要的朋友可以參考下2023-06-06
IDEA創(chuàng)建SpringBoot父子Module項目的實現(xiàn)
本文主要介紹了IDEA創(chuàng)建SpringBoot父子Module項目的實現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-05-05
這篇文章主要介紹了spring多數(shù)據(jù)源的如何切換,由于是spring項目,可以借助 spring 的DataSource 對象去管理,大體思路是創(chuàng)建一個類實現(xiàn)該接口,替換spring原有的DataSource 對象,文中有詳細(xì)的代碼示例供大家參考,需要的朋友可以參考下2024-06-06