如何将HttpServletRequest参数添加到复杂的RestController bean？

Question

我有一个包含其余参数的复杂bean，例如：

public class MyRestParams {
    private HttpServletRequest req;
    private @NotBlank String name;

    //getter, setter
}

用法：

@RestController 
@RequestMapping("/xml")
public class MyServlet {
    @RequestMapping(value = "/")
    public void getTest(@Valid MyRestParams p) {
        Sysout(p.getName()); //works when invoked with /xml?name=test
        Sysout(p.getReq()); //always null
    }
}

问题： HttpServletRequest始终为null。 是否可以在Bean本身中添加此参数？

Answer 1

您可以提供HandlerMethodArgumentResolver的实现来解析MyRestParams ：

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

    @Override
    public Object resolveArgument(MethodParameter parameter, 
                                  ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest,
                                  WebDataBinderFactory binderFactory) throws Exception {
        MyRestParams restParam = new MyRestParams();
        restParam.setReq((HttpServletRequest) webRequest.getNativeRequest());

        return restParam;
    }
}

然后在您的WebMvcConfigurerAdapter注册它：

@EnableWebMvc
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(new MyRestParamsArgumentResolver());
    }
}

Answer 2

当使用这种形式的方法签名时，Spring会将您的bean用作模型属性。 Spring将使用WebDataBinder（例如ServletRequestDataBinder）将您的请求参数绑定到匹配名称的Bean属性。

由于没有与您的bean属性要求匹配的请求参数，因此永远不会设置该字段。 即使您的请求中存在名称为req的请求参数，也无法将其转换为HttpServletRequest。

要接收实际的请求，请在处理程序方法中添加HttpServletRequest类型的参数

 @RequestMapping(value = "/")
 public void getTest(@Valid MyRestParams p , HttpServletRequest request) {
    Sysout(p.getName()); //works when invoked with /xml?name=test
    Sysout(request); //always null
 }

如果您不想将自己绑定到Servlet API，则可以使用WebRequest类型的参数。