SpringBoot详细讲解异步任务如何获取HttpServletRequest

更新时间：2022年04月25日 11:35:34 作者：code2roc

在使用框架日常开发中需要在controller中进行一些异步操作减少请求时间，但是发现在使用@Anysc注解后会出现Request对象无法获取的情况，本文就此情况给出完整的解决方案

原因分析

@Anysc注解会开启一个新的线程，主线程的Request和子线程是不共享的，所以获取为null
在使用springboot的自定带的线程共享后，代码如下，Request不为null，但是偶发的其中body/head/urlparam内容出现获取不到的情况，是因为异步任务在未执行完毕的情况下，主线程已经返回，拷贝共享的Request对象数据被清空

ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
//设置子线程共享
RequestContextHolder.setRequestAttributes(servletRequestAttributes, true);
HttpServletRequest request = servletRequestAttributes.getRequest();

解决方案

前置条件

启动类添加@EnableAsync注解
标记@Async的异步方法不能和调用者在同一个class中

pom配置

        <!-- 阿里线程共享 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>transmittable-thread-local</artifactId>
            <version>2.11.0</version>
        </dependency>

requrest共享

通过TransmittableThreadLocal对象进行线程对象共享

public class CommonUtil {
    public static TransmittableThreadLocal<HttpServletRequest> requestTransmittableThreadLocal = new TransmittableThreadLocal<HttpServletRequest>();
    public static void shareRequest(HttpServletRequest request){
        requestTransmittableThreadLocal.set(request);
    }
    public static HttpServletRequest getRequest(){
        HttpServletRequest request = requestTransmittableThreadLocal.get();
        if(request!=null){
            return requestTransmittableThreadLocal.get();
        }else{
            ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            if(requestAttributes!=null){
                return  requestAttributes.getRequest();
            }else{
                return  null;
            }
        }
    }
    public static void remove(){
        requestTransmittableThreadLocal.remove();
    }
}

注：系统中所有Request获取需要统一从CommonUtil指定来源，例如token鉴权等

自定义request过滤器

通过自定义过滤器对Request的内容进行备份保存，主线程结束时Request清除结束不会影响到子线程的相应参数的获取，也适用于增加拦截器/过滤器后body参数无法重复获取的问题。需要注意的是对header参数处理时key要忽略大小写

public class HttpServletRequestReplacedFilter implements Filter, Ordered {
    @Override
    public void destroy() {
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
                         FilterChain chain) throws IOException, ServletException {
        ServletRequest requestWrapper = null;
        if (request instanceof HttpServletRequest) {
            requestWrapper = new RequestWrapper((HttpServletRequest) request);
        }
        //获取请求中的流如何，将取出来的字符串，再次转换成流，然后把它放入到新request对象中。
        // 在chain.doFiler方法中传递新的request对象
        if (requestWrapper == null) {
            chain.doFilter(request, response);
        } else {
            chain.doFilter(requestWrapper, response);
        }
    }
    @Override
    public void init(FilterConfig arg0) throws ServletException {
    }
    @Override
    public int getOrder() {
        return 10;
    }
}

public class RequestWrapper extends HttpServletRequestWrapper{
    private final byte[] body;
    private final HashMap<String,String> headMap;
    private final HashMap<String,String> requestParamMap;
    public RequestWrapper(HttpServletRequest request) throws IOException {
        super(request);
        body = CommonUtil.getBodyString(request).getBytes(Charset.forName("UTF-8"));
        headMap = new HashMap();
        Enumeration<String> headNameList = request.getHeaderNames();
        while (headNameList.hasMoreElements()){
            String key = headNameList.nextElement();
            headMap.put(key.toLowerCase(),request.getHeader(key));
        }
        requestParamMap = new HashMap<>();
        Enumeration<String> parameterNameList = request.getParameterNames();
        while (parameterNameList.hasMoreElements()){
            String key = parameterNameList.nextElement();
            requestParamMap.put(key,request.getParameter(key));
        }
    }
    @Override
    public BufferedReader getReader() throws IOException {
        return new BufferedReader(new InputStreamReader(getInputStream()));
    }
    @Override
    public ServletInputStream getInputStream() throws IOException {
        final ByteArrayInputStream bais = new ByteArrayInputStream(body);
        return new ServletInputStream() {
            @Override
            public int read() throws IOException {
                return bais.read();
            }
            @Override
            public boolean isFinished() {
                return false;
            }
            @Override
            public boolean isReady() {
                return false;
            }
            @Override
            public void setReadListener(ReadListener readListener) {
            }
        };
    }
    @Override
    public String getHeader(String name) {
        return headMap.get(name.toLowerCase());
    }
    @Override
    public String getParameter(String name) {
        return requestParamMap.get(name);
    }
}

自定义任务执行器

用于拦截异步任务执行，在任务执前统一进行Request共享操作，且可以定义多个，不影响原有的异步任务代码

public class CustomTaskDecorator implements TaskDecorator {
    @Override
    public Runnable decorate(Runnable runnable) {
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();
        System.out.println("异步任务共享request");
        return () -> {
            try {
                CommonUtil.shareRequest(request);
                runnable.run();
            } finally {
                CommonUtil.remove();
            }
        };
    }
}

@Configuration
public class TaskExecutorConfig {
    @Bean()
    public Executor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(20);
        executor.setQueueCapacity(200);
        executor.setKeepAliveSeconds(60);
        executor.setThreadNamePrefix("taskExecutor-");
        executor.setAwaitTerminationSeconds(60);
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        executor.initialize();
        return executor;
    }
    @Bean("shareTaskExecutor")
    public Executor hpTaskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(20);
        executor.setQueueCapacity(200);
        executor.setKeepAliveSeconds(60);
        executor.setThreadNamePrefix("shareTaskExecutor-");
        executor.setWaitForTasksToCompleteOnShutdown(true);
        executor.setAwaitTerminationSeconds(60);
        // 增加 TaskDecorator 属性的配置
        executor.setTaskDecorator(new CustomTaskDecorator());
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        executor.initialize();
        return executor;
    }
}

调用示例

给@Anysc注解指定进行共享拦截的任务执行器即可

    @PostMapping("/testAsync")
    @ResponseBody
    public Object testAsync(@RequestBody Map<String, Object> params) throws Exception{
        Result result = Result.okResult();
        asyncUtil.executeAsync();
        return result;
    }

@Component
public class AsyncUtil {
    @Async("shareTaskExecutor")
    public void executeAsync () throws InterruptedException {
        System.out.println("开始执行executeAsync");
        Thread.sleep(3000);
        System.out.println("结束执行executeAsync");
    }
}

到此这篇关于SpringBoot详细讲解异步任务如何获取HttpServletRequest的文章就介绍到这了,更多相关SpringBoot获取HttpServletRequest内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

SpringSecurity概念及整合ssm框架的示例详解
用户登录系统时我们协助 SpringSecurity 把用户对应的角色、权限组装好，同时把各个资源所要求的权限信息设定好，剩下的“登录验证”、“权限验证”等等工作都交给SpringSecurity，对SpringSecurity整合ssm框架相关知识感兴趣的朋友跟随小编一起看看吧
2022-12-12
Spring Utils工具类常用方法实例
这篇文章主要介绍了Spring Utils工具类常用方法实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-04-04
string boot 与自定义interceptor的实例讲解
下面小编就为大家分享一篇string boot 与自定义interceptor的实例讲解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2017-12-12
解析 MyBatis 中 Mapper 生效的来龙去脉
这篇文章主要介绍了解析 MyBatis 中 Mapper 生效的前因后果,介绍了mybatis基本使用及源码分析，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-08-08
Java 中的弱引用是什么
这篇文章主要介绍了Java 中的弱引用是什么，帮助大家更好的理解和使用Java，感兴趣的朋友可以了解下
2021-01-01
详解如何给SpringBoot部署的jar包瘦身
这篇文章主要介绍了如何给SpringBoot部署的jar包瘦身，如今迭代发布是常有的事情，每次都上传一个如此庞大的文件，会浪费很多时间，接下来小编就以一个小项目为例，来演示如何给jar包瘦身,需要的朋友可以参考下
2023-07-07
java局域网聊天小程序
这篇文章主要为大家详细介绍了java局域网聊天小程序，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-01-01
springboot整合spring-data-redis遇到的坑
使用springboot整合redis,使用默认的序列化配置,然后使用redis-client去查询时查询不到相应的key.问题出在哪，怎么解决呢？下面小编给大家带来了springboot整合spring-data-redis遇到的坑，需要的的朋友参考下吧
2017-04-04
Java开发工具-scala处理json格式利器-json4s详解
这篇文章主要介绍了开发工具-scala处理json格式利器-json4s,文章中处理方法讲解的很清楚，有需要的同学可以研究下
2021-02-02
javaCV视频处理之提取人像视频
这篇文章主要介绍了利用JavaCV实现提取视频中的人像并保存为视频，文中的示例代码讲解详细，对我们学习JavaCV有一定的帮助，需要的可以参考一下
2021-12-12