在CXF中格式化XML输出？

Question

我知道使用Marshaller时如何打开格式的可能性。但是我正在使用Apache CXF（JAX-RS）并返回类似的响应return Response.ok(entity).build();。

我还没有找到如何格式化输出的任何选项。我该怎么做？

Answer 1

首先，获取XML格式化输出的方法是在编组器上设置正确的属性（通常在使用CXF时使用JAXB，因为JAXB做得很可靠，所以可以使用）。也就是说，在某个地方您将需要执行以下操作：

marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

问题是您不一定要格式化 所有 输出；它增加了很多开销。幸运的是，您已经在生成一个explicit Response，因此我们可以使用更多的功能：

Marshaller marshaller = JAXBContext.newInstance(entity.getClass()).createMarshaller();
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
StringWriter sw = new StringWriter();
marshaller.marshal(entity, sw);

return Response.ok(sw.toString(), MediaType.APPLICATION_XML_TYPE).build();

在此JIRA问题中提到了另一种方法（它本身已关闭，但对您而言并不是什么大问题）：

解决方法是注册一个自定义输出处理程序，该处理程序可以检查用于请求可选缩进的任何自定义查询：

http://svn.apache.org/repos/asf/cxf/trunk/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/FormatResponseHandler.java

JAXBElementProvider和JSONProvider由JAXB
Marshaller驱动，因此默认情况下，它们会检查当前消息上的Marshaller.JAXB_FORMATTED_OUTPUT属性。

这导致如下代码：

public class FormattedJAXBInterceptor extends AbstractPhaseInterceptor<Message> {
    public FormattedJAXBInterceptor() {
        super(Phase.PRE_STREAM);
    }

    public void handleMessage(Message message) {
        message.put(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
    }

    public void handleFault(Message messageParam) {
        message.put(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
    }
}

CXF网站讨论拦截器的注册。