SpringBoot中通过实现WebMvcConfigurer完成参数校验

在Spring5.0和SpringBoot2.0中废弃了WebMvcConfigurerAdapter类。

现有两种解决方案

1 直接实现WebMvcConfigurer （官方推荐）

2 直接继承WebMvcConfigurationSupport

本篇文章讨论下使用第一种方式完成参数校验。

首先附上代码。

@Slf4j
@Controller
@RequestMapping("/goods")
public class GoodsController {

    @Autowired
    MiaoshaUserService miaoshaUserService;


//    @GetMapping("/to_list")
//    public String toList(Model model, MiaoshaUser miaoshaUser) {
//        model.addAttribute("miaoshaUser",miaoshaUser);
//        return "list";
//    }


    @GetMapping("/to_list")
    public String toList(Model model,
                         HttpServletResponse response,
                         @CookieValue(value = MiaoshaUserServiceImpl.COOKIE_NAME_TOKEN,required = false)String cookieToken,
                         @RequestParam(value = MiaoshaUserServiceImpl.COOKIE_NAME_TOKEN,required = false)String paramToken) {
        if(StringUtils.isEmpty(cookieToken) && StringUtils.isEmpty(paramToken)){
            return "login";
        }
        String token = StringUtils.isEmpty(paramToken)?cookieToken:paramToken;
        MiaoshaUser miaoshaUser = miaoshaUserService.getByToken(response,token);
        model.addAttribute("miaoshaUser",miaoshaUser);
        return "list";
    }

}

toList需要实现的功能是在cookie或requestParam中获取到token，通过token去redis中获取详细的用户信息，再将用户信息放到页面进行展示。上面传统的方式入参有非常多，最后需要的是拿到MiaohshaUser对象，在程序的实际编写过程中，会有许多方法需要经过这样的过程获取到该对象，如何精简下代码，在入参只有需要获取的对象的时候，经过一系列的操作从cookie拿到token以及redis获取具体对象呢？

下面通过实现WebMvcConfigurer接口来实现。

/**
 * @author hsw
 * @Date 10:12 2018/5/8
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    UserArgumentResolver userArgumentResolver;

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

}

新建一个WebConfig类实现WebMvcConfigurer接口，WebMvcConfigurer是一个拦截器，里面有非常多的方法，我们用到的是addArgumentResolvers方法。需要注意的是类头需要加上@Configuration注解将该类交给spring管理。

addArgumentResolvers具体内容后文会提到。

新建UserArgumentResolver类实现HandlerMethodArgumentResolver接口

实现HandlerMethodArgumentResolver接口需要重写supportsParameter方法和resolveArgument方法。

resolveArgument中从cookie或requestparam中获取token值，并从redis中查询到具体的MiaoshaUser信息并返回。

UserArgumentResolver类编写完成后，在上面的WebConfig类中的addArgumentResolvers方法中将UserArgumentResolver类的实例添加进argumentResolvers参数中即可。

这两个类完成后，controller类中的toList方法如第一段注释代码所示。

/**
 * @author hsw
 * @Date 10:25 2018/5/8
 */
@Service
public class UserArgumentResolver implements HandlerMethodArgumentResolver {

    @Autowired
    MiaoshaUserService userService;

    /*
     * Miaoshauser类做参数校验
     * @author hsw
     * @date 2018/5/8 10:49
     * @param [methodParameter]
     * @return boolean
     */
    @Override
    public boolean supportsParameter(MethodParameter methodParameter) {
        Class<?> clazz = methodParameter.getParameterType();//如若不是MiaoshaUser类不进行接下来操作
        return clazz == MiaoshaUser.class;
    }

    @Override
    public Object resolveArgument(MethodParameter methodParameter,
                                  ModelAndViewContainer modelAndViewContainer,
                                  NativeWebRequest nativeWebRequest,
                                  WebDataBinderFactory webDataBinderFactory) throws Exception {
        HttpServletRequest request =nativeWebRequest.getNativeRequest(HttpServletRequest.class);//获取HttpServletRequest
        HttpServletResponse response =nativeWebRequest.getNativeResponse(HttpServletResponse.class);//获取HttpServletResponse  

        String paramToken = request.getParameter(MiaoshaUserServiceImpl.COOKIE_NAME_TOKEN);
        String cookieToken = getCookieValue(request,MiaoshaUserServiceImpl.COOKIE_NAME_TOKEN);
        if(StringUtils.isEmpty(cookieToken) && StringUtils.isEmpty(paramToken)){
            return null;
        }

        String token = StringUtils.isEmpty(paramToken)?cookieToken:paramToken;
        return userService.getByToken(response,token);//通过token查询详细信息并返回，返回类为MiaoshaUser
    }

    private String getCookieValue(HttpServletRequest request, String cookieName) {
        Cookie[] cookies = request.getCookies();
        for(Cookie cookie:cookies){
            if(cookie.getName().equals(cookieName)){
                return cookie.getValue();
            }
        }
        return null;
    }
}