SpringBoot 2.2.2
说明
SpringBoot 通过拦截器获取 token 对应当前用户,完成登录拦截,使用自定义参数注解获取token中用户数据,并注入到方法中。
自定义参数解析器 HandlerMethodArgumentResolver
拦截器中preHandle方法返回的为false时,则无法进入切面
预期效果
在Controller接口中使用@CurrentUser
@RestController
public class OrderController
{
@RequestMapping("/queryOrderlList")
public Object queryOrderList(@CurrentUser User user, Integer page, Integer pageSize) {
//...code
return list;
}
}
一 自定义参数注解
CurrentUser.java
import java.lang.annotation.*;
@Target(ElementType.PARAMETER)//Annotation所修饰的对象范围:方法参数
@Retention(RetentionPolicy.RUNTIME)//Annotation被保留时间:运行时保留(有效)
@Documented//标记注解
public @interface CurrentUser {
}
二 自定义一个解析器
CurrentUser注解实现类,用于绑定@CurrentUser的方法参数解析器。
在解析器中返回一个固定的UserBean,实际的获取是从Session、数据库或者缓存中查询token。(本文是通过req.getAttribute()中获取)
新建CurrentUserMethodArgumentResolver 类,实现 HandlerMethodArgumentResolver 接口。
public class CurrentUserMethodArgumentResolver implements HandlerMethodArgumentResolver
{
@Override
public boolean supportsParameter(MethodParameter parameter) {
//判断是否支持使用@CurrentUser注解的参数; 如果该参数注解有@CurrentUser且参数类型是User
return parameter.getParameterAnnotation(CurrentUser.class) != null && parameter.getParameterType() == SysUser.class ;
}
@Override
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception
{
HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();//注入参数值
logger.info("get attribute currentUser ----" + request.getAttribute("currentUser"));
return request.getAttribute("currentUser");
}
}
isAssignableFrom
isAssignableFrom()方法与instanceof关键字的区别 https://blog.csdn.net/qq_36666651/article/details/81215221
注册到拦截器中
注解的实现类与拦截器,注册到拦截器中
@Configuration
public class WebMvcConfig implements WebMvcConfigurer
{
@Bean
public CurrentUserMethodArgumentResolver currentUserMethodArgumentResolver(){
return new CurrentUserMethodArgumentResolver();
}
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
argumentResolvers.add(currentUserMethodArgumentResolver());
}
}
拦截器中加入
在拦截器中设置 request.setAttribute(“currentUser”, user);
@Configuration
public class WebHandlerInterceptor implements HandlerInterceptor
{
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)throws Exception
{
final String token = request.getParameter("token");
if(Misc.isEmpty(token)) {
return false;
}
User user = CacheUtil.user.get(token);
if (user == null) {
return false;
}
request.setAttribute("currentUser", user);//
return true;
}
public boolean postHandle(HttpServletRequest request, HttpServletResponse rsp, Object handler)throws Exception{
return false;
}
public boolean afterCompletion(HttpServletRequest request, HttpServletResponse rsp, Object handler)throws Exception{
return false;
}
}
其他
关于自定义参数解析器
自定义解析器需要实现HandlerMethodArgumentResolver接口,HandlerMethodArgumentResolver接口包含两个接口函数:
public interface HandlerMethodArgumentResolver
{
boolean supportsParameter(MethodParameter var1);
@Nullable
Object resolveArgument(MethodParameter var1, @Nullable ModelAndViewContainer var2, NativeWebRequest var3, @Nullable WebDataBinderFactory var4) throws Exception;
}
WebMvcConfigurer
Spring 5.0后,WebMvcConfigurerAdapter被废弃,取代的方法有两种:
①implements WebMvcConfigurer(官方推荐)
②extends WebMvcConfigurationSupport
使用第一种方法是实现了一个接口,可以任意实现里面的方法,不会影响到Spring Boot自身的@EnableAutoConfiguration,而使用第二种方法相当于覆盖了@EnableAutoConfiguration里的所有方法,每个方法都需要重写,比如,若不实现方法addResourceHandlers(),则会导致静态资源无法访问
参考资料
SpringBoot 根据 token 获取当前用户完成登录拦截,并注入到方法中
https://yulaiz.com/spring-boot-authinterceptor-http-header-token-user/
https://blog.linchaokun.cn/89.html