Spring MVC: Как использовать bean-объект в области запроса внутри порожденного потока?
В приложении Spring MVC у меня есть bean-объект в области запросов. Я ввожу этот бин куда-нибудь. Там поток обслуживания HTTP-запросов может создать новый поток.
Но всякий раз, когда я пытаюсь получить доступ к bean-объекту в области запроса из недавно созданного потока, я получаю org.springframework.beans.factory.BeanCreationException (см. трассировку стека ниже).
Доступ к bean-объекту в области запросов из потока HTTP-запросов работает нормально.
Как сделать bean-объект в области запросов доступным для потоков, созданных потоком HTTP-запросов?
Простая настройка
Запустите следующие фрагменты кода. Затем запустите сервер, например, по адресу http://example.com:8080/.
При доступе к http://example.com:8080/scopetestnormal каждый раз, когда делается запрос на этот адрес, counter увеличивается на 1 (заметно по выходу регистратора).:) Супер!
При доступе к http://example.com:8080/scopetestthread каждом запросе по этому адресу вызываются упомянутые исключения.:(. Независимо от того, что выбрано ScopedProxyModeэто происходит как для основанных на CGLIB, так и для JDK-динамических bean-компонентов, основанных на запросах
Конфигурационный файл
package com.example.config
@Configuration
@ComponentScan(basePackages = { "com.example.scopetest" })
public class ScopeConfig {
private Integer counter = new Integer(0);
@Bean
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public Number counter() {
counter = new Integer(counter.intValue() + 1);
return counter;
}
/* Adding a org.springframework.social.facebook.api.Facebook request-scoped bean as a real-world example why all this matters
@Bean
@Scope(value = "request", proxyMode = ScopedProxyMode.INTERFACES)
public Facebook facebook() {
Connection<Facebook> facebook = connectionRepository()
.findPrimaryConnection(Facebook.class);
return facebook != null ? facebook.getApi() : new FacebookTemplate();
}
*/
...................
}
Файл контроллера
package com.example.scopetest;
import javax.inject.Inject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.social.facebook.api.Facebook;
import org.springframework.social.facebook.api.FacebookProfile;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class ScopeTestController {
//@Inject
//private Facebook facebook;
@Inject
private Number counter;
private static final Logger logger = LoggerFactory
.getLogger(ScopeTestController.class);
@RequestMapping(value = "/scopetestnormal")
public void scopetestnormal() {
logger.debug("About to interact with a request-scoped bean from HTTP request thread");
logger.debug("counter is: {}", counter);
/*
* The following also works
* FacebookProfile profile = facebook.userOperations().getUserProfile();
* logger.debug("Facebook user ID is: {}", profile.getId());
*/
}
@RequestMapping(value = "/scopetestthread")
public void scopetestthread() {
logger.debug("About to spawn a new thread");
new Thread(new RequestScopedBeanAccessingThread()).start();
logger.debug("Spawned a new thread");
}
private class RequestScopedBeanAccessingThread implements Runnable {
@Override
public void run() {
logger.debug("About to interact with a request-scoped bean from another thread. Doomed to fail.");
logger.debug("counter is: {}", counter);
/*
* The following is also doomed to fail
* FacebookProfile profile = facebook.userOperations().getUserProfile();
* logger.debug("Facebook user ID is: {}", profile.getId());
*/
}
}
}
Трассировка стека для bean-объекта в области запросов (на основе CGLIB) (proxyMode = ScopedProxyMode.TARGET_CLASS)
SLF4J: Failed toString() invocation on an object of type [$java.lang.Number$$EnhancerByCGLIB$$45ffcde7]
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'scopedTarget.counter': 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.
at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:342)
at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:193)
at org.springframework.aop.target.SimpleBeanTargetSource.getTarget(SimpleBeanTargetSource.java:33)
at org.springframework.aop.framework.Cglib2AopProxy$DynamicAdvisedInterceptor.getTarget(Cglib2AopProxy.java:654)
at org.springframework.aop.framework.Cglib2AopProxy$DynamicAdvisedInterceptor.intercept(Cglib2AopProxy.java:605)
at $java.lang.Number$$EnhancerByCGLIB$$45ffcde7.toString(<generated>)
at org.slf4j.helpers.MessageFormatter.safeObjectAppend(MessageFormatter.java:304)
at org.slf4j.helpers.MessageFormatter.deeplyAppendParameter(MessageFormatter.java:276)
at org.slf4j.helpers.MessageFormatter.arrayFormat(MessageFormatter.java:230)
at ch.qos.logback.classic.spi.LoggingEvent.<init>(LoggingEvent.java:114)
at ch.qos.logback.classic.Logger.buildLoggingEventAndAppend(Logger.java:447)18:09:48.276 container [Thread-16] DEBUG c.g.s.c.c.god.ScopeTestController - counter is: [FAILED toString()]
at ch.qos.logback.classic.Logger.filterAndLog_1(Logger.java:421)
at ch.qos.logback.classic.Logger.debug(Logger.java:514)
at com.example.scopetest.ScopeTestController$RequestScopedBeanAccessingThread.run(ScopeTestController.java:58)
at java.lang.Thread.run(Thread.java:722)
Caused by: 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.
at org.springframework.web.context.request.RequestContextHolder.currentRequestAttributes(RequestContextHolder.java:131)
at org.springframework.web.context.request.AbstractRequestAttributesScope.get(AbstractRequestAttributesScope.java:40)
at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:328)
... 14 more
Трассировка стека для bean-объекта области запросов на основе интерфейса JDK-dynamic-proxy-interface (proxyMode = ScopedProxyMode.INTERFACES)
Exception in thread "Thread-16" org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'scopedTarget.facebook': 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.
at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:342)
at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:193)
at org.springframework.aop.target.SimpleBeanTargetSource.getTarget(SimpleBeanTargetSource.java:33)
at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:182)
at $Proxy28.userOperations(Unknown Source)
at com.example.scopetest.ScopeTestController$PrintingThread.run(ScopeTestController.java:61)
at java.lang.Thread.run(Thread.java:722)
Caused by: 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.
at org.springframework.web.context.request.RequestContextHolder.currentRequestAttributes(RequestContextHolder.java:131)
at org.springframework.web.context.request.AbstractRequestAttributesScope.get(AbstractRequestAttributesScope.java:40)
at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:328)
... 6 more
5 ответов
Хорошо, прочитав код в SimpleThreadScope, который поставляется с Spring, я думаю, что вы можете создать SimpleInheritableThreadScope, используя вместо этого InheritableThreadLocal.
Затем просто используйте немного xml для регистрации вашей пользовательской области:
<bean class="org.springframework.beans.factory.config.CustomScopeConfigurer">
<property name="scopes">
<map>
<entry key="thread-inherited">
<bean class="org.mael.spring.context.support.SimpleInheritableThreadScope"/>
</entry>
</map>
</property>
</bean>
Это означает, что когда вы создаете бин с thread-inherited у вас будет доступ к этому bean-компоненту с копией на поток, и эта копия будет доступна в потоках, порожденных вашим потоком, т. е. bean-объекте с областью запроса, который можно использовать в потоках, созданных в вашем потоке запросов.
Приведенная ниже конфигурация распространит контекст запроса на ваши потоки, запущенные из HTTP-запроса:
<servlet>
<servlet-name>Spring MVC Dispatcher Servlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>threadContextInheritable</param-name>
<param-value>true</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
Отказ от ответственности: я не проверял это конкретно с bean-объектами, определяемыми запросом, поскольку я не использую их. Я проверял, что RequestContextHolder возвращает действительный контекст в дочерних потоках.
Отказ от ответственности 2: есть причина, по которой этот параметр по умолчанию имеет значение false. Могут быть побочные эффекты, особенно если вы повторно используете ваши потоки (как в пулах потоков).
Если вы посмотрите на AbstractRequestAttributesScope вы увидите, что он использует текущий RequestAttributes для того, чтобы получить желаемый боб.
В вашей теме вы, вероятно, захотите сделать что-то вроде этого:
final RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
final SecurityContext securityContext = SecurityContextHolder.getContext();
new Thread(
() -> {
boolean hasContext = RequestContextHolder.getRequestAttributes() == requestAttributes
&& SecurityContextHolder.getContext() == securityContext;
if (!hasContext) {
RequestContextHolder.setRequestAttributes(requestAttributes);
SecurityContextHolder.setContext(securityContext);
}
try {
// useful stuff goes here
} finally {
if (!hasContext) {
RequestContextHolder.resetRequestAttributes();
SecurityContextHolder.clearContext();
}
}
}
).start();
Вдохновленный ответом @mael, вот мое "нестандартное решение". Я использую полностью управляемую аннотациями конфигурацию Spring.
Для моего конкретного случая, Spring's org.springframework.context.support.SimpleThreadScope уже обеспечивает поведение, которое ищет вопрос (правильно, это странно, потому что SimpleThreadScope не использует InheritableThreadLocal, но эффективно ThreadLocal, Но как это работает, я уже счастлив).
Правильное поведение при одновременном взаимодействии с пользователем еще не было проверено.
меры
Зарегистрировать SimpleThreadScope тип:
package com.example.config
public class MainConfig implements BeanFactoryAware {
private static final Logger logger = LoggerFactory.getLogger(MainConfig.class);
.......
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
if (beanFactory instanceof ConfigurableBeanFactory) {
logger.info("MainConfig is backed by a ConfigurableBeanFactory");
ConfigurableBeanFactory cbf = (ConfigurableBeanFactory) beanFactory;
/*Notice:
*org.springframework.beans.factory.config.Scope
* !=
*org.springframework.context.annotation.Scope
*/
org.springframework.beans.factory.config.Scope simpleThreadScope = new SimpleThreadScope();
cbf.registerScope("simpleThreadScope", simpleThreadScope);
/*why the following? Because "Spring Social" gets the HTTP request's username from
*SecurityContextHolder.getContext().getAuthentication() ... and this
*by default only has a ThreadLocal strategy...
*also see http://stackru.com/a/3468965/923560
*/
SecurityContextHolder.setStrategyName(SecurityContextHolder.MODE_INHERITABLETHREADLOCAL);
}
else {
logger.info("MainConfig is not backed by a ConfigurableBeanFactory");
}
}
}
Теперь для любого компонента, который должен иметь область действия запроса и который должен использоваться из любого потока, порожденного потоком HTTP-запроса, установите новую определенную область соответственно:
package com.example.config
@Configuration
@ComponentScan(basePackages = { "com.example.scopetest" })
public class ScopeConfig {
private Integer counter = new Integer(0);
@Bean
@Scope(value = "simpleThreadScope", proxyMode = ScopedProxyMode.TARGET_CLASS)
public Number counter() {
counter = new Integer(counter.intValue() + 1);
return counter;
}
@Bean
@Scope(value = "simpleThreadScope", proxyMode = ScopedProxyMode.INTERFACES)
public ConnectionRepository connectionRepository() {
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
if (authentication == null) {
throw new IllegalStateException("Unable to get a ConnectionRepository: no user signed in");
}
return usersConnectionRepository().createConnectionRepository(authentication.getName());
}
@Bean
@Scope(value = "simpleThreadScope", proxyMode = ScopedProxyMode.INTERFACES)
public Facebook facebook() {
Connection<Facebook> facebook = connectionRepository().findPrimaryConnection(Facebook.class);
return facebook != null ? facebook.getApi() : new FacebookTemplate();
}
...................
}
Для этого вопроса проверьте мой ответ по указанному выше URL
Использование bean-объекта области действия вне реального веб-запроса. Если вы используете веб-контейнер Servlet 2.5, с запросами, обрабатываемыми вне DispatcherServlet Spring (например, при использовании JSF или Struts), вам необходимо зарегистрировать org.springframework.web.context.request.RequestContextListener ServletRequestListener. Для Servlet 3.0+ это можно сделать программно через интерфейс WebApplicationInitializer. В качестве альтернативы или для старых контейнеров добавьте следующую декларацию в файл web.xml вашего веб-приложения: