如何利用 HandlerMethodArgumentResolver 为每个请求注入当前用户？

源码介绍以及部分代码实现

HandlerMethodArgumentResolver 处理器方法参数解析器

HandlerMethodArgumentResolver，中文名可以译为处理器方法参数解析器，在我们的 Spring 项目中，当然我们位于 Controller 层的处理器，可以应用于这个解析器，在用户的请求达到服务器时；我们可以进行拦截，其接口注释写得很清楚了：

翻译：这个接口负责处理，给定请求上下文的方法参数。

同时，与这个接口一起常用的，还有HandlerMethodReturnValueHandler，不过区别是，后者负责处理器经过处理后的返回参数。

supportsParameter 哪些参数是支持的？

基本上，这个方法用于判断：当拿到这个接口的所有请求参数后，是否当前的请求参数，经过该方法后，判定为支持解析。

resolveArgument 解析参数

当 supportsParameter 方法返回 true 后，会进入该方法，进入参数的解析过程。

• 在本文中，我们需要关注的是，MethodParameter 方法参数类以及 NativeWebRequest 原生网络请求类；

• 我们需要在 supportsParameter方法中从 MethodParameter 中判断我们要注入的点，然后通过 NativeWebRequest 中取出相应的 Token 信息（本文暂定是存放于 Header 请求头部中的）。

该方法的返回类型为 Object 类型，因此，最终我们要返回注入的用户信息类。

我们的目的，也很简单，为每个请求注入当前用户。

1. 在某个地方（可以是数据库，可以是本地缓存，或者分布式缓存等等）存储当前用户信息，当然是在登录之后，就更新当前用户信息（可以包括基本信息+权限+角色等自定义信息）。

2. 在请求某个接口时，进入这个解析器中，在该用户成功登录后（这个不是本文的范畴），我们确定可以从存储的某个地方中，拿到当前用户信息，同时拿到该方法中的方法参数，根据满足的规则（这里可以使用显式注解）来注入用户信息。

3. 在接口中，我们可以获得当前用户的相关信息，在多用户系统（尤其是微服务系统中，我们如何避免写一大堆的样板代码，去请求用户中心）中，尤其实用。

实践

@CurrentUser 定义当前用户的注解

/**
 * @author : vincent
 * @see com.todolist.es.demo.interceptor.LoginUserArgumentHandler
 * @since : 2022-10-10
 * Description : 获取在线用户信息的注解，并且声明这个注解是应用于方法参数<code>ElementType.PARAMETER</code>
 * 中的。
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface CurrentUser {

}

定义登录参数解析器组件继承 HandlerMethodArgumentResolver

/**
 * 该 <code>LoginUserArgumentHandler</code> 负责当每次请求接口时，获取当前登陆的 Token 信息
 * 以及从 Redis 中获取登陆时存入的当前用户信息；这里的 TokenUtils 基于jwt，可以引用
 * 其他优秀框架，譬如Sa-Token等...
 *
 * @author vincent
 * @see HandlerMethodArgumentResolver
 * @since 2022-10-10
 */
@Component
@Slf4j
public class LoginUserArgumentHandler implements HandlerMethodArgumentResolver {

    @Resource
    private IRedisService iRedisService;

    @Resource
    private UserService userService;

    @Resource
    private TokenUtils tokenUtils;

    /**
     * 当该方法参数所声明的注解（若有）为 @CurrentUser 时支持解析
     *
     * @param methodParameter 待检查的方法参数
     * @return 若返回 true 则支持解析 否则不支持
     */
    @Override
    public boolean supportsParameter(MethodParameter methodParameter) {
        return methodParameter.hasParameterAnnotation(CurrentUser.class);
    }

    @Override
    public Object resolveArgument(MethodParameter methodParameter,
                                  ModelAndViewContainer modelAndViewContainer,
                                  NativeWebRequest request,
                                  WebDataBinderFactory webDataBinderFactory) throws Exception {
        log.info("进入 LoginUserArgumentHandler 处理器...");
        String token = request.getHeader(BasicConstants.REFERENCE_TOKEN);
        BasicResponseEnum.TOKEN_NOT_FOUND.assertNotNull(token);
        User currentUser = null;

        if (Strings.isNotBlank(token)) {
            //首先从 redis 中查询
            log.info("试图从 Redis 中获取 Token 信息");
            String userInfoJsonString = iRedisService.hGet(RedisHashKeyConstants.LOGIN_USER_TOKEN_HASH, RedisHashKeyConstants.REFERENCE_USER);
            currentUser = JacksonUtils.fromJson(userInfoJsonString, User.class);
            if (Objects.isNull(currentUser)) {
                String userName = tokenUtils.getAudience(token);
                currentUser = userService.findByUserName(new User().setUserName(userName));
            }

            log.info("CurrentUser 获取完毕，当前用户信息为：{}", currentUser);
        }

        return currentUser;
    }
}

• 首先，我们判断当前请求是否含有有效 Token 凭证，若凭证不为空并且有效，我们尝试从缓存中（登陆时，我们需要将 Token 放入缓存中）反序列化出用户信息，并且注入到该方法参数中。

• 当然，我们需要包含保证方法参数定义的类型和这里返回的类型是一致的。

将该登陆参数解析器组件注入至容器运行时中

一般，我们使用继承 WebMvcConfigurer 接口来实现自定义配置的注入。

@Configuration
public class LoginUserParameterConfig implements WebMvcConfigurer {

    @Resource
    private LoginUserArgumentHandler loginUserArgumentHandler;

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(loginUserArgumentHandler);
    }
}

登陆时，我们需要将用户信息放入缓存中

在 Controller 层中的接口实现注入

到此本文结束 END 🔚