在 Spring 中使用自定义解析器返回 HTTP 状态 BAD_REQUEST

Question

我正在使用 Spring Boot 1.5.15 开发一个 REST API。我已经实现了一个客户HandlerMethodArgumentResolver 来映射一个 HTTP 标头。具体来说，我分配了HTTP头Some-Header的值，去掉了前缀“XXX”。

首先，我定义了一个自定义注解。

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

然后，我实现了一个自定义解析器。

public class SomeHeaderArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterAnnotation(SomeHeader.class) != null;
    }

    @Override
    public Object resolveArgument(MethodParameter parameter,
                                  ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest,
                                  WebDataBinderFactory binderFactory) {
        HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
        final String headerValue = request.getHeader("Some-Header");

        return headerValue.replace("XXX ", "");
    }
}

最后，我让 Spring 知道配置类中的解析器。

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

现在，我可以在我需要的任何控制器中使用以下映射。

@PostMapping("/some/paath")
public void someMethod(@SomeHeader String someHeaderValue) {
   // Method body...
}

但是，Some-Header 信息对我来说是强制性的。我希望如果它不存在，Spring 会向调用者返回 400 Bad Request 响应。这与我使用 @RequestHeader("Some-Header") 注释可以获得的行为相同。

我可以复制相同的行为吗？可能，我不想使用专门的控制器建议。

Answer 1

感谢@madhu-bhat 提供的建议，我知道扩展哪个类来让 Spring 发挥作用是正确的。

类RequestHeaderMethodArgumentResolver，被Spring用来解析Java对象内部的HTTP头值，扩展了抽象类AbstractNamedValueMethodArgumentResolver。此类让您可以使用createNamedValueInfo 方法指定标头值是否具有某些默认值。

所以，它遵循代码。

public class SomeHeaderArgumentResolver extends AbstractNamedValueMethodArgumentResolver {
    @Override
    protected NamedValueInfo createNamedValueInfo(MethodParameter parameter) {
        // The second parameter specifies if the value is required, 
        // and the third if there is some default value.
        return new NamedValueInfo("", true, null);
    }

    @Override
    protected Object resolveName(String name, 
                                 MethodParameter parameter, 
                                 NativeWebRequest request) {
        final String headerValue = request.getHeader("Some-Value");
        if (StringUtils.isEmpty(headerValue)) {
            // Returning null tells Spring that there is no value for the parameter
            return null;
        }
        return headerValue.replace("XXX ", "");
    }

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return (parameter.hasParameterAnnotation(SomeHeader.class) &&
                !Map.class.isAssignableFrom(
                    parameter.nestedIfOptional().getNestedParameterType()));
    }
}

我唯一不喜欢的是我正在使用为处理命名值而开发的结构，但我没有命名值。

希望对你有帮助。

Answer 2

如果您看到用于@RequestHeader 的RequestHeaderMethodArgumentResolver 的实现，您将看到AbstractNamedValueMethodArgumentResolver 抽象类的handleMissingValue 方法的重写实现，如下所示：

@Override
protected void handleMissingValue(String name, MethodParameter parameter) throws ServletRequestBindingException {
        throw new ServletRequestBindingException("Missing request header '" + name +
                "' for method parameter of type " + parameter.getNestedParameterType().getSimpleName());
}

此handleMissingValue 方法用于AbstractNamedValueMethodArgumentResolver 的resolveArgument 方法，RequestHeaderMethodArgumentResolver 根据某些条件扩展了该方法。因此，当标头不存在并且 ServletRequestBindingException 被抛出时，Spring 的 DefaultHandlerExceptionResolver 将处理该问题并发送 400 响应。

这就是@RequestHeader 的验证方式。所以你可以在SomeHeaderArgumentResolver 类的resolveArgument 方法中实现类似的东西，如下所示：

public class SomeHeaderArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterAnnotation(SomeHeader.class) != null;
    }

    @Override
    public Object resolveArgument(MethodParameter parameter,
                                  ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest,
                                  WebDataBinderFactory binderFactory) {
        HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
        final String headerValue = request.getHeader("Some-Header");
        if(headerValue != null){
           return headerValue.replace("XXX ", "");
        } else {
           //handle scenario if header absent with ServletRequestBindingException
        }
       }
    }

Answer 3

您可以为任何情况声明自己的异常，并在控制器中设置 ExceptionHandler 以返回正确的 http-status。

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler({SameHeaderException.class})
public Object onSameHeaderException(SameHeaderException e) {
    return ImmutableMap.of("reason", e.getMessage());
}

所以如果没有标头，你可以抛出这个异常：

if (someHeaderValue == null) { throw new SameHeaderException(); }