Spring Spring boot 获取IOC中的bean，ApplicationContextAware应用理解

在项目中我们经常会碰到这么一个场景，某些普通的JAVA类，这个类并没有被Spring所管理，但是我们需要再这个类中调用到某些方法，是ioc容器中对象的方法，我们没法再普通的JAVA类中通过spring的注解@Autowired和@Resource注入对象，在这种场景下，我么就可以使用方法获取到ioc中的实例，并使用其方法。

---

在项目中获取获取beand方法多种多样，这里大致列举几种

1. 在初始化时保存ApplicationContext对象
2. 通过Spring提供的utils类获取ApplicationContext对象
3. 继承自抽象类ApplicationObjectSuppor
4. 继承自抽象类WebApplicationObjectSupport
5. 实现接口ApplicationContextAware
6. 通过Spring提供的ContextLoader

如果想了解每一种的用法可以参考此篇博文：https://blog.csdn.net/zsw12013/article/details/51701671

本片博文只具体展示一种配置，也是自身项目中遇到的获取方式，就是第五中方式实现接口ApplicationContextAware，这种获取方式适用于大多数项目内业务接口不方便注入的时候的调用

---

实现ApplicationContextAware接口的类必须要被spring所管理，要么在代码中标记为ioc组件(类的路径必须要被spring扫描到)，要么在applicationContext.xml spring的配置文件配置为bean,不然会获取不到上下文对象，调用这个类的普通JAVA类是没有限制的。

工具类代码

package com.wzh.config.utils;

import org.apache.log4j.Logger;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

/**
 * <从Spring IOC容器中获取Bean对象> <功能详细描述>
 * @author wzh
 * @version 2018-09-23 19:32
 * @see [相关类/方法] (可选)
 **/
@Component("beanHeader")
public class BeanHeader implements ApplicationContextAware
{

    private static Logger log = Logger.getLogger(BeanHeader.class);
    
    // 上下文对象
    private static ApplicationContext applicationContext;
    
    /**
     * 实现ApplicationContextAware接口的回调方法，注入上下文对象
     * @param applicationContext
     * @throws BeansException
     */
    @Override
    public void setApplicationContext(ApplicationContext applicationContext)
        throws BeansException
    {
        BeanHeader.applicationContext = applicationContext;
    }
    
    /**
     * 获取上下文对象
     * @return applicationContext
     */
    public static ApplicationContext getApplicationContext()
    {
        return applicationContext;
    }
    
    /**
     * 判断上下文对象是否为空
     * 
     * @return
     */
    public static boolean checkapplicationContext()
    {
        boolean flag = getApplicationContext() != null;
        if (!flag)
        {
            log.error("applicaitonContext未注入,实现ApplicationContextAware的类必须被spring管理");
        }
        return flag;
    }
    
    /**
     * 根据name获取bean
     * @param name
     * @param 
     * @return
     */
    public static  T getBean(String name)
    {
        if (checkapplicationContext())
        {
            return (T)getApplicationContext().getBean(name);
        }
        else
        {
            return null;
        }
    }
    
    /**
     * 根据class 获取bean
     * @param clazz
     * @param 
     * @return
     */
    public static  T getBean(Class clazz)
    {
        if (checkapplicationContext())
        {
            return getApplicationContext().getBean(clazz);
        }
        else
        {
            return null;
        }
    }
    
    /**
     * 根据name,以及Clazz返回指定的Bean
     * @param name
     * @param clazz
     * @param 
     * @return
     */
    public static  T getBean(String name, Class clazz)
    {
        if (checkapplicationContext())
        {
            return getApplicationContext().getBean(name, clazz);
        }
        else
        {
            return null;
        }
    }
}

下面我们来测试一下

首先是一个简单的service 被spring管理

package com.wzh.demo.service.impl;

import com.wzh.demo.service.SystemOutService;
import org.springframework.stereotype.Service;

/**
 * <简单的输出测试，没有功能>
 * <功能详细描述>
 * @author wzh
 * @version 2018-09-23 23:11
 * @see [相关类/方法] (可选)
 **/
@Service("systemOutService")
public class SystemOutServiceImp implements SystemOutService{

    @Override
    public void sysout() {
        System.out.println("调用systemOutService 成功");
    }
}

junit 测试基类

package base;

import com.wzh.application.Application;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;


/**
 * junit 测试基类
 */
//SpringJUnit支持，由此引入Spring-Test框架支持！
@RunWith(SpringJUnit4ClassRunner.class)
//启动类,启用随即端口
@SpringBootTest(classes = Application.class,webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
//web项目支持，webEnvironment属性使用后不能用webAppconfiguration注解
//@WebAppConfiguration
public class BaseJunit {

    @Test
    public void runJunitTest()
    {
        System.out.println("Junit 启动测试");
    }
}

junit 测试类

import base.BaseJunit;
import com.wzh.config.utils.BeanHeader;
import com.wzh.demo.service.SystemOutService;
import org.junit.Test;

/**
 * <一句话功能描述>
 * <功能详细描述>
 * @author wzh
 * @version 2018-09-23 23:18
 * @see [相关类/方法] (可选)
 **/
public class BeanHeaderTest extends BaseJunit {

    @Test
    public void testBeanHeader()
    {
        SystemOutService service = BeanHeader.getBean("systemOutService");
        service.sysout();
    }
}

运行方法，控制台输出

image.png