基于Spring上下文工具类 ApplicationContextUtil

目录

• Spring上下文工具类 ApplicationContextUtil
• 获取ApplicationContext的工具类
  • 方式一
  • 方式二
  • 方式三
  • 方式四
  • 方式五

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;
    }
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。