通过自定义 @CurrentUser 获取当前登录用户

文件变更

这节将增加 CurrentUser.java,CurrentUserMethodArgumentResolver.java 两个文件,并且修改 WebMvcConfigurer.java,各文件所在包如下。


文件变更

定义 @CurrenUser注解

/**
 * 在Controller的方法参数中使用此注解,该方法在映射时会注入当前登录的User对象
 */
@Target(ElementType.PARAMETER)          // 可用在方法的参数上
@Retention(RetentionPolicy.RUNTIME)     // 运行时有效
public @interface CurrentUser {
}

添加测试方法

在 userApi.java 中添加临时测试用的,测试完记得删掉。

@GetMapping("/test")
@LoginRequired
public Object testCurrentUser(@CurrentUser User user) {
    return user;
}

不要忘了添加 @LoginRequired 这个注解(上节添加的),要获取当前登录用户嘛,肯定得要求用户登录。重启项目访问 /api/user/test测试下。


记得填写 token(访问登录接口获取)。全是null,很遗憾现在还不能返回我们想要的用户信息。

添加参数解析器

要想 @CurrentUser 起作用,需要编写一个配套解析器,做法是实现 spring 提供的 HandlerMethodArgumentResolver 接口。
新增 CurrentUserMethodArgumentResolver.java

/**
 *  增加方法注入,将含有 @CurrentUser 注解的方法参数注入当前登录用户
 */
public class CurrentUserMethodArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterType().isAssignableFrom(User.class)
                && parameter.hasParameterAnnotation(CurrentUser.class);
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        User user = (User) webRequest.getAttribute("currentUser", RequestAttributes.SCOPE_REQUEST);
        if (user != null) {
            return user;
        }
        throw new MissingServletRequestPartException("currentUser");
    }
}

User user = (User) webRequest.getAttribute("currentUser", RequestAttributes.SCOPE_REQUEST) 这一句是从 request 作用域中取出名为 currentUser 的属性。currentUser 是什么呢?在上节编写的登录拦截器中,最后有这么一句 request.setAttribute("currentUser", user),所以 currentUser 是 token 验证通过之后查询到的当前用户。

配置参数解析器

在 WebMvcConfigurer.java 中 Override addArgumentResolvers 方法

@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
    argumentResolvers.add(currentUserMethodArgumentResolver());
    super.addArgumentResolvers(argumentResolvers);
}

@Bean
public CurrentUserMethodArgumentResolver currentUserMethodArgumentResolver() {
    return new CurrentUserMethodArgumentResolver();
}

再次测试

我是用 “张三” 这个用户登录获取的 token,正确地返回了张三的信息。

查看项目完整代码

项目地址: https://github.com/hyrijk/spring-boot-blog
克隆项目到本地

git clone https://github.com/hyrijk/spring-boot-blog.git

checkout 到当前版本

git checkout c241ab99dcfa14f278c40723b5ebd2c98d1c7424

完。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,924评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,296评论 25 708
  • 精益,打磨 1.液压实验 5小时! 2.做H5 5小时! *跟着内心的声音!
    橘子侠阅读 112评论 0 0
  • 连续灵修97天经文 【诗30:5】因为,他的怒气不过是转眼之间,他的恩典乃是一生之久。一宿虽然有哭泣,早晨便必欢呼...
    报佳音阅读 592评论 0 0
  • “如果能分清一位作者或者演说者的结论和理由,那么你已经大步迈上理性思考的终极目标--形成自己的理性判断。”这句话成...
    言小胡阅读 258评论 0 0