Spring：利用ApplicationContextAware裝配Bean

使用xml、注解的形式裝配Bean，因其方便快捷，受到大家喜愛。一般形式如下：

@Autowired
private BeanObjectInterface beanObject;

然而在某些特別場景下，既需要將對象作為Bean交於Spring管理，又需要在代碼中即時地獲取Bean，用注解形式進行裝配就不太能滿足需求。

查找資料，Spring提供了 ApplicationContextAware 接口，便於實時地獲取Bean。

首先，創建一個 Util 類，繼承 ApplicationContextAware 接口：

public class SpringContextUtil implements ApplicationContextAware {

    //Spring應用上下文環境
    private static ApplicationContext applicationContext;

    /**
     * 實現ApplicationContextAware接口的回調方法，設置上下文環境
     * @param applicationContext
     * @throws BeansException
     */
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringContextUtil.applicationContext = applicationContext;
    }

    public static ApplicationContext getApplicationContext(){
        return applicationContext;
    }

    /**
     * 獲取對象
     * @param name
     * @return Object 一個以類型
     * @throws BeansException
     */

    public static Object getBean(Class requiredType) throws BeansException {
        return applicationContext.getBean(requiredType);
    }

    /**
     * 獲取對象
     * @param name
     * @return Object 一個以所給名字注冊的bean的實例
     * @throws BeansException
     */
    public static Object getBean(String name) throws BeansException {
        return applicationContext.getBean(name);
    }

    /**
     * 獲取類型為requiredType的對象
     * 如果bean不能被類型轉換，相應的異常將會被拋出（BeanNotOfRequiredTypeException）
     * @param name       bean注冊名
     * @param requiredType 返回對象類型
     * @return Object 返回requiredType類型對象
     * @throws BeansException
     */
    public static Object getBean(String name, Class requireType) throws BeansException{
        return applicationContext.getBean(name, requireType);
    }

    /**
     * 如果BeanFactory包含一個與所給名稱匹配的bean定義，則返回true
     * @param name
     * @return boolean
     */
    public static boolean containsBean(String name){
        return applicationContext.containsBean(name);
    }

    /**
     * 判斷以給定名字注冊的bean定義是一個singleton還是一個prototype。
     * 如果與給定名字相應的bean定義沒有被找到，將會拋出一個異常（NoSuchBeanDefinitionException）
     * @param name
     * @return boolean
     * @throws NoSuchBeanDefinitionException
     */
    public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException {
        return applicationContext.isSingleton(name);
    }

    /**
     * @param name
     * @return Class 注冊對象的類型
     * @throws NoSuchBeanDefinitionException
     */
    public static Class getType(String name) throws NoSuchBeanDefinitionException {
        return applicationContext.getType(name);
    }

    /**
     * 如果給定的bean名字在bean定義中有別名，則返回這些別名
     * @param name
     * @return
     * @throws NoSuchBeanDefinitionException
     */
    public static String[] getAliases(String name) throws NoSuchBeanDefinitionException {
        return applicationContext.getAliases(name);
    }

}

然后在 appcontext.xml 文件中添加相應的bean配置，使得Spring可以在項目啟動時加載 SpringContextUtil ，完成 applicationContext 的初始化。

如果是使用注解掃描形式加載bean，則需要在 SpringContextUtil 上方標注 @Component：

@Component
public class SpringContextUtil implements ApplicationContextAware {
    // ... 內容不再贅述    
}

 

References:

https://www.jianshu.com/p/4145f507f3e7

http://blog.kazaff.me/2014/12/05/@Scope(prototype)%E7%9A%84%E6%AD%A3%E7%A1%AE%E7%94%A8%E6%B3%95/

https://www.ktanx.com/blog/p/326

p.s. 還有一篇簡書博客找不到了。其實很多方法是從那里學來的