基於Spring上下文工具類 ApplicationContextUtil

Posted on by

Spring上下文工具類 ApplicationContextUtil

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;
 
/**
 * spring 上下文工具類
 * @author DAWN
 */
@Component
public class ApplicationContextUtil implements ApplicationContextAware {
 
    /**
     * 上下文對象實例
     */
    private static ApplicationContext applicationContext;
 
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        ApplicationContextUtil.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 <T>
     * @return
     */
    public static <T> T getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }
 
    /**
     * 通過name,以及Clazz返回指定的Bean
     *
     * @param name
     * @param clazz
     * @param <T>
     * @return
     */
    public static <T> T getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }
}

獲取ApplicationContext的工具類

在項目中，經常遇到這樣的問題：

有些類需要使用new來創建對象，但是類中需要使用spring容器中定義的bean，此時無法通過spring的自動註入來註入我們需要使用的bean。

所以需要手動的從spring容器中獲取bean。要獲取bean必須先獲取到ApplicationContext對象，有以下方式可以獲取該對象。

方式一

手動創建ApplicationContext對象，並保存起來。

public class ApplicationContextUtil {
    private static ApplicationContext context;
    static {
        context = new ClassPathXmlApplicationContext("applicationContext.xml");
    }
    public static ApplicationContext getApplicationContext() {
        return context;
    }
}

方式二

在web環境中通過spring提供的工具類獲取，需要ServletContext對象作為參數。然後才通過ApplicationContext對象獲取bean。

下面兩個工具方式的區別是，前者在獲取失敗時返回null，後者拋出異常。

另外，由於spring是容器的對象放在ServletContext中的，所以可以直接在ServletContext取出 WebApplicationContext 對象。

ApplicationContext context1 = WebApplicationContextUtils.getWebApplicationContext(ServletContext sc);
ApplicationContext context2 = WebApplicationContextUtils.getRequiredWebApplicationContext(ServletContext sc);
WebApplicationContext webApplicationContext = (WebApplicationContext) servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE);

方式三

工具類繼承抽象類ApplicationObjectSupport，並在工具類上使用@Component交由spring管理。

這樣spring容器在啟動的時候，會通過父類 ApplicationObjectSupport中的setApplicationContext()方法將ApplicationContext對象設置進去。

可以通過getApplicationContext()得到ApplicationContext對象。

方式四

工具類繼承抽象類WebApplicationObjectSupport，查看源碼可知WebApplicationObjectSupport是繼承瞭ApplicationObjectSupport，所以獲取ApplicationContext對象的方式和上面一樣，也是使用getApplicationContext()方法。

方式五

工具類實現ApplicationContextAware接口，並重寫setApplicationContext(ApplicationContext applicationContext)方法，在工具類中使用@Component註解讓spring進行管理。

spring容器在啟動的時候，會調用setApplicationContext()方法將ApplicationContext 對象設置進去。

@Component
public class ApplicationContextUtil implements ApplicationContextAware {
    private static ApplicationContext context;
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        context = applicationContext;
    }
    public static ApplicationContext getApplicationContext() {
        return context;
    }
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：