第三十二章：如何獲取SpringBoot項(xiàng)目的applicationContext對(duì)象

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

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

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

本章目標(biāo)

基于SpringBoot平臺(tái)完成ApplicationContext對(duì)象的獲取，并通過(guò)實(shí)例手動(dòng)獲取Spring管理的bean.

構(gòu)建項(xiàng)目

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

ApplicationContextAware

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

實(shí)現(xiàn)ApplicationContextAware接口

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

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上下文對(duì)象
 * ========================
 * Created with IntelliJ IDEA.
 * User：恒宇少年
 * Date：2017/8/26
 * Time：23:25
 * 碼云：http://git.oschina.net/jnyqy
 * ========================
 */
@Component
public class ApplicationContextProvider
    implements ApplicationContextAware
{
    /**
     * 上下文對(duì)象實(shí)例
     */
    private ApplicationContext applicationContext;

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

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

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

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

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

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

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

@Component
public class ApplicationContextProvider
    implements ApplicationContextAware
{
    /**
     * 上下文對(duì)象實(shí)例
     */
    private static ApplicationContext applicationContext;

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

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

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

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

    /**
     * 通過(guò)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就不會(huì)自動(dòng)調(diào)用setApplicationContext方法來(lái)為我們?cè)O(shè)置上下文實(shí)例。

總結(jié)

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

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