【SpringMVC（六）】ArgumentResolver 使用 及 原理

ArgumentResovler是springmvc为我们提供的一个处理controller请求参数的扩展点。下面看一个常见的使用例子。

现在有一个web应用，api接口需要拿到一个userId，但是这个userId又不能直接通过http参数拿，可能是传一个token，然后，根据token从服务器取出登录用户的userId。

当然一种方案是在interceptor里面解析token拿到userId，然后存入ThreadLocal中；这种就需要我们所有需要用到userId的controller都写一段从ThreadLocal中get的代码；

这里介绍另一种，可能在代码上更简洁。直接在相应的controller方法的参数中写一个userId的入参，但是这个入参不是客户端传的，是在我们的一个ArgumentResovler内部解析传入的，解析也就是token拿到userId的过程。当然我们需要使用注解标注userId参数。

例子:

Resolver代码：

public class UserIdArgumentResolver implements HandlerMethodArgumentResolver {

    private static final String TOKEN_KEY = "clientId";
    private Map token2userId = ImmutableMap.of("ABC", 10086L);

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(UserId.class);
    }

    @Override
    public Object resolveArgument(MethodParameter parameter,
                                  ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest,
                                  WebDataBinderFactory binderFactory) throws Exception {
        // 通过session取userid
        String token = webRequest.getParameter(TOKEN_KEY);
        return token2userId.getOrDefault(token, 0L);
    }
}

Controller处理方法：

@RequestMapping(value = "/listFeed", method = RequestMethod.POST)
    public String feed(@UserId long userId) {
        System.out.println("userId: " + userId);
        return "success";
    }

springmvc配置：

主要就是加上了mvc：argumet-resolver配置。

最后使用postman来构建一个post请求，传入clientId参数：

控制台结果：

userId: 10086

可以看到controller里拿到了userId参数。

 

原理

bean的解析部分

解析springmvc配置文件，由于是在mvc命名空间下，所以找spring-mvc的jar包里的spring.handlers文件：

http\://www.springframework.org/schema/mvc=org.springframework.web.servlet.config.MvcNamespaceHandler

这个类就是解析mvc的类：

public class MvcNamespaceHandler extends NamespaceHandlerSupport {

	@Override
	public void init() {
		registerBeanDefinitionParser("annotation-driven", new AnnotationDrivenBeanDefinitionParser());
		registerBeanDefinitionParser("default-servlet-handler", new DefaultServletHandlerBeanDefinitionParser());
		registerBeanDefinitionParser("interceptors", new InterceptorsBeanDefinitionParser());
		registerBeanDefinitionParser("resources", new ResourcesBeanDefinitionParser());
		registerBeanDefinitionParser("view-controller", new ViewControllerBeanDefinitionParser());
		registerBeanDefinitionParser("redirect-view-controller", new ViewControllerBeanDefinitionParser());
		registerBeanDefinitionParser("status-controller", new ViewControllerBeanDefinitionParser());
		registerBeanDefinitionParser("view-resolvers", new ViewResolversBeanDefinitionParser());
		registerBeanDefinitionParser("tiles-configurer", new TilesConfigurerBeanDefinitionParser());
		registerBeanDefinitionParser("freemarker-configurer", new FreeMarkerConfigurerBeanDefinitionParser());
		registerBeanDefinitionParser("velocity-configurer", new VelocityConfigurerBeanDefinitionParser());
		registerBeanDefinitionParser("groovy-configurer", new GroovyMarkupConfigurerBeanDefinitionParser());
	}

}

这里定义了很多解析子标签的类，我们的resovler是定义在annotation-driven标签下的。所以是由AnnotationDrivenBeanDefinitionParser类处理的，该类里面的parse方法有一段：

ManagedList argumentResolvers = getArgumentResolvers(element, parserContext);
//省略很多		
RootBeanDefinition handlerAdapterDef = new RootBeanDefinition(RequestMappingHandlerAdapter.class);
//省略很多	
if (argumentResolvers != null) {
			handlerAdapterDef.getPropertyValues().add("customArgumentResolvers", argumentResolvers);
		}
String handlerAdapterName = parserContext.getReaderContext().registerWithGeneratedName(handlerAdapterDef);

可以看到，resolvers都被注入到一个RequestMappingHandlerAdaper类中，再看下getArgumentResolvers部分：

private ManagedList getArgumentResolvers(Element element, ParserContext parserContext) {
		Element resolversElement = DomUtils.getChildElementByTagName(element, "argument-resolvers");
		if (resolversElement != null) {
			ManagedList