spring mvc自定义参数解析器

参数解析器

1. 参数解析器是spring mvc中将请求上下文中的请求参数转化要被调用的请求方法的参数的参数值。

2. 参数解析器的初始化是在Handler适配器中。

3. spring mvc默认的参数解析器有20多个，大概分为以下4类，这个是RequestMappingHandlerAdapter类里初始化设置HandlerMethodArgumentResolverComposite的加载顺序，所以自定义参数解析器的优先级并不高，但是有很多种方法调整他的优先级（搞明白他的原理，根据实际需求想怎么弄怎么弄）。

自定义参数解析器

自定义参数解析器可以实现接口：HandlerMethodArgumentResolver，接口声明如下：

public interface HandlerMethodArgumentResolver {

	/**
	 * 每个参数会被包装为MethodParameter，当这个参数每一次匹配参数解析器的时候，这个方法，会返回true或false
	 * ，true则匹配并缓存这个参数解析器，后续针对该参数不再匹配，fasle继续用下一个匹配
	 * 
	 */
	boolean supportsParameter(MethodParameter parameter);

	/**
	 * 参数解析的实现
	 */
	Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception;

}

实际上，根据情况并不需要每次都实现这个接口，可以根据自己的实际需要继承其中的某个实现重写方法定制。

如果我们解析的时候，需要使用参数名，可以直接继承AbstractNamedValueMethodArgumentResovler抽象类，并重写它的几个关键方法即可，下面会用一个示例说明。

代码示例

这个代码只是简单说明了实现过程作为一个示例，并不是全部实现：

首先自定义一个注解：

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

    @AliasFor("name")
    String value() default "";

    // 参数绑定的变量名
    @AliasFor("value")
    String name() default "";

    //参数是否必须
    boolean required() default true;

    // 没有获取到请求参数的时候的默认值
    String defaultValue() default ValueConstants.DEFAULT_NONE;
}

参数解析器的代码 ：

public class CustomRequestParamArgumentResolver extends AbstractNamedValueMethodArgumentResolver {

    // 如果没有重写这个方法，或者参数名信息为空，默认使用变量名
    @Override
    protected NamedValueInfo createNamedValueInfo(MethodParameter parameter) {
        CustomRequestParam customRequestParam = parameter.getParameterAnnotation(CustomRequestParam.class);
        return new CustomRequestParamNamedValueInfo(CustomRequestParam);
    }

    // 参数解析
    @Override
    protected Object resolveName(String name, MethodParameter parameter, NativeWebRequest request) throws Exception {
        // TODO: 解析参数值，并返回指定参数对象
        return null;
    }

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        // 只解析绑定有注解CustomRequestParam的参数，其它参数不处理
        return parameter.hasParameterAnnotation(CustomRequestParam.class);
    }

    static class CustomRequestParamNamedValueInfo extends NamedValueInfo {

        // 根据注解获得变量名等信息
        public CustomRequestParamNamedValueInfo(CustomRequestParam customRequestParam) {
            super(customRequestParam.name(), customRequestParam.required(), customRequestParam.defaultValue());
        }

    }
}

注册自定义参数解析器

如果要让自定义参数解析器注册到spring mvc，可以使用@EnableWebMvc自定义mvc配置的方式，关于它的具体使用及原理可以看这篇文章 spring mvc之注解@EnableWebMvc

下面是个示例代码：

@EnableWebMvc
@Configuration
public class CustomWebMvcConfiguration extends WebMvcConfigurerAdapter {

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

然后将这个配置bean被spring容器扫描到或者注册进去就可以了。