SpringMVC HandlerMethodArgumentResolver解读

HandlerMethodArgumentResolver:将请求报文绑定到处理方法形参的策略接口

/**
 * 策略模式接口：用于在给定的请求的上下文中将方法参数解析为参数值
 */
public interface HandlerMethodArgumentResolver {

    /**
     * 该处理程序是否支持给定的方法参数类型(只有返回true才回去调用 resolveArgument)
     */
    boolean supportsParameter(MethodParameter parameter);

    /**
     * 将方法参数从给定的请求中解析为参数值
     * 
     */
    Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
            NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception;

}

我们也可以实现自己的HandlerMethodArgumentResolver:

package cn.bjut.entity;

import org.springframework.core.MethodParameter;
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;

import java.util.Arrays;


public class MyHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        System.out.println(parameter.getMethod());
        System.out.println(parameter.getParameterType());
        System.out.println(Arrays.toString(parameter.getMethodAnnotations()));
        return parameter.getParameterType().equals(Person.class);
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        mavContainer.setRequestHandled(true);

        String name = webRequest.getParameter("name");
        Integer age = Integer.parseInt(webRequest.getParameter("age"));

        return new Person(name, age);
    }
}

Controller

@ResponseBody
    @RequestMapping(value = "/demo2", method = RequestMethod.GET)
    public String getPerson(Person person) {
        return person.toString();
    }

在SpringMVC添加如下配置：

<mvc:annotation-driven>
        <mvc:argument-resolvers>
            <bean class="cn.bjut.entity.MyHandlerMethodArgumentResolver"/>
        </mvc:argument-resolvers>
    </mvc:annotation-driven>

测试：

F:\>curl "http://localhost:8080/SpringMVCDemo/demo2?name=lgh&age=25"
Person{name='lgh', age=25}

我们也可以是使用HandlerMethodReturnValueHandler 来完成JSON到JavaBean的转换。

package cn.bjut.entity;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.core.MethodParameter;
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;

import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;


public class MyHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterType().equals(Person.class);
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        mavContainer.setRequestHandled(true);


        HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class);
        ServletInputStream inputStream = request.getInputStream();

        byte[] buffer = new byte[inputStream.available()];
        inputStream.read(buffer);

        String str = new String(buffer, "UTF-8");

        ObjectMapper objectMapper = new ObjectMapper();
        Person person = objectMapper.readValue(str, Person.class);

        inputStream.close();

        return person;
    }
}

@ResponseBody
    @RequestMapping(value = "/demo2", method = RequestMethod.POST, consumes = "application/json;charset=UTF-8")
    public String getPerson(Person person) throws JsonProcessingException {
        ObjectMapper objectMapper = new ObjectMapper();
        return objectMapper.writeValueAsString(person);
    }

以上配置还是有问题的，因为自定义的解析器加载到集合末尾。导致未能使用我们自定义的解析器。

//org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#getDefaultArgumentResolvers
    private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
        List<HandlerMethodArgumentResolver> resolvers = new ArrayList<>();

        // Annotation-based argument resolution
        resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), false));
        resolvers.add(new RequestParamMapMethodArgumentResolver());
        resolvers.add(new PathVariableMethodArgumentResolver());
        resolvers.add(new PathVariableMapMethodArgumentResolver());
        resolvers.add(new MatrixVariableMethodArgumentResolver());
        resolvers.add(new MatrixVariableMapMethodArgumentResolver());
        resolvers.add(new ServletModelAttributeMethodProcessor(false));
        resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters(), this.requestResponseBodyAdvice));
        resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters(), this.requestResponseBodyAdvice));
        resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));
        resolvers.add(new RequestHeaderMapMethodArgumentResolver());
        resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));
        resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));
        resolvers.add(new SessionAttributeMethodArgumentResolver());
        resolvers.add(new RequestAttributeMethodArgumentResolver());

        // Type-based argument resolution
        resolvers.add(new ServletRequestMethodArgumentResolver());
        resolvers.add(new ServletResponseMethodArgumentResolver());
        resolvers.add(new HttpEntityMethodProcessor(getMessageConverters(), this.requestResponseBodyAdvice));
        resolvers.add(new RedirectAttributesMethodArgumentResolver());
        resolvers.add(new ModelMethodProcessor());
        resolvers.add(new MapMethodProcessor());
        resolvers.add(new ErrorsMethodArgumentResolver());
        resolvers.add(new SessionStatusMethodArgumentResolver());
        resolvers.add(new UriComponentsBuilderMethodArgumentResolver());

        // Custom arguments
        if (getCustomArgumentResolvers() != null) {
            resolvers.addAll(getCustomArgumentResolvers());
        }

        // Catch-all
        resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
        resolvers.add(new ServletModelAttributeMethodProcessor(true));

        return resolvers;
    }

只能通过更改 RequestMappingHandlerAdapter 的实现来解决：

    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
        <property name="argumentResolvers">
            <bean class="com.meituan.ArgumentResolver.MyArgumentResolver"/>
        </property>
        <property name="order" value="123"/>
    </bean>

SpringMVC 提供了众多的参数解析器，所以我们很少需要再去自定义解析器了。