CXF中的格式化XML输出?
我知道在使用Marshaller时如何打开格式的可能性。 但我正在使用Apache CXF(JAX-RS)并返回响应,如return Response.ok(entity).build();
。
我没有找到任何选项如何格式化输出。 我该怎么做?
首先,获取格式化XML输出的方法是在marshaller上设置正确的属性(在使用CXF时通常是JAXB,这是正常的,因为JAXB可以完成一项可信的工作)。 也就是说,在某个地方你会有这样的事情:
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
问题是您不一定要将所有输出格式化; 它增加了相当多的开销。 幸运的是,你已经产生了一个明确的Response
,所以我们可以使用更多的function:
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问题中提到了另一种方法(本身已经关闭,但对你来说这不是一个问题):
解决方法是注册一个自定义输出处理程序,它可以检查用于请求可选缩进的任何自定义查询:
JAXBElementProvider和JSONProvider由JAXB Marshaller驱动,因此默认情况下它们检查当前消息的Marshaller.JAXB_FORMATTED_OUTPUT属性。
这导致代码如下:
public class FormattedJAXBInterceptor extends AbstractPhaseInterceptor { 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网站讨论了拦截器的注册 。
您可以实现MessageBodyWriter
。 这是一种JAX-RS机制,允许您覆盖对象如何编组为XML。
package org.example; import java.io.*; import java.lang.annotation.Annotation; import java.lang.reflect.*; import javax.ws.rs.*; import javax.ws.rs.core.*; import javax.ws.rs.ext.*; import javax.xml.bind.*; @Provider @Produces(MediaType.APPLICATION_XML) public class FormattingWriter implements MessageBodyWriter
了解更多信息
下面是一个完整示例的链接,其中MessageBodyWriter
用作JAX-RS服务的一部分。