基于注解配置的Bean的装配
需要知道的是,不管是XML还是注解,它们都是表达Bean定义的载体,其实质都是为Spring容器提供Bean定义的信息。基于XML的配置,Bean的定义信息和Bean实现类本身是分离的,如果是采用基于注解的配置文件,Bean定义信息通过在Bean实现类上标注注解实现。
使用注解定义Bean
import org.springframework.stereotype.Component;
@Component("userDao")
public class UserDao {
...
}
上面的Component的注解和下面xml的配置是等效的:
<bean id="userDao" class="com.smart.dao.UserDao" />
除@Component外,Spring还提供了3个功能和@Component基本等效的注解,分别用于对DAO、Service及Web层的Controller进行注解。
- @Repository 用于对DAO实现类进行标注
- @Service 用于对Service实现类进行标注
- @Controller 用于对Controller实现类进行标注
之所以要额外加这三种注解,是为了让标注本身的用途清晰化,完全可以用@Component替代这三个特殊的注解,但是推荐使用特定的注解标注特定的Bean,这样一眼就可以看出Bean的真是身份。
启动组件扫描
前面我们使用注解定义了Bean,还要告诉Spring容器,去哪里扫描这些有注解的Bean,并启动组件扫描,组件扫描有两种方式可以配置,一种是基于XML的配置,一种是创建组件扫描类。
XML配置组件扫描
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.0.xsd">
<context:component-scan base-package="com.smart" />
</beans>
创建组件扫描类
package soundsystem;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@ComponentScan
public class CDPlayerConfig {
}
注解@ComponentScan能够在 Spring 中启用组件扫描,如果没有其它配置的话,@ComponentScan默认会扫描与配置类相同的包,Spring 会扫描这个包以及这个包下的所有子包,查找带有@Component注解的类。
在组件扫描类中配置基础包
前面的代码中,我们没有为@ComponentScan设置任何属性,所以它会以配置类所在包作为基础包来扫描组件。但是如果我们想将配置类放在单独的包中,使其与其它应用代码区分开来,那默认的就不行了。
@Configuration
@ComponentScan("soundsystem")
public class CDPlayerConfig {
}
或者显式地指定 basePackages:
@Configuration
@ComponentScan(basePackages = "soundsystem")
public class CDPlayerConfig {
}
可以同时指定多个基础包:
@Configuration
@ComponentScan(basePackages = {"soundsystem", "videos"})
public class CDPlayerConfig {
}
上面的基础包的指定都是以字符串的形式,但是这种方法是类型不安全的,如果你重构代码的话,可能就会出现错误。除了将包设置为简单的字符串类型外,@ComponentScan还提供了另外一种方法,那就是将其指定为包中所包含的类或接口:
@Configuration
@ComponentScan(basePackageClasses = { SgtPepper.class, DVDPlayer.class})
public class CDPlayerConfig {
}
上面指定的类有些是组件类,为了更好区分,可以在这些包中创建一个空的扫描标记接口,然后使用这个接口类指定扫描包。
自动装配Bean
自动装配就是让 Spring 自动满足 bean 依赖的一种方法,在这个过程中,会在 Spring 应用上下文中寻找某个 bean 需求的其它bean。为了声明要进行自动装配,可以使用@Autowired注解。
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;
}
@Override
public void play() {
}
}
上面代码在构造器上添加了@Autowired注解,这表明当 Spring 创建 CDPlayer bean 的时候,会通过这个构造器来进行实例化并且传入一个可设置给 CompactDisc 类型的 bean。
@Autowired不仅可以用在构造器上,实际上它可以用在任何方法上。
@Autowired
public void setCompactDisc(CompactDisc cd) {
this.cd = cd;
}
@Autowired
public void insertDisc(CompactDisc cd) {
this.cd = cd;
}
Spring 在尝试满足方法参数上所声明的依赖时,如果有且只有一个 bean(也就是一个实现)能匹配依赖需求的话,那么这个 bean 将会被包装进来。
如果没有匹配的 bean,那么在应用上下文创建的时候,Spring 会抛出一个异常,为了避免这个异常,你可以设置属性 required 为 false:
@Autowired(required = false)
public void insertDisc(CompactDisc cd) {
this.cd = cd;
}
默认是为 true 的,当设置为 false 的时候,在代码要记得在使用时判空。
如果有多个备案都满足依赖关系的话,Spring 会抛出一个异常,这表明没有明确指定要选择哪个 bean 进行装配。后面会讲自动装配中的歧义性。
自动装配的歧义性
在使用自动装配时,只有一个 bean 匹配所需的结果时,自动装配才是有效的。如果不止有一个 bean 能够匹配结果的话,这种歧义性会阻碍 Spring 自动装配属性、构造器参数或方法参数。
比如我们使用@Autowired注解了一个方法,但是这个方法的参数接口有多个实现类,这个时候 Spring 就无法自动选择一个实现进行自动装配,会报出NoUniqueBeanDefinitionException异常。
@Autowired
public void setDessert(Dessert dessert) {
this.dessert = dessert;
}
@Component
public class Cake implements Dessert {...}
@Component
public class Cookies implements Dessert {...}
@Component
public class IceCream implements Dessert {...}
当发生歧义性的时候,我们可以将可选 bean 中的某一个设为首选(primary)的 bean,或者使用限定符(qualifier)来帮助 Spring 将可选的 bean 的范围缩小到只有一个 bean。
标示首选的 bean
Spring 中使用@Primary来表达最喜欢的方案。
@Primary与@Component组合用在组件扫描的 bean 上:
@Component
@Primary
public class Cake implements Dessert {...}
或者通过 Java 配置(后面会细讲基于Java配置的Bean的装配)显式地声明 Cake:
@Bean
@Primary
public Dessert cake() {
return new Cake();
}
就解决歧义性而言,限定符是一种更为强大的机制。
限定自动装配的 bean
设置首选 bean 的局限性在于@Primary无法将可选方案的范围限定到唯一一个无歧义性的选项中,它只能标示一个优先的可选方案。当 首选 bean 的数量超过一个时,我们并没有其它的方法进一步缩小可选范围。
Spring 的限定符能够在所有可选的 bean 上进行缩小范围的操作,最终能够达到只有一个 bean 满足所规定的限制条件。
我们可以使用@Qualifier指定要注入的是哪个 bean:
@Autowired
@Qualifier("cake")
public void setDessert(Dessert dessert) {
this.dessert = dessert;
}
@Qualifier的参数就是要注入的 bean 的 ID。
这种使用默认的 bean 的 ID 作为限定符有一定的风险,因为这里指定的限定符的 ID 与要注入的 bean 是紧耦合的,一旦我们重构了代码,改了类的名字,就可能会出错,所以我们最好是创建自定义的限定符。
我们可以为 bean 设置自己的限定符,而不是依赖于将 bean ID 作为限定符。
@Component
@Qualifier("sweet")
public class Cake implements Dessert {...}
@Autowired
@Qualifier("sweet")
public void setDessert(Dessert dessert) {
this.dessert = dessert;
}
还有一种更强大的限定符,那就是自定义的限定符:
@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Sweet {
}
这样你可以为一个自动装载的类指定唯一的自定义的限定符,这样没有任何歧义。更强大的是,你可以指定多个自定义的限定符,然后通过组合在选择合适的。