使用ThreadLocal在线程间传递参数

使用ThreadLocal在线程间传递参数

使用场景

用户参数透传，如租户ID，tid，userID，Token等。这些参数与具体业务无关，但是又是必须的（如：租户ID，在数据落库时需要传入，但是在其他业务代码中基本用不到）如果作为方法的参数一层一层向下传递，必然造成代码的冗余和扩展性查等影响。

整片文章就以租户ID为例子说明吧。

1.使用ThreadLocal结合AOP

大致思路：在请求接口时，租户ID往往可以从Token或用户信息中取出，这时，在请求拦截器中，将用户TenantID取出，放入线程中。后面在需要TenantID时，直接从线程中取出，这样，既保证了简洁性也增加了易用性。

2.Pom依赖

本文使用阿里线程工具。

<!--TTL-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>transmittable-thread-local</artifactId>
    <version>2.11.4</version>
</dependency>

3.RequestFilter

import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.GenericFilterBean;

import javax.servlet.FilterChain;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author litongzero
 */
@Slf4j
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class TenantContextHolderFilter extends GenericFilterBean {

	@Override
	@SneakyThrows
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) {
		HttpServletRequest request = (HttpServletRequest) servletRequest;
		HttpServletResponse response = (HttpServletResponse) servletResponse;
    // 从Token/Header/param中获取租户ID
		String headerTenantId = request.getHeader("TENANT_ID");

		log.debug("TenantContextHolderFilter|header中的TENANT_ID为:{}", headerTenantId);

    // 判断逻辑，自行定义
		if (headerTenantId != null && headerTenantId != "" && !headerTenantId.equals("null")) {
			TenantContextHolder.setTenantId(Integer.parseInt(headerTenantId));
    } else {
      // 默认值
			TenantContextHolder.setTenantId(0);
		}
		filterChain.doFilter(request, response);
    // 请求结束，一定要清除线程中自己设置的参数。
		TenantContextHolder.clear();
	}

}

4.TenantContextHolder（线程参数设置工具）

/**
 * @author litongzero
 */
@UtilityClass
public class TenantContextHolder {

	private final ThreadLocal<Integer> THREAD_LOCAL_TENANT = new TransmittableThreadLocal<>();

	/**
	 * TTL 设置租户ID<br/>
	 * @param tenantId
	 */
	public void setTenantId(Integer tenantId) {
		THREAD_LOCAL_TENANT.set(tenantId);
	}

	/**
	 * 获取TTL中的租户ID
	 * @return
	 */
	public Integer getTenantId() {
		return THREAD_LOCAL_TENANT.get();
	}

	/**
	 * 清除当前线程中的租户
	 * 慎用
	 */
	public void clear() {
		THREAD_LOCAL_TENANT.remove();
	}

}

5.使用

在具体的Controller，Service，Mapper中，只要是当前请求的线程，都是可以直接使用TenantContextHolder.getTenantId()获取租户ID的。