Spring实战之二装配Bean

整理自:《Spring实战》

二、装配Bean

2.1 三种装配方式

2.2 自动化装配

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

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

2.2.1 创建可被发现的bean

接口类：

package soundsystem;

public interface CompactDist {
	void play();
}

带有@Component注解的CompactDisc实现类

package soundsystem;

@Component
public class SgtPeppers implements CompactDist{
	private String title = "xxxx";
	private String article = "The Beatles";

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

注意：组件扫描默认是不启用的。我们还需要显式配置一下Spring，从而命令它去寻找带有@Component注解的类，并为其创建bean。下面利用@ComponentScan注解启用了组件扫描：

package soundsystem;

@Configuration
@ComponentScan
public class CDPlayerConfig{
}

@ComponentScan默认会扫描与配置类相同的包。

如果你更倾向于使用XML来启用组件扫描的话，那么可以使用Spring context命名空间的<context:component-scan>元素：

<context:compoment-scan base-package="soundsystem"/>

测试：

package soundsystem;

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

	@Autowired
	private CompactDisc cd;

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

CDPlayerTest使用了Spring的SpringJUnit4ClassRunner，以便在测试开始的时候自动创建Spring的应用上下文。注解@ContextConfiguration会告诉它需要在CDPlayerConfig中加载配置。因为CDPlayerConfig类中包含了@ComponentScan，因此最终的应用上下文中应该包含CompactDiscbean。

2.2.2 为组件扫描的bean命名

Spring应用上下文中所有的bean都会给定一个ID。若无指定，Spring会根据类名为其指定一个ID，即将类名的第一个字母变为小写。如果想为这个bean设置不同的ID，你所要做的就是将期望的ID作为值传递给@Component注解。如：@Component(“lonelyHeartsClub”).

还有另外一种为bean命名的方式，这种方式不使用@Component注解，而是使用Java依赖注入规范（Java Dependency Injection）中所提供的@Named注解来为bean设置ID：@Named(“lonelyHeartsClub”).

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

2.2.3 设置组件扫描的基础包

按照默认规则，@ComponentScan会以配置类所在的包作为基础包（base-package）来扫描组件。但是，如果你想扫描不同的包，那该怎么办呢？或者，如果你想扫描多个基础包，那又该怎么办呢？

有一个原因会促使我们明确地设置基础包，那就是我们想要将配置类放在单独的包中，使其与其他的应用代码区分开来。如果是这样的话，那默认的基础包就不能满足要求了。

要满足这样的需求其实也完全没有问题！为了指定不同的基础包，你所需要做的就是在@ComponentScan的value属性中指明包的名称：@ComponentScan(“soundsystem”).

如果你想更加清晰地表明你所设置的是基础包，那么你可以通过basePackages属性进行配置：@ComponentScan(basePackages=“soundsystem”).
如果要设置多个基础包，只需要将basePackages属性设置为要扫描包的一个数组即可：@ComponentScan(basePackages={“soundsystem”,“video”}).

在上面的例子中，所设置的基础包是以String类型表示的。我认为这是可以的，但这种方法是类型不安全（not type-safe）的。如果你重构代码的话，那么所指定的基础包可能就会出现错误了。

除了将包设置为简单的String类型之外，@ComponentScan还提供了另外一种方法，那就是将其指定为包中所包含的类或接口：@ComponentScan(basePackageClasses={CDPlayer.class,DVDPlayer.class}).这些类所在的包将会作为组件扫描的基础包。

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

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

@Autowired注解，可以用在类的构造器、get方法等任何方法上。

假如有且只有一个bean匹配依赖需求的话，那么这个bean将会被装配进来。如果没有匹配的bean，那么在应用上下文创建的时候，Spring会抛出一个异常。为了避免异常的出现，你可以将@Autowired的required属性设置为false。

将required属性设置为false时，Spring会尝试执行自动装配，但是如果没有匹配的bean的话，Spring将会让这个bean处于未装配的状态。但是，把required属性设置为false时，你需要谨慎对待。如果在你的代码中没有进行null检查的话，这个处于未装配状态的属性有可能会出现NullPointerException。

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

@Autowired是Spring特有的注解。如果你不愿意在代码中到处使用Spring的特定注解来完成自动装配任务的话，那么你可以考虑将其替换为@Inject。@Inject注解来源于Java依赖注入规范，该规范同时还为我们定义了@Named注解。在自动装配中，Spring同时支持@Inject和@Autowired。尽管@Inject和@Autowired之间有着一些细微的差别，但是在大多数场景下，它们都是可以互相替换的。

2.3 通过Java代码装配bean

2.3.1 创建配置类

@Configuration注解表明这个类是一个配置类，该类应该包含在Spring应用上下文中如何创建bean的细节。

2.3.2 声明简单的Bean

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

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

默认情况下，bean的ID与带有@Bean注解的方法名是一样的。在本例中，bean的名字将会是sgtPeppers。如果你想为其设置成一个不同的名字的话，那么可以重命名该方法，也可以通过name属性指定一个不同的名字。

2.3.3 借助JavaConfig实现注入

在JavaConfig中装配bean的最简单方式就是引用创建bean的方法。

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

cdPlayer()方法像sgtPeppers()方法一样，同样使用了@Bean注解，这表明这个方法会创建一个bean实例并将其注册到Spring应用上下文中。所创建的bean ID为cdPlayer，与方法的名字相同。

cdPlayer()的方法体与sgtPeppers()稍微有些区别。在这里并没有使用默认的构造器构建实例，而是调用了需要传入CompactDisc对象的构造器来创建CDPlayer实例。

看起来，CompactDisc是通过调用sgtPeppers()得到的，但情况并非完全如此。因为sgtPeppers()方法上添加了@Bean注解，Spring将会拦截所有对它的调用，并确保直接返回该方法所创建的bean，而不是每次都对其进行实际的调用。

在软件领域中，我们完全可以将同一个SgtPeppers实例注入到任意数量的其他bean之中。默认情况下，Spring中的bean都是单例的，我们并没有必要为第二个CDPlayer bean创建完全相同的SgtPeppers实例。所以，Spring会拦截对sgtPeppers()的调用并确保返回的是Spring所创建的bean，也就是Spring本身在调用sgtPeppers()时所创建的CompactDiscbean。

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

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

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

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

另外，需要提醒的是，我们在这里使用CDPlayer的构造器实现了DI功能，但是我们完全可以采用其他风格的DI配置，如使用setter方法等，这里所存在的可能性仅仅受到Java语言的限制。

2.4 XML装配Bean

省略……
借助构造器注入初始化bean时，有两种基本配置方案可供选择：

• <constructor-arg>元素
• 使用Spring 3.0所引入的c-命名空间

当使用属性的Setter方法，同样有两种基本配置方案可供选择：

• <property>元素
• 使用Spring所引入的p-命名空间

2.5 导入和混合配置

2.5.1 在JavaConfig中引用XML配置

将两个Java配置类组合在一起：
方式一：使用@Import注解在一个配置类中导入另一个
方式二（更好）：创建一个更高级别的SystemConfig，在这个类中使用@Import将两个配置类组合在一起

在Java配置类中加载XML文件：@ImportResource

在Spring中同时加载XML配置和其他基于Java的配置：
用@ImportResource加载XML文件，用@Import加载Java配置类

2.5.2 在XML配置中引用JavaConfig

在XML配置文件中可使用<import>元素来引用其他XML配置文件。

<import resource="cdplayer-config.xml">

在XML配置文件中导入其他Java配置：<bean>元素

<bean class="soundsystem.CDConfig">

将XML配置文件和Java配置类组合到一个XML文件时，同时用上面两种方式。