Spring實戰——XML和JavaConfig的混合配置


前言

看了園齡已經兩年多了,再不能寫完內容直接點擊發布,留下一片密密麻麻的文字讓別人看的頭昏腦漲。所以現在每次寫完主要內容后,還需要對於格式稍稍調整下。那么有沒有什么編輯模式能夠在你寫完文章后基本也把格式調的八九不離十,不會辣眼睛呢,當然有,那就是Markdown
本篇就在Markdown編輯環境下說說Spring的導入和混合配置

上篇提到了關於Spring的顯示配置方式有兩種,一種是基於XML配置,一種是基於JavaConfig的方式配置。對於這兩種配置方式並不是互斥關系,相反,他們兩能夠相互融合,有效的搭配完成Spring的bean注入。
這里分別介紹如何在JavaConfig中引用XML配置的bean以及如何在XML配置中引用JavaConfig。


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。假設讓CDPlayerConfig現在矯情一把,它認為自己內部注冊的bean太多了,它有點管不過來了(確實有點矯情過了),它准備把compactDisc這個bean踢出去,讓別人來管管。

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

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

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

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

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

}

這樣就解決了在一個配置類中要加載的bean過多的問題。
那么問題來了,如果這時候CompactDisc接口的實現類BlankDisc是聲明在XML中,這兩種顯示聲明又會如何結合呢。

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:_0c:_1表示分別要傳入到構造函數中的第一個參數和第二個參數的值,寫法等價於

<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"/>

現在BlankDisc已經配置在XML中,那么Spring如何去加載這個XML配置文件讀取到這個配置信息並加載呢。這里我們可以通過一個注解@ImportResource來完成這個操作。假設上面關於BlankDisc類的配置信息存放在cd-config.xml文件中,該文件在項目的根路徑下。通過修改SoundSystemConfig即可完成加載bean。

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

}

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


XML配置中引用JavaConfig

CDPlayerConfig徹底的矯情了一把,XML配置文件表示不服,CDPlayerConfig受不了兩個bean,那我就能受得了?(好好好,朕特批XML矯情一次
其實我們都知道,在XML中聲明兩個bean不是什么大問題,即便受不了,我們還有一個這種方案,XML中也可以使用Import標簽實現導入其他的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">

  <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認為這樣它還是受不了,它將<import resource="cd-config.xml">換成了<bean class="soundsystem.CDConfig" />。這下暢快多了,因為這樣就實現了兩種配置的結合了,一種是配置在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());
  }

}

測試結果

至此,我們領略了

  • JavaConfig中引用XML配置的bean
  • XML配置中引用JavaConfig
    這兩種顯示配置bean如何融洽的配合起來。

如果您覺得閱讀本文對您有幫助,請點一下“推薦”按鈕,您的“推薦”將是我最大的寫作動力!如果您想持續關注我的文章,請掃描二維碼,關注JackieZheng的微信公眾號,我會將我的文章推送給您,並和您一起分享我日常閱讀過的優質文章。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM