Spring - 装配bean

创建应用对象之间协作关系的行为通常称为装配（wiring），这也是依赖注入（DI）的本质

一、自动化装配bean（推荐方式）

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

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

1、创建可被发现的bean

@Component注解表明被注解的类会作为组件类，并告知Spring要为这个类创建bean

2、启用组件扫描

1）通过@ComponentScan注解启用组件扫描

@Configuration
@ComponentScan
public class ExampleConfig {
}

@ComponentScan注解能够在Spring中启用组件扫描，如果没有其他配置的话，@ComponentScan默认会扫描与配置类相同的包。配置类位于哪个包中，Spring则会扫描这个包以及这个包下的所有子包，查找带有@Component注解的类

2）通过XML启用组件扫描

<context:component-scan base-package="example"/>

<context:component-scan>元素会有与@ComponentScan注解相对应的属性和子属性

3、为组件扫描的bean命名

@Component("example")
public class example {
    ...
}

//使用Java依赖注入规范中所提供的@Named注解来为bean设置ID
@Named("example")
public class example {
    ...
}

Spring支持将@Named作为@Component注解的替代方案。两者之间有一些细微的差异，但是在大多数场景中，它们是可以互相替换的

4、设置组件扫描的基础包

按照默认规则，如果不为@ComponentScan设置任何属性，它会以配置类所在的包作为基础包

扫描不同的包或者扫描多个基础包：

@Configuration
@ComponentScan(basePackageClasses={example1.class, example2.class})
public class exampleConfig {}

在样例中，basePackageClasses设置的是组件类，但是可以考虑在包中创建一个用来进行扫描的空标记接口。通过标记接口的方式，依然能够保持对重构友好的接口引用，但是可以避免引用任何实际的应用程序代码（在稍后重构中，这些应用代码有可能会从想要扫描的包中移除掉）

5、通过为bean添加注解实现自动装配

简单来说，自动装配就是让Spring自动满足bean依赖的一种方法，在满足依赖的过程中，会在Spring应用上下文种寻找匹配某个bean需求的其他bean。为了声明要进行自动装配，可以借助Spring的@Autowired注解

@Component
public class CDPlayer implements MediaPlayer {
    private CompactDisc cd;

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

    public void play() {
        cd.play();
    }
}

@Autowired注解不仅能够用在构造器上，还能用在属性的Setter方法上

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

在Spring初始化bean之后，它会尽可能去满足bean的依赖，在本例中，依赖是通过带有@Autowired注解的方法进行声明的，也就是setCompactDisc()。实际上，Setter方法并没有什么特殊之处。@Autowired注解可以用在类的任何方法上。假设CDPlayer类有一个insertDisc()方法，那么@Autowired能够像在setCompactDisc()上那样，发挥完全相同的作用

@Autowired
public void insertDisc(CompactDisc cd) {
    this.cd = cd;
}

不管是构造器、Setter方法还是其他的方法，Spring都会尝试满足方法参数上所声明的依赖。假如有且只有一个bean匹配依赖需求的话，那么这个bean将会被装配进来。如果没有匹配的bean，那么在应用上下文创建的时候，Spring会抛出一个异常。为了避免异常的出现，可以将@Autowired的required属性设置为false

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

将required属性设置为false时，Spring会尝试执行自动装配，但是如果没有匹配的bean的话，Spring将会让这个bean处于未装配的状态。但是，如果代码中没有进行null检查的话，这个处于未装配状态的属性有可能会出现NullPointerException。如果有多个bean都能满足依赖关系的话，Spring将会抛出一个异常，表明没有明确指定要选择哪个bean进行自动装配（解决方案见Spring - 高级装配：自动装配中的歧义性）

@Inject注解来源于Java依赖注入规范，该规范同时还为我们定义了@Named注解。在自动装配中，Spring同时支持@Inject和@Autowired。尽管@Inject和@Autowired之间有着一些细微的差别，但是在大多数场景下，它们都是可以互相替换的

二、通过Java代码装配bean

1、创建配置类

@Configuration
public class CDPlayerConfig {
}

创建JavaConfig类（例如CDPlayerConfig）的关键在于为其添加@Configuration注解，@Configuration注解表明这个类是一个配置类

注意：JavaConfig类需要添加@ComponentScan注解进行组件扫描，才可以使被扫描的包里在JavaConfig类里已经声明的bean得以装配

2、声明简单的bean

在JavaConfig中声明bean，比方说，下面的代码声明了CompactDisc bean

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

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

3、借助JavaConfig实现注入 

1）构造器方式

@Bean
public CDPlayer cdPlayer() {
    return new CDPlyer(sgtPeppers());
}

cdPlayer()方法像sgtPeppers()方法一样，同样使用了@Bean注解，这表明这个方法会创建一个bean实例并将其注册到Spring应用上下文中。所创建的bean ID为cdPlayer，与方法名相同。cdPlayer的方法体与sgtPeppers()稍微有些区别。在这里并没有使用默认的构造器构建实例，而是调用了需要传入CompactDisc对象的构造器来创建CDPlayer实例。看起来，CompactDisc是通过调用sgtPeppers()得到的，但情况并非完全如此。因为sgtPeppers()方法上添加了@Bean注解，Spring将会拦截所有对它的调用，并确保直接返回该方法所创建的bean，而不是每次都对其进行实际的调用

比如说，假设你引入了一个其他的CDPlayer bean，它和之前的那个bean完全一样

@Bean
public CDPlayer cdPlayer() {
    return new CDPlyer(sgtPeppers());
}

@Bean
public CDPlayer antherCDPlayer() {
    return new CDPlyer(sgtPeppers());
}

假如对sgtPeppers()的调用就像其他的Java方法调用一样的话，那么每个CDPlayer实例都会有一个自己特有的SgtPeppers实例。如果我们讨论的是实际的CD播放器和CD光盘的话，这么做是有意义的。如果你有两台CD播放器，在物理上并没有办法将同一张CD光盘放到两个CD播放器中。但是，在软件领域中，我们完全可以将同一个SgtPeppers实例注入到任意数量的其他bean之中。默认情况下，Spring中的bean都是单例的，我们并没有必要为第二个CDPlayer bean创建完全相同的SgtPeppers实例。所以，Spring会拦截对sgtPeppers()的调用并确保返回的是Spring所创建的bean，也就是Spring本身在调用sgtPeppers()时所创建的CompactDisc bean。因此，两个CDPlayer bean会得到相同的SgtPeppers实例

通过调用方法来引用bean的方式有点令人困惑。其实还有一种理解起来更为简单的方式

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

在这里，cdPlayer()方法请求一个CompactDisc作为参数。当Spring调用cdPlayer()创建CDPlayer bean的时候，它会自动装配一个CompactDisc到配置方法之中。然后，方法体就可以按照合适的方式来使用它。借助这种技术，cdPlayer()方法也能够将CompactDisc注入到CDPlayer的构造器中，而且不用明确引用CompactDisc的@Bean方法

通过这种方式引用其他的bean通常是最佳的选择，因为它不会要求将CompactDisc声明到同一个配置类之中。在这里甚至没有要求CompactDisc必须要在JavaConfig中声明，实际上它可以通过组件扫描功能自动发现或者通过XML来进行配置。可以将配置分散到多个配置类、XML文件以及自动扫描和装配bean之中，只要功能完整健全即可。不管CompactDisc是采用什么方式创建出来的，Spring都会将其传入到配置方法中，并用来创建CDPlayer bean

2）Setter方式

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

带有@Bean的注解的方法可以采用任何必要的Java功能来产生bean实例。构造器和Setter方法只是@Bean方法的两个简单样例。这里存在的可能性仅仅受到Java语言的限制

三、通过XML装配bean

1、创建XML配置规范

借助Spring Tool Suite创建配置文件

<?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>

用来装配bean的最基本的XML元素包含在spring-beans模式中，在上面这个XML文件中，它被定义为根命名空间。<beans>是该模式中的一个元素，它是所有Spring配置文件的根元素

2、声明一个简单的<bean>

<bean id="compactDisc" class="soundsystem.SgtPeppers" />

稍后将这个bean装配到CDPlayer bean之中的时候，会用到这个id

为了减少XML中繁琐的配置，只对那些按名字引用的bean（比如，需要将对它的引用注入到另外一个bean中）进行明确地命名

3、借助构造器注入初始化bean（构造器方式注入）

<bean id="cdPlayer" class="soundsystem.CDPlayer">
    <constructor-arg ref="compactDisc" />
</bean>

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

作为替代的方案，可以使用Spring的c-命名空间

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

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

附：

1）将字面量注入到构造器中（例：构造器所需传入参数的类型是String）

<bean id="cdPlayer" class="soundsystem.CDPlayer">
    <constructor-arg value="example" />
</bean>

<!-- c-命名空间 -->
<bean id="cdPlayer" class="soundsystem.CDPlayer"
      c:_artist="example" />
</bean>

2）装配集合（例：构造器所需传入参数的类型是集合）

<!-- list是基本类型 -->
<bean id="cdPlayer" class="soundsystem.CDPlayer">
    <constructor-arg>
        <list>
            <value>xxx</value>
            <value>yyy</value>
            <value>zzz</value>
        </list>
    </constructor-arg>
</bean>

<!-- list是对象类型 -->
<bean id="cdPlayer" class="soundsystem.CDPlayer">
    <constructor-arg>
        <list>
            <ref bean="xxx" />
            <ref bean="yyy" />
            <ref bean="zzz" />
        </list>
    </constructor-arg>
</bean>

<!-- set是对象类型 -->
<bean id="cdPlayer" class="soundsystem.CDPlayer">
    <constructor-arg>
        <set>
            <ref bean="xxx" />
            <ref bean="yyy" />
            <ref bean="zzz" />
        </set>
    </constructor-arg>
</bean>

注意：目前，使用c-命名空间的属性无法实现装配集合的功能

4、设置属性（Setter方式注入）

作为一个通用的规则，对强依赖使用构造器注入，而对可选性的依赖使用属性注入

public class CDPlayer {
    private CompactDisc compactDisc;

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

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

现在，CDPlayer没有任何的构造器（除了隐含的默认构造器），它也没有任何的强依赖。因此，可以采用如下的方式将其声明为Spring bean： 

<bean id="cdPlayer" class="soundsystem.CDPlayer" />

Spring在创建bean的时候不会有任何的问题，但是测试时执行play()方法会出现NullPointerException而导致测试失败，因为并没有注入CDPlayer的compactDisc属性（这里需要理清楚：因为CDPlayer除了隐含的默认构造器之外没有任何构造器，通过构造器方式注入时调用play()方法是会报错的，所以采用setter方式注入）。不过，按照如下的方式修改XML，就能解决该问题：

<bean id="cdPlayer" class="soundsystem.CDPlayer">
    <property name="compactDisc" ref="compactDisc" />
</bean>

<property>元素为属性的Setter方法所提供的功能与<constructor-arg>元素为构造器所提供的功能是一样的

Spring为<constructor-arg>元素提供了c-命名空间作为替代方案，与之类似，Spring提供了更加简洁的p-命名空间，作为<property>元素的替代方案

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

p-命名空间中属性所遵循的命名约定与c-命名空间中的属性类似 

附：

1）将字面量/集合注入到属性中（例：构造器所需传入参数的类型是String和List）

<bean id="compactDisc"
      class="soundsystem.BlankDisc">
    <property name="title" value="example" />
    <property name="tracks">
        <list>
            <value>xxx</value>
            <value>yyy</value>
            <value>zzz</value>
        </list>
    </property>
</bean>

<!-- p-命名空间 -->
<bean id="compactDisc"
      class="soundsystem.BlankDisc"
      p:title="example">
    <property name="tracks">
        <list>
            <value>xxx</value>
            <value>yyy</value>
            <value>zzz</value>
        </list>
    </property>
</bean>

与c-命名空间一样，装配bean引用与装配字面量的唯一区别在于是否带有"-ref"后缀。如果没有"-ref"后缀的话，所装配的就是字面量，但是需要注意的是，不能使用p-命名空间来装配集合