Spring 中完整的 Scope 选项实例详解_Java

spring 的 scope 属性确实不止 singleton 和 prototype 两个。根据应用类型和 spring 生态的不同，一共有 8 种可选值。它们可以分为三类：核心作用域、web 作用域、扩展作用域。

一、核心作用域（2 个）

这两个是 spring 容器内置的基础作用域，适用于所有类型的应用。

作用域	说明
`singleton`	默认值，容器中只有一个实例，全局共享
`prototype`	每次获取都创建新实例

@component
@scope("singleton")  // 默认，可省略
public class userservice { }
@component
@scope("prototype")
public class shoppingcart { }

二、web 作用域（4 个）

这 4 个作用域只在 web 应用中有效，需要 webapplicationcontext 支持。

1. request

每个 http 请求创建一个实例，请求结束后销毁。

@component
@scope(value = "request", proxymode = scopedproxymode.target_class)
public class requestcontext {
    private string requestid;
    // ...
}

2. session

每个 http session 创建一个实例，session 失效时销毁。

@component
@scope(value = "session", proxymode = scopedproxymode.target_class)
public class usersession {
    private user currentuser;
    // ...
}

3. application

每个 servletcontext 创建一个实例，整个 web 应用共享。

@component
@scope(value = "application", proxymode = scopedproxymode.target_class)
public class appcounter {
    private atomicinteger totalvisits = new atomicinteger(0);
    // ...
}

4. websocket

每个 websocket 会话创建一个实例，连接关闭时销毁。spring 5+ 支持。

@component
@scope(value = "websocket", proxymode = scopedproxymode.target_class)
public class websocketsessionbean {
    private string sessionid;
    // ...
}

三、扩展作用域（2 个）

这两个不在 spring framework 核心中，而是来自 spring cloud 或自定义实现。

5. refresh（spring cloud）

用于 spring cloud 的配置动态刷新。当配置中心（如 nacos、config server）的配置变更时，被 @refreshscope 标注的 bean 会被重新创建，注入最新的配置值。

@component
@refreshscope  // 等价于 @scope("refresh")
public class configurablebean {
    @value("${app.timeout}")
    private int timeout;
}

当调用 /actuator/refresh 端点时，refresh 作用域的 bean 会被销毁并重新创建，timeout 会更新为最新值。

6. globalsession（旧版 portlet）

用于 portlet 应用的全局会话作用域。在 portlet 规范中，globalsession 表示跨所有 portlet 的全局会话。spring mvc 应用不使用这个作用域，它在 spring 5 之后已经很少见。

<bean id="globalsessionbean" class="com.example.mybean" scope="globalsession"/>

四、自定义作用域

除了以上 6 个内置作用域，spring 还允许通过实现 scope 接口定义自定义作用域。常见的自定义作用域有：

7. thread（线程作用域）

每个线程一个实例，常用于线程隔离的场景。

public class threadscope implements scope {
    private final threadlocal<map<string, object>> threadscope = 
        threadlocal.withinitial(hashmap::new);
    @override
    public object get(string name, objectfactory<?> objectfactory) {
        return threadscope.get().computeifabsent(name, k -> objectfactory.getobject());
    }
    @override
    public object remove(string name) {
        return threadscope.get().remove(name);
    }
    @override
    public void registerdestructioncallback(string name, runnable callback) {
    }
    @override
    public object resolvecontextualobject(string key) {
        return null;
    }
    @override
    public string getconversationid() {
        return thread.currentthread().getname();
    }
}

@configuration
public class scopeconfig {
    @bean
    public customscopeconfigurer customscopeconfigurer() {
        customscopeconfigurer configurer = new customscopeconfigurer();
        configurer.addscope("thread", new threadscope());
        return configurer;
    }
}

使用：

@component
@scope("thread")
public class threadscopedbean {
}

8. 其他自定义作用域

根据业务需要，还可以定义更多作用域，例如：

tenant：多租户场景，每个租户一个实例
batch：批处理任务，每次批处理一个实例
conversation：web 对话作用域（类似 seam 框架的 conversation）

五、8 个 scope 汇总表

序号	作用域	来源	实例范围	适用场景
1	`singleton`	spring 核心	整个容器一个	无状态服务
2	`prototype`	spring 核心	每次获取新实例	有状态对象
3	`request`	spring web	每个 http 请求一个	请求级数据
4	`session`	spring web	每个 session 一个	用户会话数据
5	`application`	spring web	每个 servletcontext 一个	全局共享数据
6	`websocket`	spring websocket	每个 websocket 连接一个	websocket 会话
7	`refresh`	spring cloud	配置刷新时重建	动态配置
8	`globalsession`	portlet	全局会话一个	portlet 应用（旧版）

六、作用域的选择依据

场景	推荐作用域	理由
service、dao、controller	`singleton`	无状态，共享安全
有状态的对象	`prototype`	隔离状态
请求上下文	`request`	每个请求独立
用户登录信息	`session`	每个用户独立
全局计数器	`application`	全应用共享
websocket 会话	`websocket`	每个连接独立
动态配置	`refresh`	配置变更时刷新
线程隔离	自定义 `thread`	每个线程独立

七、注意事项

1. web 作用域需要代理

request、session、application、websocket 作用域的 bean 注入到 singleton bean 时，必须配置 proxymode，否则会报 scope 'xxx' is not active 错误。

2. 作用域名称大小写

spring 的作用域名称是区分大小写的。singleton 不能写成 singleton，prototype 不能写成 prototype。

3. 自定义作用域需要注册

自定义作用域必须先通过 customscopeconfigurer 注册到容器，才能在 @scope 中使用。

4. prototype 的销毁不归 spring 管

spring 只创建 prototype bean，不管理销毁。@predestroy 和 disposablebean 对 prototype bean 不生效。

5. refresh 依赖 spring cloud

refresh 作用域不是 spring framework 自带的，需要引入 spring cloud context 依赖。

八、总结

分类	作用域	数量
核心作用域	`singleton`、`prototype`	2
web 作用域	`request`、`session`、`application`、`websocket`	4
扩展作用域	`refresh`、`globalsession`	2
自定义作用域	`thread`、`tenant` 等	不限

spring 一共提供了 8 种可选的作用域（6 个内置 + 2 个扩展），另外还支持自定义。日常开发中最常用的是 singleton 和 prototype，web 项目中会用到 request 和 session，spring cloud 项目中会用到 refresh。理解每种作用域的实例范围和生命周期，是设计高质量 spring 应用的基础。

到此这篇关于spring 中完整的 scope 选项实例详解的文章就介绍到这了,更多相关spring scope 选项内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！