尽管Spring的配置风格是可以互相搭配的,但是应该尽可能的使用自动配置的机制,显式配置越少越好
Spring从两个角度来实现自动化装配:
- 组件扫描:Spring会自动发现应用上下文中所创建的bean
- 自动装配:Spring会自动满足bean之间的依赖
组件扫描和自动装配组合在一起就可以将所需要的显式配置降低到最少。
首先定义一个代表了CD概念的接口CompactDisc:
public interface CompactDisc {
void play();
}
作为一个接口,它将CD播放器和CD之间的耦合降低到了最小的程度。
下面创建一个CD接口的实现SgtPeppers类:
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.print("Playing " + title+" by " + artist);
}
}
注意在这里使用了@Component注解,这个注解表明该类会作为组件类,并告知Spring为该类创建bean。只需要使用了这个注解,就没有必要显式配置SgtPeppers bean,Spring会把所有任务处理妥当。
我们可以在@Component注解中为bean命名,如果采取默认ID的话,Spring会根据类名指定一个ID,具体规则就是将类名的第一个字母变成小写。如果需要自定义ID的话,可以采取下面这样的方式配置注解:
import org.springframework.stereotype.Component;
@Component("happyBean")
public class SgtPeppers implements CompactDisc {
}
不过需要注意的是:组件扫描默认是不启用的。我们需要显式配置一下Spring,从而命令它去寻找所有带有@Component注解的类,并为它创建bean。
下面这个CDPlayerConfig类展现了如何实现显式配置Spring的组件扫描:
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@ComponentScan
public class CDPlayerConfig {
}
在CDPlayerConfig类中没有显式声明任何bean,但是它通过使用@ComponentScan注解,让Spring启用了组件扫描。如果没有其他配置的话,Spring会默认扫描与配置类相同的包。
如果希望Spring不仅仅扫描默认的基础包,那么我们可以采用如下的方式进行配置:
@Configuration
@ComponentScan(basePackages = {"soundsystem","video"})
public class CDPlayerConfig {
}
但是采用这样的方法是类型不安全的,如果需要重构代码的话,那么所指定的基础包就可能出现错误。除了将包设置为简单的String之外,@Component还提供了另一种方法,那就是将其指定为包中所包含的类或者接口:
@Configuration
@ComponentScan(basePackageClasses = {CDPlayer.class, Video.class})
public class CDPlayerConfig {
}
虽然在上面的示例中使用的是组件类,但是我们应该考虑在包中创建一个用来进行扫描的空标记接口。通过标记接口的方式,依然能够保持对重构友好的接口引用,同时能够避免引用任何实际的应用程序代码。
下面我们使用测试类来测试CompactDisc是不是真的创建出来了:
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);
}
}
这个测试类自动创建了Spring应用上下文,注解@ContextConfiguration告诉其需要在CDPlayerConfig中加载配置。因为CDPlayerConfig类中包含了@ComponentScan,因此最终的应用上下文应该包含了CompactDisc bean。
这个测试类应该可以通过测试,并以测试成功的颜色显示。
组件扫描之后就应该是自动装配了。简单来说,自动装配就是让Spring自动满足bean依赖的一种方法,在满足依赖的过程中,会在Spring应用上下文中寻找匹配某个bean需求的其他bean。
为了实现自动装配,我们可以借助Spring的@Autowired注解。
考虑下面这个示例,通过自动装配,将一个CompactDisc注入到CDPlayer中:
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();
}
}
它实现的MediaPlayer接口:
public interface MediaPlayer {
void play();
}
@Autowired注解不仅可以用在构造器上,在其他方法上,Spring都会尝试满足方法参数上声明的依赖。
如果没有匹配的bean,那么在创建应用上下文时,Spring会抛出一个异常。
下面使用一个测试类来测试自动装配是否成功:
import static org.junit.Assert.*;
import org.junit.Rule;
import org.junit.Test;
import org.junit.contrib.java.lang.system.StandardOutputStreamLog;
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 StandardOutputStreamLog log = new StandardOutputStreamLog();
@Autowired
private MediaPlayer player;
@Autowired
private CompactDisc cd;
@Test
public void cdShouldNotBeNull() {
assertNotNull(cd);
}
@Test
public void play() {
player.play();
assertEquals(
"Playing Sgt. Pepper's Lonely Hearts Club Band by The Beatles",
log.getLog());
}
}
在最后的断言中,paly()测试方法调用了CDPlayer的paly()方法,并且断言它的行为和预期的一致。
文章原文在这里