Spring实战（二）-装配Bean

作者: 阳光的技术小栈 | 来源:发表于2018-07-18 10:16 被阅读45次

本文基于《Spring实战（第4版）》所写。

Spring提供了三种主要的装配机制：

在XML中进行显示配置
在Java中进行显示配置
隐士的bean发现机制和自动装配

自动化装配bean

Spring从两个角度来实现自动化装配：

组件扫描：Spring会自动发现应用上下文中所创建的bean。
自动装配：Spring自动满足bean之间的依赖。

二者结合使用，能够将显示配置降低到最少。

首先来一个示例：CD与CD播放器。
如果你不将CD插入到CD播放器中，那么CD播放器其实是没有太大用处的。

定义CD接口：

package com.springinaction;

public interface CompactDisc {
    void play();
}

CD的一个实现类，使用@Component告知Spring要为这个类创建bean。

package com.springinaction;
import org.springframework.stereotype.Component;

@Component
public class SgtPeppers implements CompactDisc {

    private String title = "Sgt. Pepper's Lonely Hearts Club Band";
    private String artist = "The Beatles";

    @Override
    public void play() {
        System.out.println("Playing " + title + " by " + artist);
    }
}

使用基于Java的Spring配置，使用@ComponentScan默认会扫描与配置类相同的包。

package com.springinaction;
import org.springframework.context.annotation.*;

@Configuration
@ComponentScan
public class CDPlayerConfig {
}

如果要是用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:Context = "http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd">
    <Context:component-scan base-package="com.springinaction" />
</beans>

使用JUnit进行测试，测试CD的实现类是否被Spring自动创建

package com.springinaction;

import static org.junit.Assert.*;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes=CDPlayerConfig.class)
public class CDPlayerTest {

    @Autowired
    private CompactDisc sgtPeppers;

    @Test
    public void cdShouldNotBeNull(){
        assertNotNull(sgtPeppers);
    }
}

测试结果

测试成功

此例展示了Spring创建bean的过程以及测试，其中SgtPeppers的bean并没有明确设置ID,但Spring会自动指定，默认为sgtPeppers，首字母为小写。如果想为这个bean设置不同的ID，可以用以下方式：

@Component("lonelyHeartsClub")
public class SgtPeppers implements CompactDisc {
    .......
}

到现在，我们没有为@ComponentScan设置任何属性。这意味这，按照默认规则，它会以配置类所在的包作为基础包（basepackage）来扫描组件。

如果我们想要将配置类放在单独的包中，使其与其他的应用代码区分开来。那么可用以下方式设置：

@Configuration
@ComponentScan("com.springinaction")
public class CDPlayerConfig { }

或者更加清晰地表明所设置的是基础包

@Configuration
@ComponentScan(basePackages="com.springinaction")
public class CDPlayerConfig { }

也可以设置多个基础包

@Configuration
@ComponentScan(basePackages={"com.springinaction", "video"})
public class CDPlayerConfig { }

除了以上的方式还可以将其指定为包中所包含的类或接口：

@Configuration
@ComponentScan(basePackageClasses={CDPlayer.class, DVDPlayer.class})
public class CDPlayerConfig { }

这些类所在的包将会作为组件扫描的基础包。

系统中大部分类还是存在相互依赖的现象，所以我们就需要了解自动装配。
简单来说，自动装配就是让Spring自动满足bean依赖的一种方法，在满足依赖的过程中，会在Spring应用上下文中寻找匹配某个bean需求的其他bean。为了声明要进行自动装配，我们可以借助Spring的@Autowired注解。

比如实现CD播放器的类，播放器接口是有一个play方法

package com.springinaction;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class CDPlayer implements MediaPlayer {

    private CompactDisc compactDisc;

    @Autowired
    public CDPlayer(CompactDisc compactDisc){
        this.compactDisc = compactDisc;
    }

    @Override
    public void play() {
        compactDisc.play();
    }
}

以上使用的是自动装配构造器，还能用在属性Setter方法上

    @Autowired
    public void setCompactDisc(CompactDisc compactDisc){
        this.compactDisc = compactDisc;
    }

如果没有匹配的bean,那么在应用上下文创建时，Spring会抛出一个异常。为了避免异常的出现，你可以将@Autowired的required属性设置为false:

    @Autowired(required=false)
    public CDPlayer(CompactDisc compactDisc){
        this.compactDisc = compactDisc;
    }

如果有多个bean都能满足依赖关系的话，Spring将会抛出一个异常。
另：@Autowired可以用@Inject代替

现在，我们已经在CDPlayer的构造器中添加了@Autowired注解，Spring将把一个可分配给CompactDisc类型的bean自动注入进来，为了验证，我们进行测试

package com.springinaction;

import static org.junit.Assert.*;

import org.junit.Test;
import org.junit.Rule;
import org.junit.contrib.java.lang.system.SystemOutRule;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes=CDPlayerConfig.class)
public class CDPlayerTest {

    @Rule
    public final SystemOutRule log = new SystemOutRule().enableLog();

    @Autowired
    private CompactDisc sgtPeppers;

    @Autowired
    private CDPlayer cdPlayer;

    @Test
    public void cdShouldNotBeNull(){
        assertNotNull(sgtPeppers);
    }

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

    }
}

测试结果

测试成功

通过Java代码装配bean

当自动化的方案行不通的时候，就必须采用显示装配的方式。显示装配有两种可选方案：JavaConfig和XML。其中JavaConfig是更好的方案，因为它更为强大、类型安全并且对重构友好。

继续上面的示例代码，首先创建配置类

package com.springinaction;
import org.springframework.context.annotation.*;

@Configuration
public class CDPlayerConfig {
}

@Configuration注解表明这个类是一个配置类，该类应该包含在Spring应用上下文中如何创建bean的细节。
我们移除之前的@ComponentScan，使用显示配置

@Bean
    public CompactDisc sgtPeppers(){
        return new SgtPeppers();
    }

@Bean注解会告诉Spring这个方法将会返回一个对象，该对象要注册为Spring应用上下文中的bean。方法体中包含了最终产生bean实例的逻辑。

默认情况下，bean的ID与带有@Bean注解的方法名一样。在本例中，bean的名字将会是sgtPeppers。也可以重命名

@Bean(name="lonelyHeartsClubBand")
    public CompactDisc sgtPeppers(){
        return new SgtPeppers();
    }

下面我们将CD注入到CDPlayer中

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

需要注意的有两点：

构造器中不能用new创建的对象（这个对象的类是已经在Spring中被声明的），因为Spring会拦截所有对已声明对象的调用，并确保直接返回该方法所创建的bean。这是由于Spring所创建的bean都是单例的。
compactDisc会在Spring中寻找已经实现CompactDisc的bean。

通过XML装配bean

先来看最简单的SpringXML配置

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

借助Spring Tool Suite创建XML配置文件创建和管理Spring XML配置文件的一种简便方式是使用Spring Tool Suite（https://spring.io/tools/sts）。

我们来简单声明一个bean

 <bean id="compactDisc" class="com.springinaction.SgtPeppers" />

下面我们来看一些特征

不再需要直接负责创建SgtPeppers的实例，而在基于JavaConfig的配置中需要。当Spring发现这个<bean>元素时，它将会调用SgtPeppers的默认构造器来创建bean。
这个bean中，我们将bean的类型以字符串的形式设置了class属性中。没有类型检查。

XML声明DI时，会有很多种可选的配置方案和风格。具体到构造器注入，有两种基本的配置方案可供选择：

<constructor-arg>元素
使用Spring3.0所引入的c-命名空间

先来看一下他们各组如何注入bean引用

构造器注入bean引用

<bean id="cdPlay" class="com.springinaction.CDPlayer" >
        <constructor-arg ref="compactDisc"/>
</bean>

当Spring遇到这个<bean>元素时，它会创建一个CDPlayer实例。<constructor-arg>元素会告知Spring要将一个ID为compactDisc的bean引用传递到CDPlayer的构造器中。

作为替代方案，也可以使用Spring的c-命名空间。以下是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">
      ....
</beans>

在c-命名空间和模式声明之后，我们就可以使用它来声明构造器参数了，如下所示：

<bean id="cdPlay" class="com.springinaction.CDPlayer" c:cd-ref="compactDisc" />

c的属性的说明如下：

spring的c标签的构造器属性

属性名以“c:”开头，也就是命名空间的前缀。接下来就是要装配的构造器参数名，在此之后是“-ref”，这是一个命名的约定，它会告诉Spring，正在装配的是一个bean的引用，这个bean的名字是compactDisc，而不是字面量“compactDisc”。

还可以将其中引用参数的名称替换成位置信息：

<bean id="cdPlay" class="com.springinaction.CDPlayer" c:_0-ref="compactDisc" />

其中“0”代表参数的索引。
下面我们看一下如何将字面量如何装配到对象中去。
我们先新建一个CompactDisc的实现：

package com.springinaction;

import java.util.List;

public class BlankDisc implements CompactDisc {

    private String title;
    private String artist;

    public BlankDisc(String title, String artist){
        this.title = title;
        this.artist = artist;
    }

    @Override
    public void play() {
        System.out.println("Playing " + title + " by " + artist);
    }
}

这个实现类中，cd名称和艺术家是可以从构造器注入的。比SgtPeppers的硬编码要灵活。现在我们将已有的SgtPeppers替换为这个类：

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

还可以替换为c标签写法：

<bean id="compactDisc" class="com.springinaction.BlankDisc" c:title="Sgt. Pepper's Lonely Hearts Club Band"
          c:artist="The Beatles"/>

也可以用索引：

<bean id="compactDisc" class="com.springinaction.BlankDisc" c:_0="Sgt. Pepper's Lonely Hearts Club Band"
          c:_1="The Beatles"/>

通常<constructor-arg>和c-命名空间的功能是相同的，但一种情况是<constructor-arg>能实现，但c-却做不到。

现在我们将BlankDisc加入多磁道的属性，并在构造器中能注入。

package com.springinaction;
import java.util.List;

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;
    }

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

最简单的方式是将列表设置为null

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

更好的解决方法是提供一个磁道名称的列表。
方案一：

  <bean id="compactDisc" class="com.springinaction.BlankDisc" >
        <constructor-arg value="Sgt. Pepper's Lonely Hearts Club Band"/>
        <constructor-arg value="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>
            </list>
        </constructor-arg>
</bean>

方案二：
假如构造器的参数还有List<CompactDisc>,那就使用<ref>元素代替<value>。

<constructor-arg>
   <list>
     <ref bean="sgtPeppers" />
     <ref bean="whiteAlbum" />
     .....
   </list>
</constructor-arg>

如果构造器的参数类型是Set，可以把<list>替换为<set>

除了使用构造器注入，我们还可以使用属性的Setter方法进行注入。
假设注入的CDPlayer如下所示

package com.springinaction;

public class CDPlayer implements MediaPlayer {

    private CompactDisc compactDisc;

    public void setCompactDisc(CompactDisc compactDisc){
        this.compactDisc = compactDisc;
    }

    @Override
    public void play() {
        compactDisc.play();
    }
}

Spring的XML注入如下：

  <bean id="cdPlayer" class="com.springinaction.CDPlayer">
        <property name="compactDisc" ref="sgtPeppers" />
  </bean>

如果运行测试的话，它应该就能通过了。
还有用p标签的方式替代，需要先声明：

 <?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:p="http://www.springframework.org/schema/p"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd">
    .....
</beans>

使用p-命名空间，装配如下：

    <bean id="cdPlayer" class="com.springinaction.CDPlayer" p:compactDisc-ref="sgtPeppers" />

p-命名空间的描述如下：

spring的p便签的setter方式注入

介绍完bean注入，接下来介绍字面量注入属性
重新修改BlankDisc，使其所有属性都有setter方法

package com.springinaction;

import java.util.List;

public class BlankDisc implements CompactDisc {

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

    public void setTitle(String title){
        this.title = title;
    }

    public void setArtist(String artist){
        this.artist = artist;
    }

    public void setTracks(List<String> tracks){
        this.tracks = tracks;
    }

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

实现SpringXML的属性注入

<bean id="compactDisc" class="com.springinaction.BlankDisc" >
        <property name="title" value="Sgt. Pepper's Lonely Hearts Club Band"/>
        <property name="artist" value="The Beatles" />
        <property name="tracks">
            <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>
            </list>
        </property>
</bean>

也可以用p-命名空间来替代：

<bean id="compactDisc" class="com.springinaction.BlankDisc" p:title="Sgt. Pepper's Lonely Hearts Club Band"
    p:artist="The Beatles" p:tracks-ref="trackList"/>

    <util:list id="trackList">
        <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>
        <!--<ref bean="sgtPepper"></ref>-->
    </util:list>

如果想使用util-命名空间，则需要以下声明：

<?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:p="http://www.springframework.org/schema/p"
       xmlns:util="http://www.springframework.org/schema/util"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/util
       http://www.springframework.org/schema/util/spring-util.xsd">
</beans>

导入和混合配置

想在JavaConfig中引用XML配置或者导入其他配置类，如下所示：

package com.springinaction;
import org.springframework.context.annotation.*;

@Configuration
@Import(CDConfig.class)     // 导入单个配置类
@Import({CDConfig.class, CDPlayingConfig.class})   // 导入多个配置类
@ImportResource("classpath:soundsystem.xml") // 导入xml文件
public class CDPlayerConfig {
}

想在XML配置中引用JavaConfig, 如下所示
sgtPeppers在JavaConfig配置，CDPlayer继续在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 class="com.springinaction.CDConfig" />
        <bean id="cdPlay" class="com.springinaction.CDPlayer" c:cd-ref="sgtPeppers" />
</beans>

如果把XML的一部分配置独立写到一个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 class="com.springinaction.CDConfig" />
    <import resource="cdplayer-config.xml"/>
</beans>

Spring实战（二）-装配Bean

自动化装配bean

通过Java代码装配bean

通过XML装配bean

导入和混合配置

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读