Spring的ResponseBodyAdvice：执行顺序是什么？

Question

我想实现一个自定义的 ResponseBodyAdvice，它只需要查找 Page<?> 并将总元素数添加到响应头中。

@ControllerAdvice
public class PageResponseAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return Page.class.isAssignableFrom(returnType.getParameterType());
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        ((Page<?>) body).getTotalElements();
        ...
    }

}

问题如下：

• 为什么beforeBodyWrite方法中的body是MappingJacksonValue类型？

• 有没有更好的方法来实现这个？/我是否使用了错误的拦截器？

我不想处理包装类，我只想在beforeBodyWrite方法中得到未经修改的普通Page对象。

---

编辑：

我现在只需要extend AbstractMappingJacksonResponseBodyAdvice就可以了。这样做很好，但感觉不对。也许还有更好的方法。

以下是Page -> Content-Range Header的代码：

@ControllerAdvice
public class PageResponseAdvice extends AbstractMappingJacksonResponseBodyAdvice {
    @Override public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return super.supports(returnType, converterType) && Page.class.isAssignableFrom(returnType.getParameterType());
    }

    @Override protected void beforeBodyWriteInternal(MappingJacksonValue bodyContainer, MediaType contentType, MethodParameter returnType, ServerHttpRequest request, ServerHttpResponse response) {
        Page<?> page = ((Page<?>) bodyContainer.getValue());
        Long from = null;
        Long to = null;
        if(page.getTotalElements() > 0 && page.getNumberOfElements() > 0) {
            from = Integer.valueOf(page.getNumber()).longValue()*page.getSize();
            to = from + page.getNumberOfElements() - 1;
        }
        response.getHeaders().add(
                HttpHeaders.CONTENT_RANGE,
                ContentRangeEncoder.encode(
                        "items",
                        from,
                        to,
                        page.getTotalElements()
                )
        );
        response.getHeaders().add(
                HttpHeaders.ACCEPT_RANGES,
                "items"
        );
    }
}

（如果有人感兴趣，这里是ContentRangeEncoder）：

public class ContentRangeEncoder {
    private static final Pattern TYPE_PATTERN = Pattern.compile("[a-zA-Z0-9]+");
    private static final Predicate<String> TYPE_PATTERN_PREDICATE = TYPE_PATTERN.asPredicate();

    public static <T extends Number & Comparable<T>> String encode(String unit, T from, T to, T length) {
        StringBuilder sb = new StringBuilder();
        if(unit != null) {
            Assert.isTrue(TYPE_PATTERN_PREDICATE.test(unit));
            sb.append(unit).append(" ");
        }

        if(from == null && to == null) {
            sb.append("*");
        } else {
            Assert.notNull(from);
            Assert.notNull(to);
            Assert.isTrue(from.compareTo(to) <= 0);
            sb.append(from).append("-").append(to);
        }
        sb.append("/");
        if(length == null) {
            sb.append("*");
        } else {
            Assert.isTrue(to == null || length.compareTo(to) > 0);
            sb.append(length);
        }
        return sb.toString();
    }
}

- Benjamin M

Answer 1

为什么body的类型是MappingJacksonValue，这取决于你的配置和特定处理程序方法的返回值。

顺便提一下，WebMvcConfigurationSupport向RequestMappingHandlerAdapter添加了JsonViewResponseBodyAdvice，如果此ResponseBodyAdvice bean在你之前被调用，那么这就解释了为什么body是MappingJacksonValue。body从一个ResponseBodyAdvice bean传递到另一个bean，每个bean返回自己认为合适的“form”中的body。

以下是'AbstractMappingJacksonResponseBodyAdvice' 的摘录，它是JsonViewResponseBodyAdvice的父类，可以看到body发生了什么：

public final Object beforeBodyWrite(@Nullable Object body,
    MethodParameter returnType, ..., ..., ..., ...) {

    //...

    MappingJacksonValue container = getOrCreateContainer(body);

    //...

    return container;
}

- NatFar