利用SpringMvc-HandlerMethodArgumentResolver 实现自定义参数解析器

利用SpringMvc-HandlerMethodArgumentResolver 实现自定义参数解析器

前言

在初学springmvc框架时，我就一直有一个疑问，为什么controller方法上竟然可以放这么多的参数，而且都能得到想要的对象，比如HttpServletRequest或HttpServletResponse，各种注解@RequestParam、@RequestHeader、@RequestBody、@PathVariable、@ModelAttribute等。相信很多初学者都曾经感慨过。

springmvc自带的一些实现：

ServletRequestMethodArgumentResolver和ServletResponseMethodArgumentResolver
处理了自动绑定HttpServletRequest和HttpServletResponse

RequestParamMapMethodArgumentResolver处理了@RequestParam
RequestHeaderMapMethodArgumentResolver处理了@RequestHeader
PathVariableMapMethodArgumentResolver处理了@PathVariable
ModelAttributeMethodProcessor处理了@ModelAttribute
RequestResponseBodyMethodProcessor处理了@RequestBody
……
我们可以模仿springmvc的源码，实现一些我们自己的实现类，而方便我们的代码开发。
public interface HandlerMethodArgumentResolver {

/**
 * 用于判定是否需要处理该参数分解，
 * 返回true为需要，并会去调用下面的方法resolveArgument。
 */
boolean supportsParameter(MethodParameter parameter);

/**
 *真正用于处理参数分解的方法，
 *返回的Object就是controller方法上的形参对象。
 */
Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
		NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception;
		}

示例1

本示例显示如何 优雅地将传入的信息转化成自定义的实体传入controller方法。

实现访问POST http://localhost:8080/demo1

post 数据

first_name = Bill

last_name = Gates

一般初学者喜欢在controller方法下面写这样的代码：

@Slf4j
@Controller
@RequestMapping("demo1")
public class HandlerMethodArgumentResolverDemoController {
@ResponseBody
@RequestMapping(method = RequestMethod.POST)
public String addPerson(HttpServletRequest request) {
	String firstName = request.getParameter("first_name");
	String lastName = request.getParameter("last_name");
	Person person = new Person(firstName, lastName);
	log.info(person.toString());
	return person.toString();
	}
}

这样的代码强依赖了javax.servlet-api的HttpServletRequest对象，并且把初始化Person对象这“活儿”加塞给了controller。代码显得累赘不优雅。在controller里我只想使用person而不想组装person，想要类似下面的代码：

@RequestMapping(method = RequestMethod.POST)
public String addPerson(Person person) {
log.info(person.toString());
return person.toString();
}

直接在形参列表中获得person。那么这该如实现呢？

我们需要定义如下的一个参数分解器：

public class PersonArgumentResolver 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 {

	String firstName = webRequest.getParameter("first_name");
	String lastName = webRequest.getParameter("last_name");
	return new Person(firstName, lastName);
}
}

在supportsParameter中判断是否需要启用分解功能，这里判断形参类型是否为Person类，也就是说当形参遇到Person类时始终会执行该分解流程resolveArgument。

在resolveArgument中处理person的初始化工作。

注册自定义分解器：

spring-boot方式

@SpringBootApplication
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

@Override
protected void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {

	// 注册Person的参数分解器
	argumentResolvers.add(new PersonArgumentResolver());
}
}

或者传统XML配置：

<mvc:annotation-driven>
<mvc:argument-resolvers>
	<bean class="com.demo.mvc.component.PersonArgumentResolver"/>
</mvc:argument-resolvers>
</mvc:annotation-driven>

或

<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
<property name="customArgumentResolvers">
  	<bean class="com.demo.mvc.component.PersonArgumentResolver"/>
</property>
</bean>

示例2

加强版Person分解器，支持多个person对象。

比如 POST http://localhost:8080/demo1

post 数据

person1.first_name = Bill

person1.last_name = Gates

person2.first_name = Steve

person2.last_name = Jobs

用前缀区分属于哪个person对象。

定义一个注解用于设定前缀：

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

public String value();
}

参数分解器：

public class MultiPersonArgumentResolver implements HandlerMethodArgumentResolver {

@Override
public boolean supportsParameter(MethodParameter parameter) {
	return parameter.hasParameterAnnotation(MultiPerson.class) && parameter.getParameterType().equals(Person.class);
}

@Override
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
	MultiPerson annotation = parameter.getParameterAnnotation(MultiPerson.class);
	String firstName = webRequest.getParameter(annotation.value() + ".first_name");
	String lastName = webRequest.getParameter(annotation.value() + ".last_name");
	return new Person(firstName, lastName);
	}
}

controller：

@ResponseBody
@RequestMapping(value = "multi", method = RequestMethod.POST)
public String addPerson(@MultiPerson("person1") Person person1, @MultiPerson("person2") Person person2) {
log.info(person1.toString());
log.info(person2.toString());
return person1.toString() + "\n" + person2.toString();
	}