SpringMVC 工作原理四（自定义参数解析器）

在 SpringMVC 工作原理三（参数解析器）-CSDN博客 中我们由了解了参数解析器的工作原理，虽然 Spring MVC 帮我们实现了大部分场景下的参数解析器，但是有时在特殊场景下，现有的解析器不能满足需求，例如需要从请求头中提取特定信息并转换为自定义对象，或者处理某种特定格式的请求参数等，这时我们需要实现自定义参数解析器来满足我们的需求。

1.  自定义参数解析器解析分页数据

实现简易的参数解析器将分页信息封装为 PageVO 对象

@RestController
public class BasicController {

    // http://127.0.0.1:8080/user_page
    @GetMapping("/user_page")
    public PageVO userPage(@ResourceParam PageVO pageVO) {
        return pageVO;
    }
}

 

1.1 定义注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

    String value() default "";
}

1.2 PageVO类

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class PageVO {

    private int page;

    private int size;
}

1.3  实现 HandlerMethodArgumentResolver 接口

package com.example.autot.demos.web;

import org.apache.commons.lang3.StringUtils;
import org.springframework.core.MethodParameter;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

public class PageableHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        // 检查是否标注自定义注解 @ResourceParam，并且参数类型是否为 PageVO
        return parameter.getParameterType().equals(PageVO.class)
                && parameter.hasParameterAnnotation(ResourceParam.class);
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
                                  @NonNull NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {

        // 从请求域中获取 page 和 size 参数的值并封装为 PageVO对象
        String page = webRequest.getParameter("page");
        page = StringUtils.isEmpty(page) ? "0" : page;

        String size = webRequest.getParameter("size");
        size = StringUtils.isEmpty(size) ? "10" : size;

        return new PageVO(Integer.parseInt(page), Integer.parseInt(size));
    }

}

1.4 注册自定义解析器

通过 WebMvcConfigurer 将解析器添加到 Spring MVC 的解析器列表中

@Configuration
public class MyConfig implements WebMvcConfigurer {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(new PageableHandlerMethodArgumentResolver());
    }
}