欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

SpringBoot中@Import注解如何正確使用

 更新時間：2022年06月17日 09:12:34   作者：奇點_97  
這篇文章主要介紹了SpringBoot中@Import注解的使用方式，文章圍繞主題展開詳細(xì)的內(nèi)容介紹，具有一定的參考價值，需要的小伙伴可以參考一下

簡介

由于最近的項目需求，需要在把配置類導(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)文章

  • 大廠面試?？?快速排序冒泡排序算法

    大廠面試?？?快速排序冒泡排序算法

    快速排序由于排序效率在同為O(N*logN)的幾種排序方法中效率較高，因此經(jīng)常被采用，再加上快速排序思想----分治法也確實實用，因此很多軟件公司的筆試面試，包括像BAT、字節(jié)、美團(tuán)等知名IT公司都喜歡考查快速排序原理和手寫源碼
    2021-08-08
  • scala 匿名函數(shù)案例詳解

    scala 匿名函數(shù)案例詳解

    Scala支持一級函數(shù)，函數(shù)可以用函數(shù)文字語法表達(dá)，即(x：Int)=> x + 1，該函數(shù)可以由一個叫作函數(shù)值的對象來表示，這篇文章主要介紹了scala 匿名函數(shù)詳解,需要的朋友可以參考下
    2023-03-03
  • Java設(shè)置String字符串編碼方法詳解

    Java設(shè)置String字符串編碼方法詳解

    因為String字符串很常用，所以我們在使用它的過程中，可能會面臨各種問題，比如”中文亂碼“問題等，那么為什么中文會亂碼？本文將給大家介紹一下Java如何設(shè)置String字符串編碼，來避免和解決這一常見問題,需要的朋友可以參考下
    2023-05-05
  • 利用java、js或mysql計算高德地圖中兩坐標(biāo)之間的距離

    利用java、js或mysql計算高德地圖中兩坐標(biāo)之間的距離

    最近因為工作的需求，需要計算出高德地圖中兩個坐標(biāo)的距離，通過查找相關(guān)資料發(fā)現(xiàn)了多種實現(xiàn)的方法，下面這篇文章主要給大家介紹了關(guān)于利用java、js或mysql計算高德地圖中兩坐標(biāo)之間距離的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，需要的朋友可以參考下。
    2017-10-10
  • 解決springcloud集成nacos遇到的問題

    解決springcloud集成nacos遇到的問題

    這篇文章介紹了如何解決springcloud集成nacos遇到的問題，文章中有詳細(xì)的代碼示例，需要的朋友可以參考一下
    2023-04-04
  • 電腦上安裝多個JDK版本時該如何自由切換(詳細(xì)圖文)

    電腦上安裝多個JDK版本時該如何自由切換(詳細(xì)圖文)

    我們在學(xué)習(xí)的過程中經(jīng)常用到不同的jdk版本,那么如何在一臺電腦上同時安裝多個jdk版本并進(jìn)行切換呢,這篇文章主要給大家介紹了關(guān)于電腦上安裝多個JDK版本時該如何自由切換的相關(guān)資料,需要的朋友可以參考下
    2023-10-10
  • Struts2學(xué)習(xí)筆記(5)-參數(shù)傳遞方法

    Struts2學(xué)習(xí)筆記(5)-參數(shù)傳遞方法

    本文主要介紹Struts2中參數(shù)傳遞方法，希望能給大家做一個參考。
    2016-06-06
  • Java垃圾回收finalize()作用詳解

    Java垃圾回收finalize()作用詳解

    這篇文章主要為大家詳細(xì)介紹了Java垃圾回收finalize()作用，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下
    2015-09-09
  • 詳解java Collections.sort的兩種用法

    詳解java Collections.sort的兩種用法

    這篇文章主要介紹了詳解java Collections.sort的兩種用法,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2020-07-07
  • SpringBoot2.x集成Dozer的示例代碼

    SpringBoot2.x集成Dozer的示例代碼

    本文主要介紹了SpringBoot2.x集成Dozer的示例代碼，文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下
    2021-08-08

最新評論