2.1 Spring配置的可选方案
Spring提供了三种主要的装配机制:
1)在XML中进行显示配置。
2)在java中进行显示配置。
3)隐式的bean发现机制和自动装配。
这三种方式可以互相搭配使用。建议使用自动配置的机制。显式配置越少
越好。
2.2 自动化装配bean
Spring从两个角度来实现自动化装配:
1)组件扫描(component scanning):Spring会自动发现应用上下文中所创建的bean。
2)自动装配(autowiring):Spring自动满足bean之间的依赖。
组件扫描和自动装配组合在一起就能发挥出强大的威力,它们能够将
你的显式配置降低到最少。
2.2.1 创建可被发现的bean
CD为我们阐述DI如何运行提供了一个很好的样例。如果你不将CD插入(注入)到CD播放器中,那么CD播放器其实是没有太大用处的。所以,可以这样说,CD播放器依赖于CD才能完成它的使
命。
为了在Spring中阐述这个例子,让我们首先在Java中建立CD的概念。
程序清单2.1展现了CompactDisc(光盘),它是定义CD的一个接口:
package soundsystem;
public interface CompactDisc{
void play();
}
作为接口,它定义了CD播放器对一盘CD所能进行的操作。它将CD播放器的任意实现与CD本身的耦合降低到了最小的程度。
我们首先会创建CompactDisc其中的一个实现,也就是程序清单2.2所示的SgtPeppers类:
package sounddsystem;
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";
public void play(){
System.out.println("Playing " + title + " by " + artist);
}
}
SgtPeppers类上使用了@Component注解,表明该类会作为组件类,并告知Spring要为这个类创建bean。没有必要显式配置SgtPeppersbean,因为这个类使用了@Component注解。
组件扫描默认是不启用的。我们还需要显式配置一下Spring,从而命令它去寻找带有@Component注解的类,并为其创建bean。
程序清单2.3的配置类展现了完成这项任务的最简洁配置:
@ComponentScan注解启用了组件扫描
package soundsystem;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@ComponentScan
public class CDPlayerConfig{
}
类CDPlayerConfig通过Java代码定义了Spring的装配规则,并没有显式地声明任何bean,只不过它使用了@ComponentScan注解,这个注解能够在Spring中启用组件扫描。
如果没有其他配置的话,@ComponentScan默认会扫描与配置类相同的包。因为CDPlayerConfig类位于soundsystem包中,因此Spring将会扫描这个包以及这个包下的所有子包,查找带有@Component注解的类。这样的话,就能发现CompactDisc,并且会在Spring中自动为其创建一个bean。
如果你更倾向于使用XML来启用组件扫描的话,那么可以使用Spring context命名空间的
程序清单2.4展示了启用组件扫描的最简洁XML配置:
配置了
创建一个简单的JUnit测试,它会创建Spring上下文,测试组件扫描能够发现CompactDisc程序清单2.5:
package soundsystem;
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 cd;
@Test
public void cdShouldNotBeNull(){
assertNotNull(cd);
}
}
CDPlayerTest使用了Spring的SpringJUnit4ClassRunner,以便在测试开始的时候自动创建Spring的应用上下文。
注解@ContextConfiguration会告诉它需要在CDPlayerConfig中加载配置。因为CDPlayerConfig类中包含了@ComponentScan,因此最终的应用上下文中应该包含CompactDiscbean。
带有@Autowired注解,以便于将CompactDiscbean注入到测试代码之中。
2.2.2 为组件扫描的bean命名
Spring应用上下文中所有的bean都会给定一个ID。尽管我们没有明确地为SgtPeppersbean设置ID,但Spring会根据类名为其指定一个ID。这个bean所给定的ID为sgtPeppers,也就是将类名的第一个字母变为小写。如果想为这个bean设置不同的ID,你所要做的就是将期望的ID作为值传递给@Component注解。
@Component注解配置为如下所示:
@Component("lonelyHeartsClub")
还有另外一种为bean命名的方式,这种方式不使用@Component注解,而是使用Java依赖注入规范(Java Dependency Injection)中所提供的@Named注解来为bean设置ID:
@Named("lonelyHeartsClub")
public class SgtPeppers implements CompactDisc{
......
}
2.2.3 设置组件扫描的基础包
通过设置@ComponentScan的value属性指明基础包来扫描组件:
@Configuration
@ComponentScan("soundsystem")
public class CDPlayerConfig{}
如果你想更加清晰地表明你所设置的是基础包,那么你可以通过basePackages属性进行配置:
@Configuration
@ComponentScan(basePackages="soundsystem")
public class CDPlayerConfig{}
basePackages属性使用的是复数形式,可以设置多个基础包:
@Configuration
@ComponentScan(basePackages="soundsystem","video")
public class CDPlayerConfig{}
在上面的例子中,所设置的基础包是以String类型表示的,但这种方法是类型不安全(not type-safe)的。
@ComponentScan还提供了另外一种方法,那就是将其指定为包中所包含的类或接口:
@Configuration
@ComponentScan(basePackageclasses={CDPlayer.class,DVDPlayer.class})
public class CDPlayerConfig{}
可以看到,basePackages属性被替换成了basePackageClasses。
2.2.4 通过为bean添加注解实现自动装配
Spring会在应用上下文中寻找,为了匹配某个bean,需求的其他bean。为了声明要进行自动装配,我们可以借助Spring的@Autowired注解。
通过自动装配,将一个CompactDisc注入到CDPlayer之中,程序清单2.6:
package soundsystem;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class CDPlayer implements MediaPlayer{
private CompactDisc cd;
@Autowired
public CDPlayer(CompactDisc cd){
this.cd = cd;
}
public void play(){
cd.play();
}
}
@Autowired注解不仅能够用在构造器上,还能用在属性的Setter方法上。比如说,如果CDPlayer有一个setCompactDisc()方法,那么可以采用如下的注解形式进行自动装配:
@Autowired
public void setCompactDisc(CompactDisc cd){
this.cd = cd;
}
实际上,Setter方法并没有什么特殊之处。@Autowired注解可以用在类的任何方法上:
@Autowired
public void insertDisc(CompactDisc cd){
this.cd = cd;
}
如果没有匹配的bean,那么在应用上下文创建的时候,Spring会抛出一个异常。为了避免异常的出现,你可以将@Autowired的required属性设置为false:
@Autowired(required=false)
将required属性设置为false时,Spring会尝试执行自动装配,但是如果没有匹配的bean的话,Spring将会让这个bean处于未装配的状态。
@Autowired是Spring特有的注解,以考虑将其替换为@Inject,@Inject注解来源于Java依赖注入规范。
2.3 通过Java代码装配bean
JavaConfig是配置代码,这意味着它不应该包含任何业务逻辑,JavaConfig也不应该侵入到业务逻辑代码之中。
2.3.1 创建配置类
程序清单2.3中:
package soundsystem;
import org.springframework.context.annotation.Configuration;
@Configuration
public class CDPlayerConfig{
}
创建JavaConfig类的关键在于为其添加@Configuration注解。
2.3.2 声明简单的bean
要在JavaConfig中声明bean,我们需要编写一个方法,这个方法会创
建所需类型的实例,然后给这个方法添加@Bean注解:
@Bean
public CompactDisc sgtPeppers(){
return new SgtPeppers();
}
@Bean注解会告诉Spring这个方法将会返回一个对象。
默认情况下,bean的ID与带有@Bean注解的方法名是一样的。在本例中,bean的名字将会是sgtPeppers。
可以通过name属性指定一个不同的名字:
@Bean(name="lonelyHeartsClubBand")
2.3.3 借助JavaConfig实现注入
假设我们需要声明CDPlayerbean,它依赖于CompactDisc:
@Bean
public CDPlayer cdPlayer(){
return new CDPlayer(sgtPeppers());
}
看起来,CompactDisc是通过调用sgtPeppers()得到的,但情况并非完全如此。
sgtPeppers()方法上添加了@Bean注解,Spring将会拦截所有对它的调用,并确保直接返回该方法所创建的bean,而不是每次都对其进行实际的调用,即:所有对sgtPeppers()的调用,返回得到的都是同一个bean。
2.4 通过XML装配bean
2.4.1 创建XML配置规范
在XML配置中,这意味着要创建一个XML文件,并且要以
在使用XML时,需要在配置文件的顶部声明多个XML模式(XSD)文件,这些文件定义了配置Spring的XML元素。
在Spring Tool Suite的菜单中,选择File>New>Spring Bean Configuration File,能够创建SpringXML配置文件,并且可以选择可用的配置命名空间。
用来装配bean的最基本的XML元素包含在spring-beans模式之中,它被定义为根命名空间。
是所有Spring配置文件的根元素。
2.4.2 声明一个简单的
使用
这里声明了一个很简单的bean,通过class属性来指定,并且要使用全限定的类名。
在本例中,bean的ID将会是“soundsystem.SgtPeppers#0”。其中,“#0”是一个计数的形式,用来区分相同类型的其他bean。如果你声明了另外一个SgtPeppers,并且没有明确进行标识,那么它自动得到的ID将会是“soundsystem.SgtPeppers#1”。
为每个bean设置一个你自己选择的名字:
2.4.3 借助构造器注入初始化bean
在Spring XML配置中,只有一种声明bean的方式:使用
构造器注入bean引用:
按照现在的定义,CDPlayerbean有一个接受CompactDisc类型的构造器。
在XML中声明CDPlayer并通过ID引用SgtPeppers:
作为替代的方案,你也可以使用Spring的c-命名空间。c-命名空间是在Spring 3.0中引入的,它是在XML中更为简洁地描述构造器参数的方式。
要使用它的话,必须要在XML的顶部声明其模式:
在c-命名空间和模式声明之后,我们就可以使用它来声明构造器参数了,如下所示:
属性名以“c:”开头,也就是命名空间的前缀。接下来就是要装配的构造器参数名,在此之后是“-ref”,这是一个命名的约定,它会告诉Spring,正在装配的是一个bean的引用,这个bean的名字是compactDisc,而不是字面量“compactDisc”。
将字面量注入到构造器中
创建CompactDisc的一个新实现,如下所示:
package soundsystem;
public class BlankDisc implements CompactDisc{
private String title;
private String artist;
public BlankDisc(String title,String artist){
this.title = title;
this.artist = artist;
}
public void play(){
}
}
xml配置如下:
没有使用“ref”属性来引用其他的bean,而是使用了value属性,通过该属性表明给定的值要以字面量的形式注入到构造器之中。
使用c-命名空间:
装配字面量与装配引用的区别在于属性名中去掉了“-ref”后缀。
装配集合
创建CompactDisc的一个新实现,如下所示:
package soundsystem;
import java.util.List;
public class BlankDisc implements CompactDisc{
private String title;
private String artist;
private List tracks;
public BlankDisc(String title,String artist,List tracks){
this.title = title;
this.artist = artist;
this.tracks = tracks;
}
public void play(){
}
}
在声明bean的时候,我们必须要提供一个列表:
12345
123456
元素是
与之类似,我们也可以使用元素替代
构造函数:
public Discography(String artist, List cds){}
xml配置:
我们也可以按照同样的方式使用元素的区别不大,其中最重要的不同在于当Spring创建要装配的集合时,所创建的是java.util.Set还是java.util.List。如果是Set的话,所有重复的值都会被忽略
掉,存放顺序也不会得以保证。
c-命名空间的属性无法实现装配集合的功能。
2.4.4 设置属性
通过Setter方法实现属性注入,属性注入的CDPlayer如下所示:
package soundsystem;
import org.springframework.beans.factory.annotation.Autowired;
import soundsystem.CompactDisc;
import soundsystem.MediaPlayer;
public class CDPlayer implements MediaPlayer{
private CompactDisc compactDisc;
@Autowired
public void setCompactDisc(CompactDisc compactDisc){
this.compactDisc = compactDisc;
}
public void play(){}
}
作为一个通用的规则,我倾向于对强依赖使用构造器注入,而对可选性的依赖使用属性注入。
xml配置如下:
Spring提供了更加简洁的p-命名空间,作为
为了启用p-命名空间,必须要在XML文件中与其他的命名空间一起对其进行声明:
我们可以使用p-命名空间,按照以下的方式装配compactDisc属性:
p-命名空间中属性所遵循的命名约定与c-命名空间中的属性类似。
首先,属性的名字使用了“p:”前缀,表明我们所设置的是一个属性。接下来就是要注入的属性名。最后,属性的名称以“-ref”结尾,这会提示Spring要进行装配的是引用,而不是字面量。
将字面量注入到属性中
属性也可以注入字面量,新的BlankDisc类如下所示:
package soundsystem;
import java.util.List;
import soundsystem.CompactDisc;
public class BlankDisc implements CompactDisc{
private String title;
private String artist;
private List tracks;
public void setTitle(String title){
this.title = title;
}
public void setArtist(String artist){
this.artist = artist;
}
public void setTracks(List tracks){
this.tracks = tracks;
}
public void play(){}
}
xml配置如下:
3
4
在这里,除了使用元素来设置tracks属性,这与之前通过
我们不能使用p-命名空间来装配集合,没有便利的方式使用p-命名空间来指定一个值(或bean引用)的列表。但是,我们可以使用Spring util-命名空间中的一些功能来简化BlankDiscbean。
在XML中声明util-命名空间及其模式:
util-命名空间所提供的功能之一就是
3
4
现在,我们能够像使用其他的bean那样,将列表bean注入到BlankDisc bean的tracks属性中:
2.5 导入和混合配置
2.5.1 导入和混合配置
@Import注解:
使用@Import注解导入CDConfig后,CDPlayerConfig中的compactDisc就是CDConfig中得到的bean实例。
或者采用一个更好的办法,也就是不在CDPlayerConfig中使
用@Import,而是创建一个更高级别的SoundSystemConfig,在
这个类中使用@Import将两个配置类组合在一起:
假如BlankDisc配置在了XML之中,@ImportResource注解可以应用XML文件,获得bean:
两个bean——配置在JavaConfig中的CDPlayer以及配置在XML中BlankDisc——都会被加载到Spring容器之中。因为CDPlayer中带有@Bean注解的方法接受一个CompactDisc作为参数,因此BlankDisc将会装配进来,此时与它是通过XML配置的没有任何关系。
2.5.2 在XML配置中引用JavaConfig
如果有多个配置文件,可以使用