第三十二章：如何獲取SpringBoot項目的applicationContext對象

zhangke3016 發(fā)布于2019-08-15 12:00 / 2821人閱讀

摘要：對象是開源框架的上下文對象實例，在項目運行時自動裝載內(nèi)的所有信息到內(nèi)存。總結(jié)本章內(nèi)容較少，主要講解了平臺下采用的方式完成實例的獲取，并通過實例完成對管理的實例手動獲取。

ApplicationContext對象是Spring開源框架的上下文對象實例，在項目運行時自動裝載Handler內(nèi)的所有信息到內(nèi)存。傳統(tǒng)的獲取方式有很多種，不過隨著Spring版本的不斷迭代，官方也慢慢的不建議使用部分方式。下面我簡單介紹一種Spring官方推薦使用的方式！

本章目標(biāo)

基于SpringBoot平臺完成ApplicationContext對象的獲取，并通過實例手動獲取Spring管理的bean.

構(gòu)建項目

本章項目不需要太多的內(nèi)容，添加Web依賴就可以了。

ApplicationContextAware

這個接口對象就是我們今天的主角，其實以實現(xiàn)ApplicationContextAware接口的方式獲取ApplicationContext對象實例并不是SpringBoot特有的功能，早在Spring3.0x版本之后就存在了這個接口，在傳統(tǒng)的Spring項目內(nèi)同樣是可以獲取到ApplicationContext實例的，下面我們看看該如何編碼才能達(dá)到我們的效果呢？

實現(xiàn)ApplicationContextAware接口

創(chuàng)建一個實體類并實現(xiàn)ApplicationContextAware接口，重寫接口內(nèi)的setApplicationContext方法來完成獲取ApplicationContext實例的方法，代碼如下所示：

package com.xunmei.api;

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

/**
 * 獲取Spring上下文對象
 * ========================
 * Created with IntelliJ IDEA.
 * User：恒宇少年
 * Date：2017/8/26
 * Time：23:25
 * 碼云：http://git.oschina.net/jnyqy
 * ========================
 */
@Component
public class ApplicationContextProvider
    implements ApplicationContextAware
{
    /**
     * 上下文對象實例
     */
    private ApplicationContext applicationContext;

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

    /**
     * 獲取applicationContext
     * @return
     */
    public ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    /**
     * 通過name獲取 Bean.
     * @param name
     * @return
     */
    public Object getBean(String name){
        return getApplicationContext().getBean(name);
    }

    /**
     * 通過class獲取Bean.
     * @param clazz
     * @param 
     * @return
     */
    public  T getBean(Class clazz){
        return getApplicationContext().getBean(clazz);
    }

    /**
     * 通過name,以及Clazz返回指定的Bean
     * @param name
     * @param clazz
     * @param 
     * @return
     */
    public  T getBean(String name,Class clazz){
        return getApplicationContext().getBean(name, clazz);
    }
}

我們拿到ApplicationContext對象實例后就可以手動獲取Bean的注入實例對象，在ApplicationContextProvider類內(nèi)我簡單的實現(xiàn)了幾個方法來獲取指定的Bean實例，當(dāng)然你可以添加更多的方法來完成更多的業(yè)務(wù)邏輯。

如果你是想在非Spring管理的實體內(nèi)使用ApplicationContext還不想采用注入ApplicationContextProvider來完成實例化，這時我們可以修改ApplicationContext實例對象為靜態(tài)實例，方法改為靜態(tài)方法，這樣在外部同樣是可以獲取到指定Bean的實例。如下所示：

@Component
public class ApplicationContextProvider
    implements ApplicationContextAware
{
    /**
     * 上下文對象實例
     */
    private static ApplicationContext applicationContext;

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

    /**
     * 獲取applicationContext
     * @return
     */
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    /**
     * 通過name獲取 Bean.
     * @param name
     * @return
     */
    public static Object getBean(String name){
        return getApplicationContext().getBean(name);
    }

    /**
     * 通過class獲取Bean.
     * @param clazz
     * @param 
     * @return
     */
    public static  T getBean(Class clazz){
        return getApplicationContext().getBean(clazz);
    }

    /**
     * 通過name,以及Clazz返回指定的Bean
     * @param name
     * @param clazz
     * @param 
     * @return
     */
    public static  T getBean(String name,Class clazz){
        return getApplicationContext().getBean(name, clazz);
    }
}

這里要注意ApplicationContextProvider類上的@Component注解是不可以去掉的，去掉后Spring就不會自動調(diào)用setApplicationContext方法來為我們設(shè)置上下文實例。

總結(jié)

本章內(nèi)容較少，主要講解了SpringBoot平臺下采用ApplicationContextAware的方式完成ApplicationContext實例的獲取，并通過ApplicationContext實例完成對Spring管理的Bean實例手動獲取。

SpringBoot相關(guān)系列文章請訪問：目錄：SpringBoot學(xué)習(xí)目錄
QueryDSL相關(guān)系列文章請訪問：QueryDSL通用查詢框架學(xué)習(xí)目錄
SpringDataJPA相關(guān)系列文章請訪問：目錄：SpringDataJPA學(xué)習(xí)目錄
感謝閱讀！
歡迎加入QQ技術(shù)交流群，共同進(jìn)步。
QQ技術(shù)交流群