原文 :一文读懂Spring Bean作用域 - RelaxHeart网
Spring Bean的几种作用域
Spring定义了多种作用域,可以基于这些作用域创建bean,包括:
- 单例(singleton):在整个应用中,只创建bean的一个实例;
- 原型(Prototype):每次注入或者通过Spring应用上下文获取时,都会创建一个新的>bean实例;
- 会话(Session):在web应用中,为每个会话创建一个bean实例;
- 请求(Request):在web应用中,为每个请求创建一个实例。
单例作用域(Singleton)
默认情况下Spring应用上下文的Bean都是以单例(singleton)形式创建的,即不管一个bean被注入到其他bean多少次,每次注入的都是同一个实例。
多数情况下,单例Bean是最理想的方案。但是有时候我们使用的类是亦变的,他们会保持一些状态,因此重用是不安全的。这时候我们就需要结合具体的业务场景针对性的创建非singleton类型的Bean实例。
单例是默认的作用域,但是对于哪些易变的类型这个并不适合。如果选择其他作用域,要使用@Scope注解,它可以与@Component或@Bean一起使用。
原型作用域(Prototype)
比如,我们使用组件扫描来发现和声明bean,那么我们可以在bean的类上使用@Scope注解,将其声明为原型bean:
/**
* @Author: 王琦 <QQ.Eamil>1124602935@qq.com</QQ.Eamil>
* @Date: 2019-7-6 0006 14:47
* @Description: 无描述信息
*/
@Component
@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
public class ProtoTypeBean {
}
这里使用ConfigurableBeanFactory类的SCOPE_PROTOTYPE常量设置了原型作用域。我们也可以使用@Scope("prototype")更简洁的方式,个人还是习惯用第一种使用SCOPE_PROTOTYPE常量的方式,更安全且不易出错。
如果想在Java配置中将ProtoTypeBean 声明为原型bean,可以使用组合@Scope和@Bean里指定所需要的作用域:
@Bean
@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
public ProtoTypeBean instance(){
return new ProtoTypeBean();
}
同样,如果我们使用XML配置Bean,可以使用<bean>元素的scope属性来设置作用域:
<bean id = "baseService" class = "cn.relaxheart.service.BaseServiceImpl" scope="prototype"/>
不论使用那种方式来声明原型作用域,每次注入或者从spring应用上下文中检索该bean时候,都会创建新的实例。
使用会话(Session)和请求(Request)作用域
在Web应用中,能够实例化在在会话和请求范围内的Bean是很有价值的。
例如在电商系统中,可能会有一个Bean代表的是用户的购物车(ShoppingCart),如果ShoppingCart是单例的话,那将导致所有的用户往同一个购物车中添加商品;另外如果购物车是原型类型,那么用户在应用的某个地方A添加商品,而在另一个地方B可能就不可用了,因为每次注入的都将是一个新的实例。
所以就购物车的Bean来看,会话作用域是最合适的了,因为它与给定的用户的关联度最大,如果要在Java配之类使用会话作用域那么跟原型作用域用法一样,我们使用@Scope注解实现:
/**
* @Author: 王琦 <QQ.Eamil>1124602935@qq.com</QQ.Eamil>
* @Date: 2019-7-6 0006 16:03
* @Description: 无描述信息
*/
@Configuration
public class AppConfiguration {
@Bean
@Scope(value = WebApplicationContext.SCOPE_SESSION, proxyMode = ScopedProxyMode.INTERFACES)
public ShoppingCart cart(){ … }
}
这里将@Scope的value设置为WebApplicationContext.SCOPE_SESSION即告诉Spring为Web的每个会话只创建一个ShoppingCart 实例。这样是会创建很多个实例,但是对于同一个会话只有一个。在当前会话中,这个Bean相当于是一个单例。
上面@Scope注解中我们有用到除value外的另一个属性proxyMode ,这里它被设置为ScopedProxyMode.INTERFACES(接口代理)。这个属性解决了将会话或者请求作用域的Bean注入到单例bean所遇到的问题。在描述proxyMode属性之前,我们先来看下proxyMode解决的问题场景:
/**
* @Author: 王琦 <QQ.Eamil>1124602935@qq.com</QQ.Eamil>
* @Date: 2019-7-6 0006 16:03
* @Description: 无描述信息
*/
@Component
public class StoreService {
private ShoppingCart cart;
@Autowired
public void setShoppingCart(ShoppingCart cart){
this.cart = cart;
}
}
这里的StoreService 是一个单例的bean(默认情况下),会在Spring应用上下文加载的时候创建,当它创建的时候,Spring会试图将ShoppingCart 的bean实例注入到setShoppingCart()方法中,但是ShoppingCart bean是会话作用域的,此时并不存在。直到某个用户进入系统,创建了会话之后,才会出现ShoppingCart 的实例。所以这个时候注入会报错找不到ShoppingCart 的 Bean定义。
另外,系统中将会有多个ShoppingCart实例(每个用户创建一个会话时会创建一个)。我们并不想让Spring注入某一个固定的ShoppingCart 实例到StoreService。我们希望的是放StoreService处理购物车功能时,它所使用的ShoppingCart 实例恰好是当前用户会话所对应的那个ShoppingCart实例。
这个问题要怎么解决呢?
Spring并不会将实际的ShoppingCart bean注入到StoreService中,但是Spring会注入一个到ShoppingCart bean的代理,如下图所示:
结合上图看,这个代理会暴露于ShoppingCart相同的方法,所以StoreService会认为它就是一个购物车。但是,当StoreService去调用ShoppingCart 的方法时,代理会对其进行解析并将调用委托给会话作用域内真正的ShoppingCart bean。
然后,咱们带着对这个作用域的理解,在回到上述proxyMode属性上,如我们配置所示:
proxyMode = ScopedProxyMode.INTERFACES
这里表明这个代理要实现ShoppingCart 接口,并将调用委托给实现bean。
这里的ScopedProxyMode枚举一种包含4中类型:
public enum ScopedProxyMode {
/**
* Default typically equals {@link #NO}, unless a different default
* has been configured at the component-scan instruction level.
*/
DEFAULT,
/**
* Do not create a scoped proxy.
* <p>This proxy-mode is not typically useful when used with a
* non-singleton scoped instance, which should favor the use of the
* {@link #INTERFACES} or {@link #TARGET_CLASS} proxy-modes instead if it
* is to be used as a dependency.
*/
NO,
/**
* Create a JDK dynamic proxy implementing <i>all</i> interfaces exposed by
* the class of the target object.
*/
INTERFACES,
/**
* Create a class-based proxy (uses CGLIB).
*/
TARGET_CLASS;
}
关于代理的知识这里不细说了,我们主要看下INTERFACES与TARGET_CLASS这两个代理类型的使用: 显然INTERFACES从字面上来看是“接口”的意思,即基于接口实现的代理,也是最理想的代理模式,因为我们这里注入的ShoppingCart是接口类型所以使用INTERFACES;那如果要注入的Bean是一个具体的类,Spring就没有办法创建基于接口的代理了。这个时候它必须使用CGLib来生成基于类的代理。所以如果bean类型是具体类的话,我们必须使用TARGET_CLASS,以此来表明要以生成目标类扩展的方式创建代理。
这里请求作用域也同样面临这类装配的问题。处理方式是一样的:bean应该以作用域代理的方式进行注入。
在XML中声明作用域代理
上述关于session、request级作用域代理注入方式我们是以JavaConfig的方式实现的,在XML中应该怎么搞呢。
XML中配置作用域代理需要引入Spring AOP命名空间的一个新元素:
<bean id = "cart" class="cn.relaxheart.service.ShoppingCart" scope="session">
<!-- 就是它了 -->
<aop:scoped-proxy proxy-target-class="false"/>
</bean>
<aop:scoped-proxy >是与@Scope的proxyMode属性作用相同的XML配置元素,会告诉Spring创建一个作用域代理。默认情况下,他会使用CGLib创建目标类的代理。但是我们这里需要的是基于接口的代理,只需将 proxy-target-class属性值设置为false就可以了。
总结
(1)Spring Bean的4种作用域:singleton、Prototype、Session、Request
(2)基于Java配置实现作用域控制主要的注解:@Scope
(3)基于XML配置实现作用域控制:<bean id = "cart" class="cn.relaxheart.service.ShoppingCart" scope="session"/>
(4)将会话/请求作用域Bean注入单例bean需要以作用域代理的方式注入,主要分两类:接口代理 (INTERFACES)& 类代理(TARGET_CLASS),代理配置对应的属性为proxyMode