快捷導(dǎo)航

Spring實戰(zhàn)之XML與JavaConfig的混合配置詳解

更新時間：2017年07月16日 15:21:49 作者：杰鍋鍋

大家都知道Spring的顯示配置方式有兩種，一種是基于XML配置，一種是基于JavaConfig的方式配置。那么下這篇文章主要給大家分別介紹如何在JavaConfig中引用XML配置的bean以及如何在XML配置中引用JavaConfig，需要的朋友可以參考下。

前言

之前提到了關(guān)于Spring的顯示配置方式有兩種，一種是基于XML配置，一種是基于JavaConfig的方式配置。對于這兩種配置方式并不是互斥關(guān)系，相反，他們兩能夠相互融合，有效的搭配完成Spring的bean注入。

這里分別介紹如何在JavaConfig中引用XML配置的bean以及如何在XML配置中引用JavaConfig。下面話不多說，來一起看看詳細(xì)的介紹吧。

一、JavaConfig中引用XML配置的bean

上篇我們看到配置類CDPlayerConfig具體代碼如下

@Configuration
public class CDPlayerConfig {
 
 @Bean
 public CompactDisc compactDisc() {
 return new SgtPeppers();
 }

 @Bean
 public CDPlayer cdPlayer(CompactDisc compactDisc) {
 return new CDPlayer(compactDisc);
 }

}

在該配置類中注冊了兩個bean。假設(shè)讓CDPlayerConfig現(xiàn)在矯情一把，它認(rèn)為自己內(nèi)部注冊的bean太多了，它有點管不過來了（確實有點矯情過了），它準(zhǔn)備把compactDisc這個bean踢出去，讓別人來管管。

讓誰管呢，這時候我們又新建了另外一個配置類CDConfig

@Configuration
public class CDConfig {
 @Bean
 public CompactDisc compactDisc() {
 return new SgtPeppers();
 }
}

這個配置類簡潔到不行，只有一個CompactDisc的bean。

現(xiàn)在有了這兩個配置類，也集齊了兩個bean，那么該如何把他們整合到一起呢，建立起它們的聯(lián)系。這時候我們新建一個連接類SoundSystemConfig

@Configuration
@Import(CDPlayerConfig.class, CDConfig.class)
public class SoundSystemConfig {

}

這樣就解決了在一個配置類中要加載的bean過多的問題。

那么問題來了，如果這時候CompactDisc接口的實現(xiàn)類BlankDisc是聲明在XML中，這兩種顯示聲明又會如何結(jié)合呢。

public class BlankDisc implements CompactDisc {

 private String title;
 private String artist;
 private List<String> tracks;

 public BlankDisc(String title, String artist, List<String> tracks) {
 this.title = title;
 this.artist = artist;
 this.tracks = tracks;
 }

 public void play() {
 System.out.println("Playing " + title + " by " + artist);
 for (String track : tracks) {
  System.out.println("-Track: " + track);
 }
 }

}

具體該類在XML中配置如下

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:c="http://www.springframework.org/schema/c"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

 <bean id="compactDisc"
  class="soundsystem.BlankDisc"
  c:_0="Sgt. Pepper's Lonely Hearts Club Band"
  c:_1="The Beatles">
 <constructor-arg>
  <list>
  <value>Sgt. Pepper's Lonely Hearts Club Band</value>
  <value>With a Little Help from My Friends</value>
  <value>Lucy in the Sky with Diamonds</value>
  <value>Getting Better</value>
  <value>Fixing a Hole</value>
  <!-- ...other tracks omitted for brevity... -->
  </list>
 </constructor-arg>
 </bean>

</beans>

注意:這里的c:_0和c:_1表示分別要傳入到構(gòu)造函數(shù)中的第一個參數(shù)和第二個參數(shù)的值，寫法等價于

<bean id="compactDisc"
  class="soundsystem.BlankDisc">
<constructor-arg value="Sgt. Pepper's Lonely Hearts Club Band"/>
<constructor-arg value="The Beatles">
</bean>

或者

<bean id="compactDisc"
  class="soundsystem.BlankDisc"
  c:_title="Sgt. Pepper's Lonely Hearts Club Band"
  c:_artist="The Beatles"/>

現(xiàn)在BlankDisc已經(jīng)配置在XML中，那么Spring如何去加載這個XML配置文件讀取到這個配置信息并加載呢。這里我們可以通過一個注解@ImportResource來完成這個操作。假設(shè)上面關(guān)于BlankDisc類的配置信息存放在cd-config.xml文件中，該文件在項目的根路徑下。通過修改SoundSystemConfig即可完成加載bean。

@Configuration
@Import(CDPlayerConfig.class)
@ImportResource("classpath:cd-config.xml")
public class SoundSystemConfig {

}

如上所示，一個是通過JavaConfig配置的CDPlayer，一個是通過XML聲明的BlankDisc，通過如上處理，實現(xiàn)了都能被Spring容器加載。

二、XML配置中引用JavaConfig

CDPlayerConfig徹底的矯情了一把，XML配置文件表示不服，CDPlayerConfig受不了兩個bean，那我就能受得了？（好好好，朕特批XML矯情一次）

其實我們都知道，在XML中聲明兩個bean不是什么大問題，即便受不了，我們還有一個這種方案，XML中也可以使用Import標(biāo)簽實現(xiàn)導(dǎo)入其他的XML配置文件并導(dǎo)入配置信息，好比這樣的

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:c="http://www.springframework.org/schema/c"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

 <import resource="cd-config.xml">

 <bean id="cdPlayer"
  class="soundsystem.CDPlayer"
  c:cd-ref="compactDisc" />
  
</beans>

注意:這里的c:cd-ref="compactDisc"等價于添加了屬性<constructor-arg ref="compactDisc"

但是XML認(rèn)為這樣它還是受不了，它將<import resource="cd-config.xml">換成了<bean class="soundsystem.CDConfig" /> 。這下暢快多了，因為這樣就實現(xiàn)了兩種配置的結(jié)合了，一種是配置在JavaConfig中的BlankDisc，還有一種是在XML中配置的CDPlayer。

測試

分別對于兩種方式編寫ut測試如下

ImportJavaConfigTest

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:cdplayer-config.xml")
public class ImportJavaConfigTest {

 @Rule
 public final StandardOutputStreamLog log = new StandardOutputStreamLog();

 @Autowired
 private MediaPlayer player;


 @Test
 public void play() {
 player.play();
 assertEquals(
  "Playing Sgt. Pepper's Lonely Hearts Club Band by The Beatles\r\n",
  log.getLog());
 }

}

ImportXmlConfigTest

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes=SoundSystemConfig.class)
public class ImportXmlConfigTest {

 @Rule
 public final StandardOutputStreamLog log = new StandardOutputStreamLog();

 @Autowired
 private MediaPlayer player;


 @Test
 public void play() {
 player.play();
 assertEquals(
  "Playing Sgt. Pepper's Lonely Hearts Club Band by The Beatles\r\n" +
  "-Track: Sgt. Pepper's Lonely Hearts Club Band\n\n" +
  "-Track: With a Little Help from My Friends\n\n" +
  "-Track: Lucy in the Sky with Diamonds\n\n" +
  "-Track: Getting Better\n\n" +
  "-Track: Fixing a Hole\n\n",
  log.getLog());
 }

}

測試結(jié)果