作者 | 麻酱
公号 | 码匠笔记
Java的
Web项目大部分都是基于
Tomcat，每次访问都是一个新的线程，看到这里让我们联想到了
ThreadLocal，每一个线程都独享一个
ThreadLocal，在接收请求的时候
set特定内容，在需要的时候
get这个值。下面我们就进入主题。
ThreadLocal，这个类能使线程中的某个值与保存的值的对象关联起来。
ThreadLocal提供
get和
set等接口或方法，这些方法为每一个使用这个变量的线程都存有一份独立的副本，因此
get总是返回由当前线程在调用
set时设置的最新值。
ThreadLocal有如下方法
public T get() { }
publicvoid set(T value) { }
publicvoid remove() { }
protected T initialValue() { }
get()方法是用来获取 ThreadLocal在当前线程中保存的变量副本set()用来设置当前线程中变量的副本remove()用来移除当前线程中变量的副本initialValue()是一个 protected方法，一般是用来在使用时进行重写的，如果在没有set的时候就调用 get，会调用 initialValue方法初始化内容。为了使用的更放心，我们简单的看一下具体的实现:
set方法
publicvoid set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if(map != null)
map.set(this, value);
else
createMap(t, value);
}
set方法会获取当前的线程，通过当前线程获取ThreadLocalMap对象。然后把需要存储的值放到这个map里面。如果没有就调用createMap创建对象。
getMap方法
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
getMap方法直接返回当前
Thread的
threadLocals变量，这样说明了之所以说
ThreadLocal是
线程局部变量就是因为它只是通过
ThreadLocal把
变量存在了
Thread本身而已。
createMap方法
void createMap(Thread t, T firstValue) {
t.threadLocals = newThreadLocalMap(this, firstValue);
}
set的时候如果不存在
threadLocals，直接创建对象。由上看出，放入
map的
key是当前的
ThreadLocal，
value是需要存放的内容，所以我们设置属性的时候需要注意存放和获取的是一个
ThreadLocal。
get方法
public T get() {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if(map != null) {
ThreadLocalMap.Entry e = map.getEntry(this);
if(e != null)
return(T)e.value;
}
return setInitialValue();
}
get方法就比较简单，获取当前线程，尝试获取当前线程里面的
threadLocals，如果没有获取到就调用
setInitialValue方法，
setInitialValue基本和
set是一样的，就不累累述了。
场景
ThreadLocal的场景：在调用API接口的时候传递了一些公共参数，这些公共参数携带了一些设备信息，服务端接口根据不同的信息组装不同的格式数据返回给客户端。假定服务器端需要通过设备类型(device)来下发下载地址，当然接口也有同样的其他逻辑，我们只要在返回数据的时候判断好是什么类型的客户端就好了。如下:
场景一
请求
GET api/users?device=android
返回
{
user : {
},
link : "https://play.google.com/store/apps/details?id=***"
}
场景二
请求
GET api/users?device=ios
返回
{
user : {
},
link : "https://itunes.apple.com/us/app/**"
}
实现
首先准备一个 BaseSigntureRequest类用来存放公共参数
publicclassBaseSignatureRequest{
privateString device;
publicString getDevice() {
return device;
}
publicvoid setDevice(String device) {
this.device = device;
}
}
然后准备一个 static的 ThreadLocal类用来存放 ThreadLocal，以便存储和获取时候的 ThreadLocal一致。
publicclassThreadLocalCache{
publicstaticThreadLocal<BaseSignatureRequest>
baseSignatureRequestThreadLocal = newThreadLocal<>();
}
然后编写一个 Interceptor，在请求的时候获取 device参数，存入当前线程的 ThreadLocal中。这里需要注意的是，重写了 afterCompletion方法，当请求结束的时候把 ThreadLocal remove，移除不必须要键值对。
public class ParameterInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
String device = request.getParameter("device");
BaseSignatureRequest baseSignatureRequest = new BaseSignatureRequest();
baseSignatureRequest.setDevice(device);
ThreadLocalCache.baseSignatureRequestThreadLocal.set(baseSignatureRequest);
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) throws Exception {
ThreadLocalCache.baseSignatureRequestThreadLocal.remove();
}
@Override
public void postHandle(HttpServletRequest httpServletRequest,
HttpServletResponse httpServletResponse,
Object o, ModelAndView modelAndView) throws Exception {
}
}当然需要在 spring里面配置 interceptor
<mvc:interceptors>
<mvc:interceptor>
<mvc:mappingpath="/api/**"/>
<beanclass="life.majiang.ParameterInterceptor"></bean>
</mvc:interceptor>
</mvc:interceptors>
最后在 Converter里面转换实体的时候直接使用即可，这样就大功告成了。
publicclassUserConverter{
publicstaticResultDO toDO(User user) {
ResultDO resultDO = newResultDO();
resultDO.setUser(user);
BaseSignatureRequest baseSignatureRequest = ThreadLocalCache.baseSignatureRequestThreadLocal.get();
String device = baseSignatureRequest.getDevice();
if(StringUtils.equals(device, "ios")) {
resultDO.setLink("https://itunes.apple.com/us/app/**");
} else{
resultDO.setLink("https://play.google.com/store/apps/details?id=***");
}
return resultDO;
}
总结
种机制很方便，因为他避免了在调用每一个方法时都要传递执行上下文信息，合理的使用
ThreadLocal可以起到事倍功半的效果，但是需要避免滥用，例如将所有的全局变量作为
ThreadLocal对象，
ThreadLocal类似全局变量，他能降低代码的可重用性，并在类之间引入隐含的耦合性，所以再使用前需要格外小心。
本文分享自微信公众号 - Java后端（web_resource）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。
相关文章
