如何實現(xiàn)基于ImportBeanDefinitionRegistrar和FactoryBean動態(tài)注入Bean到Spring容器中

這篇文章主要講解了“如何實現(xiàn)基于ImportBeanDefinitionRegistrar和FactoryBean動態(tài)注入Bean到Spring容器中”，文中的講解內(nèi)容簡單清晰，易于學(xué)習(xí)與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學(xué)習(xí)“如何實現(xiàn)基于ImportBeanDefinitionRegistrar和FactoryBean動態(tài)注入Bean到Spring容器中”吧！

創(chuàng)新互聯(lián)專注為客戶提供全方位的互聯(lián)網(wǎng)綜合服務(wù)，包含不限于網(wǎng)站制作、做網(wǎng)站、汝城網(wǎng)絡(luò)推廣、微信小程序、汝城網(wǎng)絡(luò)營銷、汝城企業(yè)策劃、汝城品牌公關(guān)、搜索引擎seo、人物專訪、企業(yè)宣傳片、企業(yè)代運營等，從售前售中售后，我們都將竭誠為您服務(wù)，您的肯定，是我們最大的嘉獎；創(chuàng)新互聯(lián)為所有大學(xué)生創(chuàng)業(yè)者提供汝城建站搭建服務(wù)，24小時服務(wù)熱線：028-86922220，官方網(wǎng)址：jinyejixie.com

一、背景

我們自己開發(fā)了一個第三方的jar包，想和Spring整合起來，并注入到Spring容器中。自己的jar包中，需要加入到Spring容器的類上都加入了一個自定義注解@CustomImport(beanName=""),beanName屬性的值表示需要注入到Spring容器中的名字。

二、實現(xiàn)方案

1、基于@ComponentScan注解實現(xiàn)

使用此種方案比較簡單，直接使用@ComponentScan(includeFilters = {@ComponentScan.Filter(value = CustomImport.class)})即可將我們自定義的注解加入到Spring容器中。此種方案略。

2、基于ImportBeanDefinitionRegistrar和FactoryBean實現(xiàn)

1、實現(xiàn)此接口(ImportBeanDefinitionRegistrar)，可以將我們自己的BeanDefinition對象加到BeanDefinitionRegistry中，等待后續(xù)Spring初始化對象。

注：

1. 我們可以從自定義的注解中獲取到一些屬性，然后來個性化我們要初始化的Bean是什么樣的。

2. 實現(xiàn)ImportBeanDefinitionRegistrar的類配合上@Configuration和@Import注解，可以在程序啟動的時候加載這個類。

2、實現(xiàn)此接口(FactoryBean)，可以讓我們自定義實例化出我們要構(gòu)建的Bean。

3、注意

可能有些人會說，我用@ComponentScan就可以搞定的事情，為何還要選擇基于第二種方法實現(xiàn)，這個不是多此一舉嗎？這個其實我主要是記錄這樣的一個思路。比如：Mybatis和Spring整合后，只需要申明一個@Mapper就可以自定加入到Spring管理中(MapperScannerRegistrar)，那么這是怎么實現(xiàn)的呢？應(yīng)該是和上方的方案2類似。

三、實現(xiàn)步驟

1、自定義一個注解 CustomImport，被此注解標(biāo)注的類，表示需要加入到Spring容器中。

CustomImport 注解可以增加一些額外的屬性，比如beanName表示注入到Spring容器時,bean的名字。

2、寫一個類實現(xiàn)CustomImportFactoryBean，表示如何實例化出CustomImport注解標(biāo)注的類。

構(gòu)造化對象。
構(gòu)造出的對象需要自己完成初始化操作，如果需要用到Spring的里的對象，可以獲取到ApplicationContext然后獲取注入。

3、寫一個類實現(xiàn)ImportBeanDefinitionRegistrar，掃描出所有的CustomImport的類，然后構(gòu)造出BeanDefinition,加入到Spring容器中。

構(gòu)造BeanDefinition時的BeanClass屬性需要指定上一個的CustomImportFactoryBean的class。
ClassPathBeanDefinitionScanner可以掃描包。

4、自定義一個注解EnableCustomImport，啟動類上加入此注解后，實現(xiàn)ImportBeanDefinitionRegistrar的調(diào)用。

此注解上需要使用@Import標(biāo)注

1、自定義注解`CustomImport`

/**
 * 此注解標(biāo)注的類也會自動加入到 Spring 管理中。
 *
 * @author huan.fu 2021/4/14 - 上午9:23
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CustomImport {
    /**
     * 這個bean注入到Spring容器中的名字
     */
    String beanName();
}

2、實現(xiàn)`CustomImportFactoryBean`構(gòu)建對象

package com.huan.study.framewrok;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;

/**
 * 工廠Bean，用于構(gòu)建 CustomImport 注解標(biāo)注的類，如何進(jìn)行實例化
 *
 * @author huan.fu 2021/4/14 - 上午9:44
 */
public class CustomImportFactoryBean implements FactoryBean<object>, ApplicationContextAware {

    private Class<!--?--> type;
    private String beanName;
    private ApplicationContext applicationContext;

    /**
     * 此處構(gòu)建的對象，如果需要依賴Spring Bean的話，需要自己構(gòu)建進(jìn)去，默認(rèn)不會自動注入，即默認(rèn)情況下@Autowired注解不生效
     */
    @Override
    public Object getObject() throws Exception {
        Object instance = this.type.getDeclaredConstructor().newInstance();
        applicationContext.getAutowireCapableBeanFactory().autowireBean(instance);
        return instance;
    }

    @Override
    public Class<!--?--> getObjectType() {
        return type;
    }

    public Class<!--?--> getType() {
        return type;
    }

    public void setType(Class<!--?--> type) {
        this.type = type;
    }

    public String getBeanName() {
        return beanName;
    }

    public void setBeanName(String beanName) {
        this.beanName = beanName;
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}

3、編寫`ImportBeanDefinitionRegistrar`

package com.huan.study.framewrok;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.ResourceLoaderAware;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.filter.AnnotationTypeFilter;

import java.util.Map;
import java.util.Optional;
import java.util.Set;

/**
 * @author huan.fu 2021/4/14 - 上午9:25
 */
public class CustomImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware, EnvironmentAware {

    private static final Logger log = LoggerFactory.getLogger(CustomImportBeanDefinitionRegistrar.class);

    private Environment environment;
    private ResourceLoader resourceLoader;

    @Override
    public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry registry) {
        if (!annotationMetadata.hasAnnotation(EnableCustomImport.class.getName())) {
            return;
        }
        Map<string, object> annotationAttributesMap = annotationMetadata.getAnnotationAttributes(EnableCustomImport.class.getName());
        AnnotationAttributes annotationAttributes = Optional.ofNullable(AnnotationAttributes.fromMap(annotationAttributesMap)).orElseGet(AnnotationAttributes::new);
        // 獲取需要掃描的包
        String[] packages = retrievePackagesName(annotationMetadata, annotationAttributes);
        // useDefaultFilters = false,即第二個參數(shù) 表示不掃描 @Component、@ManagedBean、@Named 注解標(biāo)注的類
        ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(registry, false, environment, resourceLoader);
        // 添加我們自定義注解的掃描
        scanner.addIncludeFilter(new AnnotationTypeFilter(CustomImport.class));
        // 掃描包
        for (String needScanPackage : packages) {
            Set<beandefinition> candidateComponents = scanner.findCandidateComponents(needScanPackage);
            try {
                registerCandidateComponents(registry, candidateComponents);
            } catch (ClassNotFoundException e) {
                log.error(e.getMessage(), e);
            }
        }
    }

    /**
     * 獲取需要掃描的包
     */
    private String[] retrievePackagesName(AnnotationMetadata annotationMetadata, AnnotationAttributes annotationAttributes) {
        String[] packages = annotationAttributes.getStringArray("packages");
        if (packages.length &gt; 0) {
            return packages;
        }
        String className = annotationMetadata.getClassName();
        int lastDot = className.lastIndexOf('.');
        return new String[]{className.substring(0, lastDot)};
    }

    /**
     * 注冊 BeanDefinition
     */
    private void registerCandidateComponents(BeanDefinitionRegistry registry, Set<beandefinition> candidateComponents) throws ClassNotFoundException {
        for (BeanDefinition candidateComponent : candidateComponents) {
            if (candidateComponent instanceof AnnotatedBeanDefinition) {
                AnnotatedBeanDefinition annotatedBeanDefinition = (AnnotatedBeanDefinition) candidateComponent;
                AnnotationMetadata annotationMetadata = annotatedBeanDefinition.getMetadata();
                Map<string, object> customImportAnnotationAttributesMap = annotationMetadata.getAnnotationAttributes(CustomImport.class.getName());
                AnnotationAttributes customImportAnnotationAttributes = Optional.ofNullable(AnnotationAttributes.fromMap(customImportAnnotationAttributesMap)).orElseGet(AnnotationAttributes::new);
                String beanName = customImportAnnotationAttributes.getString("beanName");
                String className = annotationMetadata.getClassName();
                Class<!--?--> clazzName = Class.forName(className);
                AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition(CustomImportFactoryBean.class)
                        .addPropertyValue("type", clazzName)
                        .addPropertyValue("beanName", beanName)
                        .setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE)
                        .setRole(BeanDefinition.ROLE_INFRASTRUCTURE)
                        .getBeanDefinition();
                registry.registerBeanDefinition(beanName, beanDefinition);

            }
        }
    }


    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }

    @Override
    public void setResourceLoader(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }
}

4、編寫@EnableCustomImport

/**
 * 啟用自動導(dǎo)入
 *
 * @author huan.fu 2021/4/14 - 上午9:29
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(CustomImportBeanDefinitionRegistrar.class)
public @interface EnableCustomImport {

    String[] packages() default {};
}

5、運行一個小的案例，獲取測試結(jié)果

如何實現(xiàn)基于ImportBeanDefinitionRegistrar和FactoryBean動態(tài)注入Bean到Spring容器中

感謝各位的閱讀，以上就是“如何實現(xiàn)基于ImportBeanDefinitionRegistrar和FactoryBean動態(tài)注入Bean到Spring容器中”的內(nèi)容了，經(jīng)過本文的學(xué)習(xí)后，相信大家對如何實現(xiàn)基于ImportBeanDefinitionRegistrar和FactoryBean動態(tài)注入Bean到Spring容器中這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是創(chuàng)新互聯(lián)，小編將為大家推送更多相關(guān)知識點的文章，歡迎關(guān)注！

網(wǎng)頁題目：如何實現(xiàn)基于ImportBeanDefinitionRegistrar和FactoryBean動態(tài)注入Bean到Spring容器中
本文路徑：http://jinyejixie.com/article0/ggecio.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)站改版、響應(yīng)式網(wǎng)站、關(guān)鍵詞優(yōu)化、App開發(fā)、、微信公眾號

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時需注明來源：創(chuàng)新互聯(lián)

猜你還喜歡下面的內(nèi)容

成人午夜视频全免费观看高清-秋霞福利视频一区二区三区-国产精品久久久久电影小说-亚洲不卡区三一区三区一区

如何實現(xiàn)基于ImportBeanDefinitionRegistrar和FactoryBean動態(tài)注入Bean到Spring容器中

一、背景

二、實現(xiàn)方案

1、基于@ComponentScan注解實現(xiàn)

2、基于ImportBeanDefinitionRegistrar和FactoryBean實現(xiàn)

3、注意

三、實現(xiàn)步驟

1、自定義注解CustomImport

2、實現(xiàn)CustomImportFactoryBean構(gòu)建對象

3、編寫ImportBeanDefinitionRegistrar

4、編寫@EnableCustomImport

5、運行一個小的案例，獲取測試結(jié)果

二、實現(xiàn)方案

2、基于ImportBeanDefinitionRegistrar和FactoryBean實現(xiàn)

3、注意

1、自定義注解`CustomImport`

2、實現(xiàn)`CustomImportFactoryBean`構(gòu)建對象

3、編寫`ImportBeanDefinitionRegistrar`

4、編寫@EnableCustomImport

5、運行一個小的案例，獲取測試結(jié)果