当前位置 博文首页 > 阳阳的博客:【SpringBoot】HandlerMethodArgumentResolver的简

    阳阳的博客:【SpringBoot】HandlerMethodArgumentResolver的简

    作者:[db:作者] 时间:2021-08-14 21:04

    ? ? ? ? ? ? ? ? ? ? ? ? ?HandlerMethodArgumentResolver的简单使用

    一、前言

    现在项目有这样的一个需求,前端在请求头中传入userId,后端需要在controller中接收到此id的整个用户信息。

    面对这样的需求,我们当然可以拿到userId后,在controller调用的service中请求数据库,从而拿到整个用户信息。不过这样重复的代码太多,丝毫没有灵活性可言。

    因此我们考虑:能否在参数绑定的时候,就自动由userId往UserInfo对象中注入用户信息?当然是可以的,我们使用HandlerMethodArgumentResolver接口。


    二、HandlerMethodArgumentResolver是什么?

    HandlerMethodArgumentResolver,直接翻译是处理方法参数的解析器。说人话,这个类就是针对某一个方法列表的参数,比如UserInfo参数,原本前端只传入UserId,也就是UserInfo的其他参数都为null,但在解析器的改造下,UserInfo的整个属性都会有值,到时候我直接使用UserInfo参数。

    下面看看HandlerMethodArgumentResolver的源码

    public interface HandlerMethodArgumentResolver {
        boolean supportsParameter(MethodParameter var1);
    
        @Nullable
        Object resolveArgument(MethodParameter var1, @Nullable ModelAndViewContainer var2, NativeWebRequest var3, @Nullable WebDataBinderFactory var4) throws Exception;
    }

    由源码可知,HandlerMethodArgumentResolver是个接口,里面有两个抽象方法。

    boolean supportsParameter(MethodParameter var1) 
    是否支持此方法参数的解析,如果返回false,则不调用resolveArgument方法
    Object resolveArgument(MethodParameter var1, @Nullable ModelAndViewContainer var2, NativeWebRequest var3, @Nullable WebDataBinderFactory var4) throws Exception
    

    解析参数的方法,如果前端将userId放入请求头,则我们从NativeWebRequest中获取userId参数。该方法的返回值将自动注入到被注解标记的UserInfo中。


    三、简单示例

    我们的步骤分四步:类似于把大象放进冰箱

    (1)自定义注解,被注解标记的类,我们才对它使用解析器。(我现在只要找大象这个动物)

    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.PARAMETER)
    @Documented
    public @interface UserId {
    }

    (2)自定义解析器,到底怎么去解析。(把大象放进冰箱的方式)

    public class UserInfoResolver implements HandlerMethodArgumentResolver {
        @Override
        public boolean supportsParameter(MethodParameter methodParameter) {
            return methodParameter.hasParameterAnnotation(UserId.class);
        }
    
        @Override
        public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer, NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory) throws Exception {
            HttpServletRequest request = nativeWebRequest.getNativeRequest(HttpServletRequest.class);
            Long userId = Long.valueOf(request.getHeader("userId"));
            //查询数据库或缓存
            UserInfo userInfo = new UserInfo();
            userInfo.setUserId(userId);
            userInfo.setUserName("tom");
            userInfo.setUserAge(20);
            return userInfo;
        }
    }

    (3)注册解析器(给冰箱通电)

    @Configuration
    public class ConfigAdapter extends WebMvcConfigurerAdapter {
    
        @Override
        public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
            super.addArgumentResolvers(argumentResolvers);
            argumentResolvers.add(new UserInfoResolver());
            //当然可以增加一连串的解析器
            argumentResolvers.add(new FoodInfoResolver());
        }
    }

    (4)验证解析器(打开冰箱门看一看,大象还在里面吗)

    @RestController
    @RequestMapping("/user")
    public class UserController {
    
        @RequestMapping("/info")
        public void getUserInfo(@UserId UserInfo userInfo, @FoodId FoodInfo foodInfo) {
            System.out.println(userInfo.toString());
            System.out.println(foodInfo.toString());
        }
    }

    postman请求:

    控制台输出:

    大功告成!

    ?

    cs
    下一篇:没有了