17、Spring Boot普通类调用bean【从零开始学Spring Boot】

我们知道如果我们要在一个类使用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 bean对象:

可以参考：http://412887952-qq-com.iteye.com/blog/1479445

这里有更多这方面的介绍，比较详细，在这里只是抛装引玉说明在Spring Boot是如何进行调用的。

 

 

17.1 在Spring Boot可以扫描的包下

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

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

com.kfit.base.util.SpringUtil:

package com.kfit.base.util;
 
import org.springframework.beans.BeansException;
importorg.springframework.context.ApplicationContext;
importorg.springframework.context.ApplicationContextAware;
importorg.springframework.stereotype.Component;
 
/**
 *普通类调用Spring bean对象：
 *说明：
 * 1、此类需要放到App.java同包或者子包下才能被扫描，否则失效。
 *@author Administrator
 */
@Component
publicclass SpringUtil
implementsApplicationContextAware{
       privatestaticApplicationContext
applicationContext =null;
 
      
@Override
       publicvoidsetApplicationContext(ApplicationContextapplicationContext)
throws BeansException{
              if(SpringUtil.applicationContext ==null){
                     SpringUtil.applicationContext  =applicationContext;
              }
              System.out.println("---------------------------------------------------------------------");
              System.out.println("---------------------------------------------------------------------");
       System.out.println("---------------com.kfit.base.util.SpringUtil------------------------------------------------------");
              System.out.println("========ApplicationContext配置成功,在普通类可以通过调用SpringUtils.getAppContext()获取applicationContext对象,applicationContext="+SpringUtil.applicationContext+"========");
              System.out.println("---------------------------------------------------------------------");
       }
      
      
//获取applicationContext
       publicstaticApplicationContext getApplicationContext() {
              returnapplicationContext;
       }
      
      
//通过name获取 Bean.
       publicstatic ObjectgetBean(String
name){
              returngetApplicationContext().getBean(name);
       }
      
      
//通过class获取Bean.
       publicstatic <T> TgetBean(Class<T>
clazz){
              returngetApplicationContext().getBean(clazz);
       }
      
      
//通过name,以及Clazz返回指定的Bean
       publicstatic <T> TgetBean(String
name,Class<T> clazz){
              returngetApplicationContext().getBean(name,clazz);
       }
}
 

启动应用，查看控制台的打印信息是否有：

======ApplicationContext配置成功,在普通类可以通过调用SpringUtils.getAppContext()获取applicationContext对象,

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

     这种情况处理起来也很简单，先编写SpringUtil类，同样需要实现接口：ApplicationContextAware，具体编码如下：

simple.plugin.spring.SpringUtil

package simple.plugin.spring;
 
importorg.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
importorg.springframework.context.ApplicationContextAware;
 
publicclass SpringUtil
implementsApplicationContextAware{
       privatestaticApplicationContext
applicationContext =null;
 
      
@Override
       publicvoid setApplicationContext(ApplicationContextapplicationContext)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
       publicstaticApplicationContext getApplicationContext() {
              returnapplicationContext;
       }
      
      
//通过name获取 Bean.
       publicstatic ObjectgetBean(String
name){
              returngetApplicationContext().getBean(name);
       }
      
      
//通过class获取Bean.
       publicstatic <T> TgetBean(Class<T>
clazz){
              returngetApplicationContext().getBean(clazz);
       }
      
      
//通过name,以及Clazz返回指定的Bean
       publicstatic <T> TgetBean(String
name,Class<T> clazz){
              returngetApplicationContext().getBean(name,clazz);
       }
}
 

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

package com.kfit;
 
import org.springframework.boot.SpringApplication;
importorg.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 SpringUtilspringUtil2(){return new SpringUtil();}
      
       /**
        *
     参数里VM参数设置为：
       -javaagent:.\lib\springloaded-1.2.4.RELEASE.jar-noverify
        * @param args
        */
       public static voidmain(String[] args) {
              SpringApplication.run(App.class,args);
       }
}
 

 

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

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

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

@SpringBootApplication
@ServletComponentScan
@Import(value={SpringUtil.class})
public
class App{
       //省略其它代码.
}
 

说明以上3中方式都生效了，这3中方式根据实际情况选择一种方式就可以了。

 

那么这样子在普通类既可以使用:

SpringUtil.getBean() 获取到Spring IOC容器中的bean。

当然也可以在Spring管理的类中使用：

@Resouce或者@Autowired进行注入使用，当然我们这个类的核心是普通类可以调用spring的bean进行使用了，是不是很神奇呢。