#Spring实战第二章学习笔记————装配Bean

时间:2021-02-25 08:35:59

Spring实战第二章学习笔记————装配Bean

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

Spring配置的可选方案

当描述bean如何被装配时,Spring具有非常大的灵活性,它提供了三种主要的装配机制:

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

在这本书中作者建议尽可能使用自动配置的机制。显示配置越少越好。而当你必须要显示配置bean时(比如有些代码不是你维护的,而你需要为这些代码装配bean的时候),推荐使用类型安全且比XML更强大的JavaConfig。

自动化装配bean

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

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

创建可发现的bean

为了阐述组件扫描和装配。我们需要创建几个bean,它们代表了一个音乐系统的组件。首先我们在Java中定义CD的概念。

package com.wbw.soundsystem;

interface CompactDisc {
void play();
}

CompactDisc的具体内容并不重要重要的是它被定义为一个接口。作为接口他定义了CD播放器对CD所能进行的操作。然后我们需要对CompactDisc进行实现。

package com.wbw.soundsystem;

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);
} }

我们不要了解这个类的具体内容没需要注意的是@compontent。这个简单的注解表明该类会作为组件类,并告知Spring要为这个类创建bean。没有必要显示配置SgtPeppersbean。但组件扫描默认是不启用的。所以我们需要显式配置一下Spring,从而命令他去寻找有@Component注解的类。

package com.wbw.soundsystem;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration; @Configuration
@ComponentScan
public class CDPlayerConfig {
}

@ComponentScan注解可以在Spring中开启组件扫描。@Configuration可理解为用spring的时候xml里面的标签。当然也可以用XML来启用组件扫描。这里就不详述了。此时我们创建了两个类,就能对功能进行一番尝试了。为了测试组件扫描的功能,我们创建一个JUnit测试,它会创建Spring上下文,并判断CompactDisc是不是真的创建出来。代码如下:

package com.wbw.soundsystem;

import static org.junit.Assert.assertNotNull;

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);
} }

运行测试,测试通过,说明@Autowired注解起作用了:自动将扫描机制创建的CompactDisc类型的bean注入到SoundSystemTest这个bean中。

为组件扫描的bean命名

在Spring上下文中,每个bean都有自己的ID。在前面的例子中, 尽管我们没有明确地为SgtPeppersbean设置ID,但Spring会根据类 名为其指定一个ID。具体来讲,这个bean所给定的ID 为sgtPeppers,也就是将类名的第一个字母变为小写。 

如果你需要给某个类对应的bean一个特别的名字,则可以给@Component注解传入指定的参数,例如:

@Component("lonelyHeartsClub")
public class SgtPeppers implements CompactDisc {
...
}

设置组件扫描的基础包

我们没有给@ComponentScan设置任何属性,按照默认规则,它会以配置类所在的包作为基础包(base package)来扫描组件。但是当我们需要扫描其他包时,又该怎么做呢?

为了满足上面提到的需求,我们只需要为@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{}

通过Java代码装配Bean

在进行显式配置时,JavaConfig是更好的方案,因为它更强大且对重构友好。因为它就是Java代码。同时JavaConig与其他的Java代码又有所区别。它是配置代码。意味着它不包含任何事物逻辑。不适必须的,但通常会把JavaConfig放到单独的包中。

创建配置类

import org.springframework.context.annotation.Configuration;

@Configuration

public class CDPlayerConfig {
}

创建JavaConfig的关键在于为其添加@Configuration注解,这个注解表明这个类是一个配置类。

而移除了@ComponentScan注解此时的CDPlayerConfig已经没有作用了。因此接下来就要使用JavaConfig装配CDPlayer和CompactDisc。

声明简单的bean

要在JavaConfig中声明bean,我们需要编写一个方法,这个方法会创建所需类型的实例,然后给这个方法添加@Bean注解。bean的ID默认会和方法名一样,如果想取其他ID可以用bean的name属性:

@Bean
public CompactDisc sgtPeppers(){
return new SgtPeppers();
} //添加name属性
@Bean(name = "lonelyHeartClubBand")
public CompactDisc sgtPeppers(){
return new SgtPeppers();
}

不管你用什么bean命名,bean的声明都非常简单。这个方法只要我们最后产生CompactDisc实例即可。

借助JavaConfig实现注入

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

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

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

默认情况下,Spring中的bean都是单例的,我们并没有必要为第二个CDPlayer bean创建完全相同的SgtPeppers实例。所以,Spring会拦截对sgtPeppers()的调用并确保返回的是Spring所创建的bean,也就是Spring本身在调用sgtPeppers()时所创建的CompactDiscbean。因此,两个CDPlayer bean会得到相同的SgtPeppers实例。

小结

有关XML和混合配置的部分暂时先不详述,今天就先写这么多了。