SpringBoot 之 普通類獲取Spring容器中的bean
阿新 • • 發佈：2019-01-05
我們知道如果我們要在一個類使用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物件:
這裡有更多這方面的介紹，比較詳細
下面介紹在springboot中是如何使用的
1.在Spring Boot可以掃描的包下
寫的工具類為SpringUtil，實現ApplicationContextAware介面，並加入Component註解，讓spring掃描到該bean
springutil:
package me.shijunjie.util; import org.springframework.beans.BeansException; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.stereotype.Component; @Component public class SpringUtil implementsApplicationContextAware { private static ApplicationContext applicationContext; @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { if(SpringUtil.applicationContext == null) { SpringUtil.applicationContext = applicationContext; } System.out.println("---------------------------------------------------------------------"); System.out.println("---------------------------------------------------------------------"); System.out.println("---------------me.shijunjie.util.SpringUtil------------------------------------------------------"); System.out.println("========ApplicationContext配置成功,在普通類可以通過呼叫SpringUtils.getAppContext()獲取applicationContext物件,applicationContext="+SpringUtil.applicationContext+"========"); System.out.println("---------------------------------------------------------------------"); } //獲取applicationContext public static ApplicationContext getApplicationContext() { return applicationContext; } //通過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); } }
為了測試，我們再啟動的時候先通過程式碼方式給spring容器中注入一個bean，入下所示
package me.shijunjie.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import me.shijunjie.entity.Demo2; @Configuration public class BeanConfig { @Bean(name="testDemo") public Demo2 generateDemo() { Demo2 demo = new Demo2(); demo.setId(12345); demo.setName("test"); return demo; } }
然後我們編寫測試controller，並從剛才寫的springutil中獲取這個bean
package me.shijunjie.controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import me.shijunjie.util.SpringUtil; @RestController @RequestMapping("/application") public class TestApplicationController { @RequestMapping("/test1") public Object testSpringUtil1() { return SpringUtil.getBean("testDemo"); } }
測試
啟動web應用，開啟瀏覽器輸入http://localhost:8080/application/test1，測試成功
2 不在Spring Boot的掃描包下方式一
這種情況處理起來也很簡單，先編寫SpringUtil類，同樣需要實現介面：ApplicationContextAware，具體編碼如下：
package me.shijunjie.util; import org.springframework.beans.BeansException; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; public class SpringUtil2 implements ApplicationContextAware { private static ApplicationContext applicationContext; @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { if(SpringUtil2.applicationContext == null) { SpringUtil2.applicationContext = applicationContext; } System.out.println("---------------------------------------------------------------------"); System.out.println("---------------------------------------------------------------------"); System.out.println("---------------me.shijunjie.util.SpringUtil------------------------------------------------------"); System.out.println("========ApplicationContext配置成功,在普通類可以通過呼叫SpringUtils.getAppContext()獲取applicationContext物件,applicationContext="+SpringUtil2.applicationContext+"========"); System.out.println("---------------------------------------------------------------------"); } //獲取applicationContext public static ApplicationContext getApplicationContext() { return applicationContext; } //通過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註解進
package me.shijunjie.controller; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.web.SpringBootServletInitializer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.scheduling.annotation.EnableScheduling; import me.shijunjie.util.SpringUtil2; @ComponentScan(basePackages={"me.shijunjie"}) // 掃描該包路徑下的所有spring元件 /*@EnableJpaRepositories("me.shijunjie.dao") // JPA掃描該包路徑下的Repositorie *//*@EntityScan("me.shijunjie.entity") // 掃描實體類 */@SpringBootApplication @EnableScheduling public class App extends SpringBootServletInitializer{ @Bean public SpringUtil2 getSpringUtil2() { return new SpringUtil2(); } public static void main(String[] args) { SpringApplication.run(App.class, args); } }
測試（使用熱部署的需要重啟伺服器）
啟動web應用，開啟瀏覽器輸入http://localhost:8080/application/test2，測試成功
除此以外，也可以在App.java中使用@Import進行匯入。
package me.shijunjie.controller; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.web.SpringBootServletInitializer; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Import; import org.springframework.scheduling.annotation.EnableScheduling; import me.shijunjie.util.SpringUtil2; @ComponentScan(basePackages={"me.shijunjie"}) // 掃描該包路徑下的所有spring元件 /*@EnableJpaRepositories("me.shijunjie.dao") // JPA掃描該包路徑下的Repositorie *//*@EntityScan("me.shijunjie.entity") // 掃描實體類 */@SpringBootApplication @EnableScheduling @Import(SpringUtil2.class) public class App extends SpringBootServletInitializer{ /*@Bean public SpringUtil2 getSpringUtil2() { return new SpringUtil2(); }*/ public static void main(String[] args) { SpringApplication.run(App.class, args); } }