SpringMVC自定义参数解析器
一、问题描述
前端把 token 存放在请求头里面,后端接口如果需要获取当前登录用户信息,我们是使用 HttpServletRequest 来获取请求头的 token,但是如果后续很多接口都需要获取当前登录用户信息,此时就出现代码重复问题。
二、假设分析
我们能不能做出一个接口参数,让所有访问这个具备指定参数的接口都能获取当前登录用户对象,该怎么实现?
三、应用技术
使用技术:SpringMVC 参数解析器
解析器有两种:
- SpringMVC 默认解析器
- 自定义参数解析器
作用:将接口(请求映射方法)UserInfo 类型的参数解析成当前登录用户对象
这两种,选哪个呢?不难看出,因为默认参数解析器是无法实现当前登录用户对象注入,此时选择第二种。
四、代码实现
业务需要区分场景的时候(比如登录与未登录),可以编写一个自定义注解
编写一个自定义注解,放于 annotation 包下
@Target(ElementType.PARAMETER) // 参数
@Retention(RetentionPolicy.RUNTIME)
public @interface UserParam {
}
新建一个 resolver 包,编写自定义解析器
/**
* 自定义参数解析器
* 作用:
* 将接口中声明 UserInfo 类型的参数,解析成当前登录用户对象,并注入
*/
public class UserInfoArgumentResolver implements HandlerMethodArgumentResolver {
@Autowired
private IUserInfoRedisService userInfoRedisService;
//用于识别接口参数类型
//指定当前解析器能解析接口参数的类型: 此处是UserInfo.class类型
@Override
public boolean supportsParameter(MethodParameter methodParameter) {
return methodParameter.getParameterType() == UserInfo.class
&& methodParameter.hasParameterAnnotation(UserParam.class);
}
//用于解析接口参数,并注入参数值
//前提: supportsParameter 方法返回true之后执行
@Override
public Object resolveArgument(MethodParameter methodParameter,
ModelAndViewContainer modelAndViewContainer,
NativeWebRequest nativeWebRequest,
WebDataBinderFactory webDataBinderFactory) throws Exception {
HttpServletRequest request = nativeWebRequest.getNativeRequest(HttpServletRequest.class);
String token = request.getHeader("token");
UserInfo userInfo = userInfoRedisService.getUserByToken(token);
return userInfo;
}
}
配置类
@Configuration
public class WebsiteConfig implements WebMvcConfigurer {
// 参数解析器
@Bean
public UserInfoArgumentResolver userInfoArgumentResolver(){
return new UserInfoArgumentResolver();
}
// 加进 HandlerMethodArgumentResolver 里面作为它的实现类
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
resolvers.add(userInfoArgumentResolver());
}
}
controller层
@GetMapping("/userInfo")
@ResponseBody
public Object user(@UserParam UserInfo user){
return JsonResult.success(user);
}
以上,代码已实现功能
那么,SpringMVC 的自定义参数解析器究竟是如何实现功能的呢?看流程图