《Spring In Action》阅读笔记之装配bean

Spring主要装配机制

1、在XML中进行显式配置
2、在Java中进行显式配置
3、隐式的的bean发现机制和自动装配

自动化装配bean

Spring从两个角度来实现自动化装配
1、组件扫描：Spring会自动发现应用上下文中所创建的Bean
2、自动装配：Spring自动满足bean之间的依赖。

组件扫描

相关注解

@Component

表明该类会作为组件类，告知Spring要为这个类创建bean

@Component("lonelyHeartsClub")

Spring应用上下文中的所有的bean都会给定一个ID，默认情况下为将类名的第一个字母变成小写，该注解给bean设置ID

@ComponentScan

启用组件扫描，默认扫描与配置类相同的包
用于JavaConfig配置类中，当然也可以使用xml配置的方式启用组件扫描，但是在此不做记录

@ComponentScan("soundsystem")

参数可指定要扫描的包名

@ComponentScan(basePackages={"soundsystem","video"})

参数可指定多个要扫描的包名组成的数组

@ComponentScan(basePackagesClasses={CDPlayer.class,DVDPlayer.class})

还可以使用包中所包含的类或者接口来指定要扫描的包，你可以考虑专门在每个包中创建一个用来扫描的空标记接口从而解耦。

自动装配

相关注解

@Autowired

声明进行自动装配，假如有且只有一个bean匹配依赖需求的话，那么这个bean会被装配进来
如果没有匹配或有多个匹配bean,Spring将会跑出相应的异常
如将required属性设置设置为false，则在没有匹配的bean时，Spring会让这个bean处于未装配状态。
注：@inject注解功能与@Autowired相近，大多数场景下可互相替换

通过java代码装配Bean

创建配置类

即使用JavaConfig配置类

@Configuration

表明所在类是一个配置类，该类应该包含在Spring应用上下文如何创建bean的细节

在JavaConfig中声明简单的bean

@Bean

@Bean注解会告诉Spring该方法会返回一个对象，该方法要注册为Spring应用上下文中的bean，方法体中包含了最终产生bean实例的逻辑。

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

默认情况下bean的ID与带有@Bean注解的方法名是一样的。当然也可以通过name属性指定。

@Bean(name="lovelyClubBand")

依赖注入

同样使用@Bean创建方法，只需要通过参数声明要注入的依赖

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

这只是一种实现DI功能的代码，完全可以采用其他风格的代码实现，java语言是唯一的限制。

条件化的bean

@Conditional

可使用该注解应用到带有@Bean注解的方法上，如果给定的条件（参数类）满足返回true，就会创建这个bean，否则忽略这个bean。

//@Conditional注解的使用方法
@Bean
@Conditional(MagicExistsConidtion.class)
public MagicBean magicBean() {
    return new MagicBean();
}

//设置给@Conditional的类的创建，只需实现Condition接口的matches方法即可
public class MagicExistsCondition implements Condition {
//判断是否存在magic环境变量
  @Override
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    Environment env = context.getEnvironment();
    return env.containsProperty("magic");
  }
}

处理自动装配的歧义性

标记首选bean

使用@Primary注解,可与@Component或@Bean结合使用，或在xml中的bean元素中配置primary="true"属性

@Component
@primary
public Dessert iceCream(){
    return new IceCream();
}

但若配置两个@Primary，则仍然出现歧义性问题。

使用限定符

@Qualifier注解
可与@Autowired协同使用，指定想要注入的bean的限定符（如未自己指定限定符，默认限定符为bean ID）

@Autowired
@Qualifier("iceCream")
public void set Dessert(Dessert dessert){
    this.dessewrt = dessert;
}

创建自定义限定符

将@Qualifier与@component联合使用,为类定义限定符

@Component
@Qualifier("cold")//为IceCream类定义限定符名称cold,则可以在依赖注入的时候使用@Qualifier("cold")来指定注入这个bean
public class IceCream implements Dessert{...}

自定义限定符注解

由于java不允许在同一个条目上同时出现相同类型的多个注解（如同时出现@Qualifier("cold")和@Qualifier("sweet")），所以我们可以通过自定义注解的方式定义一些不同的限定符注解，从而不断缩小可选bean的范围

//自定义@cold限定符注解
@Target({ElementType.CONSTRUCTOR,ElementType.FIELD,ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Creamy{}

然后将@Creamy注解分别应用于要装配的bean和注入点（即分别与@Component和@Autowired一起使用）即可

bean的作用域

使用@Scope(param)注解
Spring定义的作用域包括：

• 单例(Singleton)：在整个应用中，只创建bean的一个实例
• 原型(Prototype)：每次注入或者通过Spring应用上下文获取的时候，都会创建一个新的bean实例
• 会话(Session)：在web应用中，为每个会话创建一个bean实例
• 请求(Request)：在web应用中，为每个请求创建一个bean实例

@Component
@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
public class Notepad {
  // the details of this class are inconsequential to this example
}

若使用xml配置，则可以使用元素的scope属性（scope=“prototype”）来设置作用域。

关于会话和请求作用域的特别之处

需要设置@Scope的参数proxyMode

//设置bean的作用域为会话
@Component
@Scope(
    value=WebApplicationContext.SCOPE_SESSION,
    proxyMode=ScopedProxyMode.INTERFACES)
public ShoppingCart cart(){ ... }
//定义一个作用域为单例的bean，依赖我们刚才定义的作用域为会话的ShoppingCart bean
@Component
public class StoreService{
    @Autowired
    public void setShoppingCart(ShoppingCart shoppingCart){
        this.shoppingCart = shoppingCart;
    }
    ...
}

因为StoreService是一个单例bean，会在Spring应用上下文加载的时候创建，但 ShoppingCart bean是会话作用域的，要等到某个用户进入了系统创建了会话之后才会出现ShoppingCart实例。
此外系统中将会同时有多个ShoppingCart实例，我们肯定希望当StoreService处理购物车功能的时候所使用的恰好是当前会话所对应的那一个。
对于这种情况，Spring的处理方式是：
Spring注入到StoreService中的实际上是一个到ShoppingCart bean的代理，当StoreService调用ShoppingCart的方法时，代理会对其进行懒解析并将调用委托给会话作用域内真正的ShoppingCart bean。从而完成了会话作用域bean向单例作用域bean的注入。
请求作用域的bean也同样是以作用域代理的方式进行注入。

proxyMode参数的取值

proxyMode=ScopedProxyMode.INTERFACES

如果ShoppingCart是接口而不是类的话，则使用java动态代理创建基于接口的代理。

proxyMode=ScopedProxyMode.TARGET_CLASS

如果ShoppingCart是一个具体的类的话，则必须使用CGLib来生成基于类的代理。

运行时值的注入

使用@PropertySource注解
注入properties配置文件中的值，使用environment加载并加检索。

@Configuration
@PropertySource("classpath:/com/soundsystem/app.properties")
public class ExpressiveConfig{
    @Autowired
    Environment env;
    
    @Bean
    public BlankDisc disc(){
        return new BlankDisc(env.getProperty("disc.title"),
            env.getProperty("disc.artist"));
    }
}

从代码里的解释来看environment代表了profile和properties，profile还不知道是啥，profile就是配置文件，比如配置数据库权限链接字符串啥的，肯定见过。Environment的详细api见《Spring实战》P90-P92