Spring容器中获取Bean实例的七种方式(附实战源码)

导读:本篇文章讲解 Spring容器中获取Bean实例的七种方式(附实战源码),希望对大家有帮助,欢迎收藏,转发!站点地址:www.bmabk.com

写作说明

一:写作原因

首先解释一下写这篇博文的原因,因为在使用spring框架的过程中获取bean是非常常见的操作,但是网上非常的博文大多承自一家之言,因此很多可操作性上并不强,本文是通过自己实战,亲自尝试之后提供的几种方案,供大家一起学习探讨。

二:源码出处

本文出自原创,如果您转发请注明出处,另本文提供的测试代码为chapter-1-springmvc-quickstart中的单元测试类BeanUtilTest如果有需要的可自行下载

实现方式

本文一共提供七种实现方式:

一:使用BeanFactory直接获取(不推荐)

使用BeanFactory从工厂中直接获取Bean实例,但是XmlBeanFactory类已经废弃,因此不建议使用,测试代码如下:

    /**
     * 方式一:XmlBeanFactory已经废弃不建议使用
     */
    @Test
    public void getBeanTest1() {
        BeanFactory beanFactory = new XmlBeanFactory(new ClassPathResource("applicationContext.xml"));
        UserInfo userInfo = (UserInfo) beanFactory.getBean("userInfo");
        System.out.println(userInfo);
    }
二:在初始化时保存ApplicationContext对象

可以在初始化的时候保存ApplicationContext对象,然后通过这个对象获取Bean,测试代码如下:

    /**
     * 方式二:使用ClassPathXmlApplicationContext获取ApplicationContext
     */
    @Test
    public void getBeanTest2() {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
        UserInfo userInfo = (UserInfo) applicationContext.getBean("userInfo");
        System.out.println(userInfo);
    }
三:继承自抽象类ApplicationObjectSupport

可以继承抽象类ApplicationObjectSupport并将自己继承的类注入到Spring容器中,示例代码如下:

    /**
     * 方法三:继承ApplicationObjectSupport来获取ApplicationContext,
     * 注意:需要把自己继承的类注入到Spring
     */
    @Test
    public void getBeanTest3() {
        ApplicationContextUtil2 applicationContextUtil2 = (ApplicationContextUtil2) ApplicationContextUtil.getBean("applicationContextUtil2");
        UserInfo userInfo = (UserInfo) applicationContextUtil2.getBean("userInfo");
        System.out.println(userInfo);
    }

其中ApplicationContextUtil2的代码如下所示:

public class ApplicationContextUtil2 extends ApplicationObjectSupport {

    /**
     * 通过bean的id获取bean对象
     * @param beanName
     * @return
     */
    public Object getBean(String beanName){
        return super.getApplicationContext().getBean(beanName);
    }

}

最后莫忘了将Bean注入到Spring容器中,通过注解,或者配置均可,本示例通过配置实现

    <!-- 测试获取bean的方式,继承ApplicationObjectSupport需要先注入这个类 -->
    <bean id="applicationContextUtil2" class="com.leo.util.ApplicationContextUtil2"></bean>
四:继承自抽象类WebApplicationObjectSupport

可以继承抽象类WebApplicationObjectSupport并将自己继承的类注入到Spring容器中,示例代码如下:

    /**
     * 方法四:继承WebApplicationObjectSupport来获取ApplicationContext,
     * 注意:需要把自己继承的类注入到Spring,同时需要添加@WebAppConfiguration注解,否则会找不到web容器
     */
    @Test
    public void getBeanTest4() {
        ApplicationContextUtil3 applicationContextUtil3 = (ApplicationContextUtil3) ApplicationContextUtil.getBean("applicationContextUtil3");
        UserInfo userInfo = (UserInfo) applicationContextUtil3.getBean("userInfo");
        System.out.println(userInfo);
    }

其中ApplicationContextUtil3 的示例代码如下:

public class ApplicationContextUtil3 extends WebApplicationObjectSupport{

    /**
     * 通过bean的id获取bean对象
     * @param beanName
     * @return
     */
    public Object getBean(String beanName){
        return super.getWebApplicationContext().getBean(beanName);
    }

}

最后莫忘了将Bean注入到Spring容器中,通过注解,或者配置均可,本示例通过配置实现

    <!-- 测试获取bean的方式,继承WebApplicationObjectSupport需要先注入这个类 -->
    <bean id="applicationContextUtil3" class="com.leo.util.ApplicationContextUtil3"></bean>
五:使用Spring提供的工具类WebApplicationContextUtils

使用Spring提供的工具类WebApplicationContextUtils来获取WebApplicationContext对象,这个方法很常见于SpringMVC构建的web项目中,测试代码如下所示:

    /**
     * 方法五:使用WebApplicationContextUtils提供的方法获取ApplicationContext对象
     */
    @Test
    public void getBeanTest5(){
        //模拟ServletContext上下文,不然会出现空指针异常
        MockServletContext sc = new MockServletContext("");
        sc.addInitParameter(ContextLoader.CONFIG_LOCATION_PARAM, "/applicationContext.xml");
        ServletContextListener listener = new ContextLoaderListener();
        ServletContextEvent event = new ServletContextEvent(sc);
        listener.contextInitialized(event);

        //使用WebApplicationContextUtils的getRequiredWebApplicationContext方法
        WebApplicationContext webApplicationContext = WebApplicationContextUtils.getRequiredWebApplicationContext(sc);
        UserInfo userInfo = (UserInfo) webApplicationContext.getBean("userInfo");
        System.out.println(userInfo);
        //使用WebApplicationContextUtils的getWebApplicationContext方法
        WebApplicationContext webApplicationContext2 = WebApplicationContextUtils.getWebApplicationContext(sc);
        UserInfo userInfo2 = (UserInfo) webApplicationContext2.getBean("userInfo");
        System.out.println(userInfo2);
    }
六:实现ApplicationContextAware接口

通过实现ApplicationContextAware接口,在Spring容器启动的时候将ApplicationContext注入进去,从而获取ApplicationContext对象,这种方法也是常见的获取Bean的一种方式,测试代码如下:

    /**
     *方法六:实现ApplicationContextAware接口获取ApplicationContext
     */
    @Test
    public void getBeanTest6(){
        UserInfo userInfo2 = (UserInfo) ApplicationContextUtil.getBean("userInfo");
        System.out.println(userInfo2);
    }

其中ApplicationContextUtil的实现如下:

public class ApplicationContextUtil implements ApplicationContextAware{
    private static ApplicationContext applicationContext;

    /**
     * 通过bean的id获取bean对象
     * @param beanName
     * @return
     */
    public static Object getBean(String beanName){
        return applicationContext.getBean(beanName);
    }

    /**
     * 根据bean的id和类型获取bean对象
     * @param beanName
     * @param clazz
     * @param <T>
     * @return
     */
    public static <T> T getBean(String beanName,Class<T> clazz){
        return clazz.cast(getBean(beanName));
    }


    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}
七:使用ContextLoader提供的getCurrentWebApplicationContext方法

使用ContextLoader提供的getCurrentWebApplicationContext方法提供的方法也是常用的获取WebApplicationContext的一种方法,这个方法常见于SpringMVC实现的web项目中。测试代码如下:

    /**
     * 方法七:使用ContextLoader的getCurrentWebApplicationContext方法获取WebApplicationContext
     */
    @Test
    public void getBeanTest7() {
        MockServletContext sc = new MockServletContext("");
        sc.addInitParameter(ContextLoader.CONFIG_LOCATION_PARAM, "/applicationContext.xml");
        ServletContextListener listener = new ContextLoaderListener();
        ServletContextEvent event = new ServletContextEvent(sc);
        listener.contextInitialized(event);
        //如果不加上面的模拟创建ServletContext对象,会报空指针异常
        WebApplicationContext wac = ContextLoader.getCurrentWebApplicationContext();
        UserInfo userInfo = (UserInfo) wac.getBean("userInfo");
        System.out.println(userInfo);
    }

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/72745.html

(0)
小半的头像小半

相关推荐

极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!