如何在异步任务执行器中启用请求作用域

Question

在我的应用程序中，我有一些异步web服务。服务器接受请求，返回OK响应，并使用AsyncTaskExecutor开始处理请求。我的问题是如何在此处启用请求范围，因为在此处理中，我需要获取由以下注释的类：

@Scope(value = WebApplicationContext.SCOPE_REQUEST, proxyMode = ScopedProxyMode.TARGET_CLASS)

现在我得到异常：

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'scopedTarget.requestContextImpl': Scope 'request' is not active for the current thread; consider defining a scoped proxy for this bean if you intend to refer to it from a singleton; nested exception is java.lang.IllegalStateException: No thread-bound request found: Are you referring to request attributes outside of an actual web request, or processing a request outside of the originally receiving thread? If you are actually operating within a web request and still receive this message, your code is probably running outside of DispatcherServlet/DispatcherPortlet: In this case, use RequestContextListener or RequestContextFilter to expose the current request.

因为它在SimpleAsynctaskeExecutor中运行，而不是在DispatcherServlet中运行

我的异步处理请求

taskExecutor.execute(new Runnable() {

    @Override
    public void run() {
        asyncRequest(request);
    }
});

其中，taskExecutor是：

<bean id="taskExecutor" class="org.springframework.core.task.SimpleAsyncTaskExecutor" />

Answer 1

无法在子异步线程中获取请求范围的对象，因为原始父请求处理线程可能已经将响应提交给客户端并且所有请求对象都被销毁。处理此类场景的一种方法是使用自定义范围，例如SimpleThreadScope。

SimpleThreadScope的一个问题是，子线程不会继承父作用域变量，因为它在内部使用SimpleThreadLocal。为了克服这个问题，实现一个与SimpleThreadScope完全相似的自定义范围，但在内部使用InheritableThreadLocal。有关更多信息，请参阅今春注册MVC：如何在派生线程中使用请求范围的bean？

Answer 2

最简单的方法是使用这样的任务装饰器：

static class ContextCopyingDecorator implements TaskDecorator {
    @Nonnull
    @Override
    public Runnable decorate(@Nonnull Runnable runnable) {
        RequestAttributes context =
                RequestContextHolder.currentRequestAttributes();
        Map<String, String> contextMap = MDC.getCopyOfContextMap();
        return () -> {
            try {
                RequestContextHolder.setRequestAttributes(context);
                MDC.setContextMap(contextMap);
                runnable.run();
            } finally {
                MDC.clear();
                RequestContextHolder.resetRequestAttributes();
            }
        };
    }
}

要将此装饰器添加到任务执行器，您只需要将其添加到配置例程中：

@Override
@Bean
public Executor getAsyncExecutor() {
    ThreadPoolTaskExecutor poolExecutor = new ThreadPoolTaskExecutor();
    poolExecutor.setTaskDecorator(new ContextCopyingDecorator());
    poolExecutor.initialize();
    return poolExecutor;
}

不需要额外的持有者或自定义线程池任务执行器。

2021的一个小更新：使用当前版本的Spring Boot，仅仅存在一个类型为TaskDecorator的bean就足够了。创建上下文后，任务装饰器将用于装饰Spring Boot创建的执行器。

Answer 3

我们遇到了同样的问题——需要使用@Async在后台执行代码，因此它无法使用任何Session-或Request estScope bean。我们通过以下方式解决了它：

• 创建一个自定义TaskPoolExecitor，用于存储任务的范围信息
• 创建一个特殊的Callable（或Runnable），它使用信息来设置和清除后台线程的上下文
• 创建覆盖配置以使用自定义执行程序

注意：这只适用于会话和请求范围的bean，而不适用于安全上下文（如Spring Security）。如果您想要设置安全上下文，则必须使用另一种方法。

注2：为简洁起见，只显示了Callable和submit（）实现。您可以对Runnable和execute（）执行相同的操作。

代码如下：

执行人：

public class ContextAwarePoolExecutor extends ThreadPoolTaskExecutor {
    @Override
    public <T> Future<T> submit(Callable<T> task) {
        return super.submit(new ContextAwareCallable(task, RequestContextHolder.currentRequestAttributes()));
    }

    @Override
    public <T> ListenableFuture<T> submitListenable(Callable<T> task) {
        return super.submitListenable(new ContextAwareCallable(task, RequestContextHolder.currentRequestAttributes()));
    }
}

可调用：

public class ContextAwareCallable<T> implements Callable<T> {
    private Callable<T> task;
    private RequestAttributes context;

    public ContextAwareCallable(Callable<T> task, RequestAttributes context) {
        this.task = task;
        this.context = context;
    }

    @Override
    public T call() throws Exception {
        if (context != null) {
            RequestContextHolder.setRequestAttributes(context);
        }

        try {
            return task.call();
        } finally {
            RequestContextHolder.resetRequestAttributes();
        }
    }
}

配置：

@Configuration
public class ExecutorConfig extends AsyncConfigurerSupport {
    @Override
    @Bean
    public Executor getAsyncExecutor() {
        return new ContextAwarePoolExecutor();
    }
}