Springboot——使用ThreadLocal进行请求前后参数数据传递

1,878 阅读2分钟

文章目录

ThreadLocal叫做线程变量,意思是ThreadLocal中填充的变量属于当前线程,该变量对其他线程而言是隔离的,也就是说该变量是当前线程独有的变量。ThreadLocal为变量在每个线程中都创建了一个副本,那么每个线程可以访问自己内部的副本变量。

ThreadLoal 变量,线程局部变量,同一个 ThreadLocal 所包含的对象,在不同的 Thread 中有不同的副本。这里有几点需要注意:

该副本只能由当前 Thread 使用
不存在多线程间共享的问题

ThreadLocal 提供了线程本地的实例。它与普通变量的区别在于,每个使用该变量的线程都会初始化一个完全独立的实例副本。ThreadLocal 变量通常被private static修饰。当一个线程结束时,它所使用的所有 ThreadLocal 相对的实例副本都可被回收。

总的来说,ThreadLocal 适用于每个线程需要自己独立的实例且该实例需要在多个方法中被使用,也即变量在线程间隔离而在方法或类间共享的场景

下图可以增强理解:

简介摘选 史上最全ThreadLocal 详解

结合Springboot使用

通常为了减少 校验 和 业务 频繁查询数据库使用。

定义MyThreadLocal

/**
 * 单实例
 */
public class MyThreadLocal {
 

    private MyThreadLocal() {
 
    }

    private static final ThreadLocal<String> threadLocal = new ThreadLocal<String>();

    /**
     * 对当前线程中的map域设置属性值,不会对其他线程产生影响  Thread.currentThread()
     * @param str
     */
    public static void set(String str){
 
        threadLocal.set(str);
    }

    public static String get(){
 
        return threadLocal.get();
    }

    /**
     * 本质上是调用当前线程的remove,不会对其他线程产生影响
     */
    public static void remove(){
 
        threadLocal.remove();
    }
}

定义拦截处理器

package com.nstc.bi.config.base;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class BaseInterceptor implements HandlerInterceptor {
 
    private Logger log = LoggerFactory.getLogger(BaseInterceptor.class);

    /**
     * 请求处理前
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
 
        // 获取请求头中的 单位编号 信息
        String userCltNo = request.getHeader("key");
        log.info("-----preHandle----userCltNo---{}",userCltNo);
        MyThreadLocal.set(userCltNo);
        return true;
    }

    /**
     * 请求处理后
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
 
        // 请求完后,需要清空 MyThreadLocal 集合数据
        // 避免 OOM
        MyThreadLocal.remove();
        log.info("-----afterCompletion----MyThreadLocal.remove()");
    }
}

定义指定请求拦截过滤

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
 

    @Autowired
    private BaseInterceptor baseInterceptor;

    /**
     * 针对所有的请求,增加一个获取header数据的解析
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
 
        registry.addInterceptor(baseInterceptor).addPathPatterns("/**");
    }
}