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

SpringBoot中@Import注解的使用方式

 更新時(shí)間:2022年05月18日 16:19:34   作者:tuacy  
這篇文章主要介紹了SpringBoot中@Import注解的使用方式,文章圍繞主題展開詳細(xì)的內(nèi)容介紹,具有一定的參考價(jià)值,需要的小伙伴可以參考一下

前言:

@Import注解用來幫助我們把一些需要定義為Bean的類導(dǎo)入到IOC容器里面。下面我們就對(duì)@Import注解的使用做一個(gè)簡單的總結(jié)。

一、 @Import引入普通類

@Import引入普通的類可以幫助我們把普通的類定義為Bean。@Import可以添加在@SpringBootApplication(啟動(dòng)類)、@Configuration(配置類)、@Component(組件類)對(duì)應(yīng)的類上。

注意:@RestController、@Service、@Repository都屬于@Component

@SpringBootApplication
@Import(ImportBean.class) // 通過@Import注解把ImportBean添加到IOC容器里面去
public class MyBatisApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyBatisApplication.class, args);
    }
}

二、 @Import引入配置類(@Configuration修飾的類)

@Import除了可以把普通的類定義為Bean,@Import還可以引入一個(gè)@Configuration修飾的類(引入配置類),從而把讓配置類生效(配置類下的所有Bean添加到IOC容器里面去)。在自定義starter的時(shí)候經(jīng)常會(huì)用到。

如果配置類在標(biāo)準(zhǔn)的SpringBoot包結(jié)構(gòu)下(SpringBootApplication啟動(dòng)類包的根目錄下)。是不需要@Import導(dǎo)入配置類的,SpringBoot自動(dòng)幫做了。上面的情況一般用于@Configuration配置類不在標(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)類

@Import還可以引入ImportSelector的實(shí)現(xiàn)類,把ImportSelector接口selectImports()方法返回的Class名稱都定義為bean。注意selectImports()方法的參數(shù)AnnotationMetadata,通過這個(gè)參數(shù)我們可以獲取到@Import標(biāo)注的Class的各種信息。這一點(diǎn)特別有用,用于做一些參數(shù)的傳遞。在SpringBoot的自動(dòng)化配置和@EnableXXX(功能性注解)都有它的存在。

public interface ImportSelector {
    /**
     * 用于指定需要注冊(cè)為bean的Class名稱
     * 當(dāng)在@Configuration標(biāo)注的Class上使用@Import引入了一個(gè)ImportSelector實(shí)現(xiàn)類后,會(huì)把實(shí)現(xiàn)類中返回的Class名稱都定義為bean。
     *
     * 通過其參數(shù)AnnotationMetadata importingClassMetadata可以獲取到@Import標(biāo)注的Class的各種信息,
     * 包括其Class名稱,實(shí)現(xiàn)的接口名稱、父類名稱、添加的其它注解等信息,通過這些額外的信息可以輔助我們選擇需要定義為Spring bean的Class名稱
     */
    String[] selectImports(AnnotationMetadata importingClassMetadata);
}

關(guān)于@Import引入ImportSelector的實(shí)現(xiàn)類的使用,我們舉幾個(gè)簡單的使用場景(實(shí)際開發(fā)肯定比這復(fù)雜的多的)。

3.1 靜態(tài)import場景(注入已知的類)

靜態(tài)場景(注入已知的類),很簡單通過實(shí)現(xiàn)ImportSelector類把我們需要定義為bean的類直接返回就好, 比如下面的例子。我們來一個(gè)EnableXXX的注解,通過XXXConfigurationSelector注入一個(gè)已知的類XXX。

/**
 * XXXConfigurationSelector一定要配合@Import使用
 */
public class XXXConfigurationSelector implements ImportSelector {
    @Override
    @NonNull
    public String[] selectImports(@NonNull AnnotationMetadata importingClassMetadata) {
        // 把XXX對(duì)應(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);
    }

}

3.2 動(dòng)態(tài)import場景(注入指定條件的類)

我們做一個(gè)這樣的功能,我們需要把指定包路徑下所有實(shí)現(xiàn)了HelloService接口的類做為bean添加到IOC容器里面去。@ComponentScan注解用來幫我們指定路徑。具體實(shí)現(xiàn)如下:

public interface HelloService {
    void function();

}
public class DynamicSelectImport implements ImportSelector {
    /**
     * DynamicSelectImport需要配合@Import()注解使用
     * <p>
     * 通過其參數(shù)AnnotationMetadata importingClassMetadata可以獲取到@Import標(biāo)注的Class的各種信息,
     * 包括其Class名稱,實(shí)現(xiàn)的接口名稱、父類名稱、添加的其它注解等信息,通過這些額外的信息可以輔助我們選擇需要定義為Spring bean的Class名稱
     */
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        // 第一步:獲取到通過ComponentScan指定的包路徑
        String[] basePackages = null;
        // @Import注解對(duì)應(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注解對(duì)應(yīng)的類的包名
                basePackage = Class.forName(importingClassMetadata.getClassName()).getPackage().getName();
            } catch (ClassNotFoundException e) {
                e.printStackTrace();
            }
            basePackages = new String[]{basePackage};
        }
        // 第er步,知道指定包路徑下所有實(shí)現(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]);
    }
}
@Configuration
@ComponentScan("com.tuacy.collect.mybatis") // 指定路徑
@Import(DynamicSelectImport.class)
public class DynamicSelectConfig {
}

四、 @Import引入ImportBeanDefinitionRegistrar的實(shí)現(xiàn)類

@Import引入ImportBeanDefinitionRegistrar的實(shí)現(xiàn)類。一般用來動(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類,然后配合一個(gè)自定義的注解一起使用。而且在注解類上@Import我們的這個(gè)實(shí)現(xiàn)類。
 * 通過自定義注解的配置,拿到注解的一些元數(shù)據(jù)。然后在ImportBeanDefinitionRegistrar的實(shí)現(xiàn)類里面做相應(yīng)的邏輯處理,比如把自定義注解標(biāo)記的類添加到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è)非常簡單的實(shí)例,來讓大家直觀的看到ImportBeanDefinitionRegistrar的使用,比如我們想把指定包路徑下所有添加了BeanIoc注解的類注冊(cè)為bean。

具體實(shí)現(xiàn)如下:

/**
 * 我們會(huì)把添加了該注解的類作為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 {
}

到此這篇關(guān)于SpringBoot中@Import注解的使用方式的文章就介紹到這了,更多相關(guān)@Import注解使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • 深入解析Java的Hibernate框架中的持久對(duì)象

    深入解析Java的Hibernate框架中的持久對(duì)象

    Hibernate的持久對(duì)象在數(shù)據(jù)庫數(shù)據(jù)操作中有著重要作用,這里我們就來深入解析Java的Hibernate框架中的持久對(duì)象,首先必須從理解持久化對(duì)象的生命周期開始:
    2016-07-07
  • Java經(jīng)典快排思想以及快排的改進(jìn)講解

    Java經(jīng)典快排思想以及快排的改進(jìn)講解

    今天小編就為大家分享一篇關(guān)于Java經(jīng)典快排思想以及快排的改進(jìn)講解,小編覺得內(nèi)容挺不錯(cuò)的,現(xiàn)在分享給大家,具有很好的參考價(jià)值,需要的朋友一起跟隨小編來看看吧
    2019-01-01
  • java 回調(diào)機(jī)制的實(shí)例詳解

    java 回調(diào)機(jī)制的實(shí)例詳解

    這篇文章主要介紹了java 回調(diào)機(jī)制的實(shí)例詳解的相關(guān)資料,希望通過本文的示例能幫助到大家理解使用回調(diào)機(jī)制,需要的朋友可以參考下
    2017-09-09
  • 通過實(shí)例解析POJO和JavaBean的區(qū)別

    通過實(shí)例解析POJO和JavaBean的區(qū)別

    這篇文章主要介紹了通過實(shí)例解析POJO和JavaBean的區(qū)別,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-07-07
  • 淺談Java設(shè)計(jì)模式之開放封閉原則

    淺談Java設(shè)計(jì)模式之開放封閉原則

    本篇文章主要介紹了淺談Java設(shè)計(jì)模式之開放封閉原則,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧
    2017-03-03
  • 淺談Mybatis中resultType為hashmap的情況

    淺談Mybatis中resultType為hashmap的情況

    這篇文章主要介紹了淺談Mybatis中resultType為hashmap的情況,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧
    2020-12-12
  • Java中JDBC的使用教程詳解

    Java中JDBC的使用教程詳解

    Java語言操作數(shù)據(jù)庫?JDBC本質(zhì):其實(shí)是官方(sun公司)定義的一套操作所有關(guān)系型數(shù)據(jù)庫的規(guī)則,即接口。本文講解了JDBC的使用方法,需要的可以參考一下
    2022-06-06
  • Spring?Boot?Admin?添加報(bào)警提醒和登錄驗(yàn)證功能的具體實(shí)現(xiàn)

    Spring?Boot?Admin?添加報(bào)警提醒和登錄驗(yàn)證功能的具體實(shí)現(xiàn)

    報(bào)警提醒功能是基于郵箱實(shí)現(xiàn)的,當(dāng)然也可以使用其他的提醒功能,如釘釘或飛書機(jī)器人提醒也是可以的,但郵箱報(bào)警功能的實(shí)現(xiàn)成本最低,所以本文我們就來看郵箱的報(bào)警提醒功能的具體實(shí)現(xiàn)
    2022-01-01
  • Java元素排序Comparable與Comparator的區(qū)別

    Java元素排序Comparable與Comparator的區(qū)別

    這篇文章主要介紹了Java元素排序Comparable與Comparator的區(qū)別,二者都是頂級(jí)的接口,但擁有的方法和用法是不同的,下面我們分別來看看具體是怎樣的區(qū)別吧
    2022-05-05
  • 使用JPA+querydsl如何實(shí)現(xiàn)多條件動(dòng)態(tài)查詢

    使用JPA+querydsl如何實(shí)現(xiàn)多條件動(dòng)態(tài)查詢

    這篇文章主要介紹了使用JPA+querydsl如何實(shí)現(xiàn)多條件動(dòng)態(tài)查詢,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2022-03-03

最新評(píng)論