170630、springboot编程之普通类中调用spring管理的bean对象

我们知道如果我们要在一个类使用spring提供的bean对象，我们需要把这个类注入到spring容器中，交给spring容器进行管理，但是在实际当中，我们往往会碰到在一个普通的Java类中，想直接使用spring提供的其他对象或者说有一些不需要交给spring管理，但是需要用到spring里的一些对象。如果这是spring框架的独立应用程序，我们通过

ApplicationContext ac = new FileSystemXmlApplicationContext("applicationContext.xml");
ac.getBean("beanId");

这样的方式就可以很轻易的获取我们所需要的对象。

但是往往我们所做的都是Web Application，这时我们启动spring容器是通过在web.xml文件中配置，这样就不适合使用上面的方式在普通类去获取对象了，因为这样做就相当于加载了两次spring容器，而我们想是否可以通过在启动web服务器的时候，就把Application放在某一个类中，我们通过这个类在获取，这样就可以在普通类获取spring bean对象了！

在Spring Boot可以扫描的包下

假设我们编写的工具类为SpringUtil。

如果我们编写的SpringUtil在Spring Boot可以扫描的包下或者使用@ComponentScan引入自定义的包了，那么原理很简单，只需要使得SpringUtil实现接口：ApplicationContextAware，然后加上@Component 注解即可，具体编码如下：

1、SpringUtil.java

package com.rick.utils;

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

/**
 * Desc :  spring工具类
 * 普通类调用Spring bean对象
 * 说明：此类需要放到主函数同包或者子包下才能被扫描，否则失效。
 * User : RICK
 * Time : 2017/8/22 10:32
 */
@Component
public class SpringUtil implements ApplicationContextAware {
    private static ApplicationContext applicationContext = null;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        if (SpringUtil.applicationContext == null) {
            SpringUtil.applicationContext = applicationContext;
            System.out.println("==ApplicationContext配置成功,在普通类可以通过调用SpringUtils.getAppContext()获取applicationContext对象==");
        }
    }

    /**
     * Desc :  获取applicationContext
     * User : RICK
     * Time : 2017/8/22 10:36
     */

    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    /**
     * Desc :  通过beanName获取bean
     * User : RICK
     * Time : 2017/8/22 10:37
     */
    public static Object getBean(String beanName) {
        return getApplicationContext().getBean(beanName);
    }

    /**
     * Desc :  通过class获取bean
     * User : RICK
     * Time : 2017/8/22 10:38
      */
    public static <T> T getBean(Class<T> clazz){
        return getApplicationContext().getBean(clazz);
    }

    /**
     * Desc : 通过name、class返回指定的bean
     * User : RICK
     * Time : 2017/8/22 10:48
      */
    public static <T> T getBean(String name,Class<T> clazz){
        return getApplicationContext().getBean(name,clazz);
    }

}

2、启动项目看控制台是否输出==ApplicationContext配置成功,在普通类可以通过调用SpringUtils.getAppContext()获取applicationContext对象==，如果能输出表示配置成功

3、那么这样子在普通类既可以使用:SpringUtil.getBean() 获取到Spring IOC容器中的bean。当然也可以在Spring管理的类中使用：@Resouce或者@Autowired 进行注入使用，当然我们这个类的核心是普通类可以调用spring的bean进行使用了

不在Spring Boot的扫描包下方式一

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;

public class SpringUtil implements ApplicationContextAware{
    private static ApplicationContext applicationContext = null;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
       if(SpringUtil.applicationContext == null){
           SpringUtil.applicationContext  = applicationContext;
       }
      System.out.println("---------------------------------------------------------------------");
      System.out.println("---------------------------------------------------------------------");
    System.out.println("---------------simple.plugin.spring.SpringUtil------------------------------------------------------");
       System.out.println("========ApplicationContext配置成功,在普通类可以通过调用SpringUtils.getAppContext()获取applicationContext对象,applicationContext="+SpringUtil.applicationContext+"========");
      System.out.println("---------------------------------------------------------------------");
    }

    //获取applicationContext
    public static ApplicationContext getApplicationContext() {
       returnapplicationContext;
    }

    //通过name获取 Bean.
    public static Object getBean(String name){
       return getApplicationContext().getBean(name);
    }

    //通过class获取Bean.
    public static <T> T getBean(Class<T> clazz){
       return getApplicationContext().getBean(clazz);
    }

    //通过name,以及Clazz返回指定的Bean
    public static <T> T getBean(String name,Class<T> clazz){
       return getApplicationContext().getBean(name, clazz);
    }
}

之后这一步才是关键，使用@Bean注解，在App.java类中将SpringUtil注解进来，代码如下：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Import;

import simple.plugin.spring.SpringUtil;

/**
 * Hello world!
 *
 */
//其中@SpringBootApplication申明让spring boot自动给程序进行必要的配置，等价于以默认属性使用@Configuration，@EnableAutoConfiguration和@ComponentScan
@SpringBootApplication
@ServletComponentScan

public class App {

       /**注册Spring Util
        * 这里为了和上一个冲突，所以方面名为：springUtil2
        * 实际中使用springUtil
        */
       @Bean
       public SpringUtil springUtil2(){return new SpringUtil();}

       /**
        *
      参数里VM参数设置为：
       -javaagent:.\lib\springloaded-1.2.4.RELEASE.jar -noverify
        * @param args
        */
       public static void main(String[] args) {
              SpringApplication.run(App.class, args);
       }
}

不在Spring Boot的扫描包下方式二

代码基本和上面都是相同的，主要是在App.java中使用@Import进行导入。

而且在SpringUtil是不需要添加@Component注解

@SpringBootApplication

@ServletComponentScan

@Import(value={SpringUtil.class})

publicclass App {

//省略其它代码.

}