在开发过程中,我们时常会遇到与并发请求相关的问题。最近,我在实现一个图片预览功能时,发现多个并发请求时会引发资源加载错乱的问题。经过排查,最终锁定问题与 Spring Bean 的作用域设置有关。本文将详细记录问题的发现、分析及解决过程。
我需要实现的功能是在用户管理的表格中显示用户头像的预览图。前端通过url获取图片。但是却出现了一个意外的行为:每次刷新页面,图片可能会出现随机混乱,原本的图片1展示的可能却是图片2。我先后进行了如下排查:
在用户管理模块中,我需要通过后端 API 提供图片预览功能,接口代码如下:
@RestController
@RequestMapping("/api/media")
public class MediaApi {
private final MediaService fileService;
private final CustomResourceHttpRequestHandler customResourceHttpRequestHandler;
@Autowired
public MediaApi(MediaService mediaService, CustomResourceHttpRequestHandler customResourceHttpRequestHandler) {
this.fileService = mediaService;
this.customResourceHttpRequestHandler = customResourceHttpRequestHandler;
}
//预览文件
@GetMapping("/preview/{fileId}")
public ResponseEntity> preview(@PathVariable Long fileId, HttpServletRequest request, HttpServletResponse response) {
try {
// 解析文件路径
Path filePath = fileService.getFileFSPath(fileId);
// 设置资源路径
customResourceHttpRequestHandler.setResource(filePath);
// 设置响应头,inline 会在浏览器中显示或播放文件
response.setHeader(HttpHeaders.CONTENT_DISPOSITION, "inline; filename="" + filePath.getFileName() + """);
// 让 CustomResourceHttpRequestHandler 处理请求
customResourceHttpRequestHandler.handleRequest(request, response);
return new ResponseEntity(HttpStatus.OK);
} catch (GeneralException e) {
return ResponseEntity.ok().body(RestBean.failure(400, e.getMessage()));
} catch (Exception e) {
return new ResponseEntity(HttpStatus.INTERNAL_SERVER_ERROR);
}
}
}
其中,customResourceHttpRequestHandler
是一个自定义的 ResourceHttpRequestHandler
,用于处理静态资源。代码如下:
@Component
public class CustomResourceHttpRequestHandler extends ResourceHttpRequestHandler {
private Resource resource;
@Override
protected Resource getResource(@NonNull HttpServletRequest request) {
return this.resource;
}
public void setResource(Path filePath) throws MalformedURLException {
this.resource = new UrlResource(filePath.toUri());
setLocations(List.of(this.resource));
}
}
最初,接口可以正常返回图片,但在并发请求的情况下会出现资源错乱的问题。比如,访问 /preview/1
和 /preview/3
时,返回的图片可能都是 1 或者 3,而不是各自的资源。
通过排查发现,问题出在 CustomResourceHttpRequestHandler
的 resource
属性上。该属性在 setResource
方法中被动态修改,但 CustomResourceHttpRequestHandler
默认是单例的(singleton 作用域),因此多个请求共享了同一个 resource
,导致资源错乱。
Spring 默认会将 @Component
标注的 Bean 定义为单例。当多个线程并发访问时,Bean 的共享属性会存在线程安全问题。
为了解决这个问题,我们需要让 CustomResourceHttpRequestHandler
实例在每个请求中独立使用,避免共享状态。最简单的方式是将其作用域改为 request
:
@Component
@Scope("request", proxyMode = ScopedProxyMode.TARGET_CLASS) //这里必须设置request作用域,以避免并发请求时资源出现混乱的问题
public class CustomResourceHttpRequestHandler extends ResourceHttpRequestHandler {
private Resource resource; //问题根源,默认的作用域可能会导致多个请求共用一个资源,导致响应内容错乱
@Override
protected Resource getResource(@NonNull HttpServletRequest request) {
return this.resource;
}
public void setResource(Path filePath) throws MalformedURLException {
this.resource = new UrlResource(filePath.toUri());
setLocations(List.of(this.resource));
}
}
关键点
@Scope(value = "request")
:让 Spring 在每次 HTTP 请求时创建一个新的实例。proxyMode = ScopedProxyMode.TARGET_CLASS
:通过代理的方式注入 Bean,从而支持注入到单例 Bean 中。这样,每次请求都会创建一个独立的 CustomResourceHttpRequestHandler
,避免了资源错乱的问题。
配置 request
作用域时,控制台可能会出现如下警告:
Unable to proxy interface-implementing method ... because it is marked as final
这是由于 CGLIB 代理对 final
方法的限制,可以忽略这个警告,因为它不会影响功能。
想要消除警告也可以将对应的controller同样设置成request作用域,不使用代理注入:
@RestController
@Scope("request") //设置为request作用域
@RequestMapping("/api/media")
public class MediaApi {
}
@Component
@Scope("request") //设置为request作用域
public class CustomResourceHttpRequestHandler extends ResourceHttpRequestHandler {
}
通过将 Bean 的作用域调整为 request
或者移除共享状态,我们可以有效避免 Spring Bean 的并发问题。在实际开发中:
@Scope("request")
是解决每请求独立实例化问题的常见方式。参与评论
手机查看
返回顶部