Spring Bean装配学习

解释：所谓装配就是把一个类需要的组件给它设置进去，英文就是wire，wiring；注解Autowire也叫自动装配。

目前Spring提供了三种配置方案：

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

就我个人而言，用XML和自动装配混搭最多，用Java代码进行装配用的最少，几乎不用。这三种配置方案提供的功能会有重叠，大部分都可以根据个人喜好来选择。Spring的配置风格是可以相互搭配的，三种方式可以共存。

三者的适用范围：

XML > JavaConfig > 注解

自动化装配bean

自动化装配最为便利，写的东西最少，用起来很快。要实现自动化装配可以从两个方面来看：

组件扫描（component scanning）：Spring会自动发现应用上下文中所创建的bean

自动装配（autowiring）：Spring自动满足bean之间的依赖

具体的步骤可以用下图来描述：

创建可被发现的bean

这里用CD播放器来先演示依赖注入（Dependency Inject）。

涉及到的类图如下：

CompactDisc接口

1 package soundsystem;
2 
3 public interface CompactDisc {
4     void play();
5 }

CompactDisk接口的实现类：SgtPeppers

 1 package soundsystem;
 2 
 3 import org.springframework.stereotype.Component;
 4 
 5 @Component
 6 public class SgtPeppers implements CompactDisc {
 7 
 8     private String title = "Sgt. Pepper's Lonely Hearts Club Band";
 9     private String artist = "The Beatles";
10 
11     public void play() {
12         System.out.println("Playing " + title + " by " + artist);
13     }
14 }

开启组件扫描的Java配置类：CDPlayerConfig

1 package soundsystem;
2 
3 import org.springframework.context.annotation.ComponentScan;
4 import org.springframework.context.annotation.Configuration;
5 
6 @Configuration
7 @ComponentScan
8 public class CDPlayerConfig {
9 }

测试类：CDPlayerConfig

 1 package soundsystem;
 2 
 3 import org.junit.Test;
 4 import org.junit.runner.RunWith;
 5 import org.springframework.beans.factory.annotation.Autowired;
 6 import org.springframework.test.context.ContextConfiguration;
 7 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 8 import org.springframework.util.Assert;
 9 
10 @RunWith(SpringJUnit4ClassRunner.class)
11 @ContextConfiguration(classes=CDPlayerConfig.class)
12 public class CDPlayerTest {
13 
14     @Autowired
15     private CompactDisc cd;
16 
17     @Test
18     public void cdShouldNotBeNull() {
19         Assert.notNull(cd, "inject failed");
20     }
21 }

只需简单几步即可实现依赖注入，很强大。

解释说明：

给SgtPeppers用了@Component这个注解后，Spring会为这个类去创建bean。

组件扫描默认是不启用的，需要显式的配置Spring让其去寻找带有@Component注解的类，并为其创建bean。

开启组件扫描的任务是CDPlayerConfig来实现的，通过Java代码定义了Spring的装配规则。

如果没有其他的配置，@ComponentScan默认扫描与配置类相同的包。

@CDPlayerConfig类位于soundsystem包中，Spring将会扫描这个包和这个包下的所有子包。

如果用XML来开启组件扫描的话，可以使用<context:component-scan>元素：<context:component-scan base-package="soundsystem" />

测试类中用到了两个注解：SpringJUnit4ClassRunner会在测试的时候自动创建Spring的应用上下文，@ContextConfiguration会告诉它需要在CDPlayerConfig类中加载配置，然后类CDPlayerConfig中包含了@ComponentScan，所以上下文中会包含CompactDisc的bean。

为组件扫描的bean命名

Spring应用上下文中所有的bean都会有一个ID。如果想之前的例子那样没有明确的给出bean的ID，Spring会根据类名为其指定一个ID。第一个类名小写。

如果想为bean设置不同的ID，可以将期望的ID传给注解@Component。如下：

 1 package soundsystem;
 2 
 3 import org.springframework.stereotype.Component;
 4 
 5 @Component("lonelyHeartsClub")
 6 public class SgtPeppers implements CompactDisc {
 7 
 8     private String title = "Sgt. Pepper's Lonely Hearts Club Band";
 9     private String artist = "The Beatles";
10 
11     public void play() {
12         System.out.println("Playing " + title + " by " + artist);
13     }
14 }

另一种是使用Java依赖注入规范所提供的@Named注解来为bean设置ID（几乎没用过），大多数场景可以替换使用。

可用的注解还有：@Service，@Repository等

设置组件扫描的基础包

对于包的扫描有以下几点可以记一下：

不设置任何属性：配置类所在的包为基包，会以配置类所在的包作为基础包（base package）来扫描组件。

只设置value：指定基包

设置basePackages属性：更明确的指定了基包，而且给定的字符串作为基包

设置basePackageClasses属性：明确地指定了类所在的包为基包

空标记接口：可以将实际的应用代码和配置代码分开

总结如下：

// 啥属性没有, 就是以CDPlayerConfig所在的类为基包
@Configuration
@ComponentScan
public class CDPlayerConfig { }
// 指定了value属性, 以value指代的包为基包

@Configuration

@ComponentScan("soundsystem")

public class CDPlayerConfig { }
// 明确指定了基包组

@Configuration

@ComponentScan(basePackages = "soundsystem")

public class CDPlayerConfig { }
// 指定了类所在的包为基包, 可以用一个标记接口替换实际的应用类

@Configuration

@ComponentScan(basePackageClasses = {CDPlayer.class, DVDPlayer.class)

public class CDPlayerConfig { }

为bean添加注解实现自动装配

如果只是把类通过加上Component注解并进行了组件扫描来交给Spring管理，生成bean其实还不够。很多对象都会依赖其他对象协作完成任务。这样的话就需要一种方法能将组件扫描得到的bean和它们的依赖装配到一起，这就是自动装配。这里借助的是Spring的Autowired注解。

@Autowire注解不仅能用在构造器上还可以用在属性的setter方法上（不仅仅是setter方法，Autowired可以用在类的任何方法上）。

在Spring初始化了bean之后，它会尽可能地去满足bean的依赖。

如果没有匹配的bean，那么在应用上下文创建的时候Spring会抛出一个异常，为了避免异常可以将Autowired的required属性设置为false。这样的话Spring会尝试执行自动装配，但是如果没有匹配的bean的话，Spring将会让这个bean处于未装配的状态（如果没有装配的话，使用的时候可能会报NullPointerException）。

如果有多个bean都能满足依赖关系的话，Spring将会抛出一个异常，表明没有明确指定哪个bean来自动装配。

@Autowired是Spring的独有注解，你还可以使用@Inject和@Resource。

Java代码装配bean

还可以用Java代码来做配置，之前只是用Hibernate的时候用过类进行配置，我用的也比较少。可能是因为喜欢吧配置归配置，代码归代码吧。

组件扫描和自动装配的一个局限在于：有时候行不通。比如你要想在第三方的库中的组件装配到你的应用中，这种情况下是没法给它的类加上@Component和@Autowired注解的，这时候自动装配就用不了了。另一种就是用Java代码来配置。

优点：强大、类型安全，对重构友好，和普通的Java代码一样

注意：配置代码不应该侵入到业务逻辑代码中，最好是放在单独的包中，和其他的应用逻辑分开

创建配置类

创建JavaConfig类很简单：只需要为其添加@Configuration注解就可以了，就表明它是一个配置类。

声明简单的bean

要在JavaConfig中声明bean，需要编写一个方法，这个方法会创建所需类型的实例，然后给这个方法添加@Bean注解：

1 @Bean
2 public CompactDisc sgtPeppers() {
3     return new SgtPeppers();
4 }

@Bean注解会告诉Spring这个方法会返回一个对象，该对象要注册为Spring应用上下文的bean。

默认情况下，bean的ID和带有@Bean注解的方法名一样，可以为Bean加上name属性，或者修改方法名来设置ID。

借助JavaConfig实现注入

通过Java代码组装的方法也比较别致。

1 @Bean
2 public CDPlayer cdPlayer() {
3     return new CDPlayer(sgtPeppers());
4 }

要注意这里的sgtPeppers()不是普通的方法，而是加了Bean注解的方法，Spring会拦截对这个方法的所有调用，并确保返回该方法所创建的bean，而不是每次进行实际的调用。（这个有点意思呀，拦截）。

可以将SgtPeppers的实例注入到任意数量的其他bean之中。默认情况下Spring中的bean都是单例的。

1 @Bean
2 public CDPlayer cdPlayer(CompactDisc compactDisc) {
3     return new CDPlayer(compactDisc);
4 }

上面是通常引用其他bean最佳的选择，因为它不会要求CompactDisc声明到同一个配置中，甚至不需要CompactDisc在JavaConfig中声明，只要Spring应用上下文中有就可以了。个人对于这种方法还是不太习惯。

XML装配bean

创建XML配置规范

XML文件中要以<beans>为根元素

声明一个简单的<bean>

1 <bean class="soundsystem.SgtPeppers" />

如果没有给定明确的ID，bean将会根据全限定的类名来进行命名。本例中将会是："soundsystem.SgtPeppers#0"，其中"#0"是一个计数形式，如果声明了一个另外的SgtPeppers，那么它自动的到的ID回事"soundsystem.SgtPeppers#1"。

通产来讲最好的方法是借助id属性，为每一个bean设置一个合适的名字。

借助构造器注入初始化的bean

在XML中进行依赖注入的时候，往往有多种可选的配置方案和风格。

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

如果不使用ref，而是使用value，则表示将字面量注入进去：

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

装配集合

这个就不具体讲了，到了要用的时候来查一下就可以，list，set和数组都可以装配，就是set使用的时候重复的值会被忽略掉，而且不能保证顺序。

设置属性

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

属性也可以注入字面量，集合。

导入和混合配置

以上的三种装配方案可以混合使用，而且自动装配的时候不会介意你的bean来自于哪里。

JavaConfig导入其他的JavaConfig以及XML

1 @Configuration
2 @Import(CDConfig.class)
3 public class CDPlayerConfig {
4 
5     @Bean
6     public CDPlayer cdPlayer(CompactDisc compactDisc) {
7         return new CDPlayer(compactDisc);
8 
9 }

或者采用更高级别的配置类来导入：

1 @Configuration
2 @Import({CDPlayerConfig.class, CDConfig.class})
3 public class SoundSystemConfig {
4 
5 }

如果要导入XML配置的话：使用@ImportResource注解，使用相对于根类路径的地址

1 @Configuration
2 @Import({CDPlayerConfig.class})
3 @ImportResource("classpath:cd-config.xml")
4 public class SoundSystemConfig {
5 
6 }

XML配置中引用JavaConfig

XML可以用<import>标签导入其他的XML配置，用<bean class="soundsystem.CDConfig" />可以可以导入Java配置类。其实很简单的~