使用ThreadLocal和ArgumentResolver方便开发

在web项目中我们通常都要根据当前用户进行一些操作，如果使用了一些权限框架，比如spring security或者shiro等，他们都提供了一个获取当前登录的用户的方法，直接调用即可，但是如果不使用相关框架，获取用户就略微显得有些复杂，为了简单，这时候ThreadLocal就能帮到我们了。

ThreadLocal提供本地线程变量。这个变量里面的值（通过get方法获取）是和其他线程分割开来的，变量的值只有当前线程能访问到，不像一般的类型比如Person,Student类型的变量，只要访问到声明该变量的对象，即可访问其全部内容，而且各个线程的访问的数据是无差别的

我们都知道，在web环境中，一个用户的请求是一直在一个线程中的，ThreadLocal刚好能帮助我们做到在第一次登录请求中的时候放入相关参数，比如用户信息，在后续请求中在线程中就可以拿到参数。

ThreadLocal

这里举一个简单的例子，写一个工具类，把当前用户和当前请求放入ThreadLocal中，并支持存取

工具类

public class RequestHolder {

    private static final ThreadLocal<User> userHolder = new ThreadLocal<>();

    private static final ThreadLocal<HttpServletRequest> requestHolder = new ThreadLocal<>();

    public static void add(User user) {
        userHolder.set(user);
    }

    public static void add(HttpServletRequest request) {
        requestHolder.set(request);
    }

    public static User getCurrentUser() {
        return userHolder.get();
    }

    public static HttpServletRequest getCurrentRequest() {
        return requestHolder.get();
    }

    public static void remove() {
        userHolder.remove();
        requestHolder.remove();
    }
}

如果你还需要更多常用参数，可以继续扩展上述方法。以上工具类，就可以很容易让我们拿到user和request了。

使用

由于我们主要目的就是在请求中拿到用户信息和请求的信息，我们可以这样做

首先在登录成功后，将登录信息放入session或者redis中
编写过滤器，拦截器或者切面等，判断当前用户是否登录(session或redis中是否有用户登录信息)，如果已经登录了，调用以下方法

RequestHolder.add(user); RequestHolder.add(reqest);

将我们需要的参数放入ThreadLocal中，以供后续使用。

在该请求未关闭之前，我们在其中任意地方可以调用以下方法获取用户信息或当前请求。

// 获取当前用户 RequestHolder.getCurrentUser();  // 获取当前请求 RequestHolder.getCurrentRequest();

在请求的最后，一般是拦截器或aop的方法后去调用remove()去释放资源。这部其实不做也可以，因为请求结束了线程一般会被销毁。本地变量自然也就不存在了。

ArgumentResolver

使用了ThreadLocal获取当前登录用户的信息已经很方便了，但是如果我们不想每次都调用静态方法RequestHolder.getCurrentUser()获取用户信息，在controller层中的方法中拿到用户信息可不可以呢，答案当然是可以。

我们可以编写一个参数解析器，在需要使用的controller方法参数中写上相关参数，就可以更方便的获取参数了。

编写参数解析器

举个简单的例子，我们这里编写一个UserArgumentResolver类并实现HandlerMethodArgumentResolver接口的方法。

在supportsParameter()方法中配置需要解析的参数(一般是类)

最后在resolveArgument()中调用上面编写的RequestHolder.getCurrentUser()即可。

@Service
public class UserArgumentResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        Class<?> clazz = parameter.getParameterType();
        return clazz == User.class;
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {

        return RequestHolder.getCurrentUser();
    }
}

在WebConfig中注册参数解析器

以spring boot的java conf为例

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    @Autowired
    private UserArgumentResolver userArgumentResolver;


    /**
     *
     * @param argumentResolvers
     */
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(userArgumentResolver);
    }


    /**
    ***
    ***
    */

    
}

使用

@GetMapping(value = "/xxx")
@ResponseBody
public Result miaoshaResult(User user) {
    //user.getName();
    // xxx
    return Result.success();
}

使用上述方式就完成了ThreadLocal和ArgumentResolver的配合，尤其对当前用户这种参数很实用，如果你还有其他需求，可以自行扩展。。。

注：

上述测试在ubuntu16.04 lts jdk1.8 spring boot 1.5.6.RELEASE中成功
上述文字皆为个人看法，如有错误或建议请及时联系我