Spring实战——XML和JavaConfig的混合配置

关于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如何融洽的配合起来。
阅读更多

没有更多推荐了,返回首页