Sformatowane wyjście XML w CXF?

Question

Wiem o możliwości włączenia formatowania przy użyciu programu Marshaller. Ale używam Apache CXF (JAX-RS) i zwracam odpowiedź jak return Response.ok(entity).build();.

Nie znalazłem żadnej opcji, jak sformatować dane wyjściowe. Jak mogę to zrobić?

Answer 1

Po pierwsze, sposobem na sformatowanie danych wyjściowych XML jest ustawienie właściwej właściwości na urządzeniu Marshaller (zwykle JAXB podczas pracy z CXF, co jest w porządku, ponieważ JAXB wykonuje dobrą pracę). Oznacza to, że gdzieś idziesz mieć coś w ten sposób:

marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); 

Problemem jest to, że nie koniecznie chcą mieć wszystko wyjście sformatowane; dodaje trochę do kosztów ogólnych. Na szczęście, jesteś już wytwarzania wyraźny Response, więc możemy po prostu użyć więcej cech, które:

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(); 

---

Inną metodą jest wymieniona w this JIRA issue (sama zamknięta, ale to nie jest tak wiele kwestii do ty):

Rozwiązaniem jest zarejestrowanie klasę obsługi wyjściowy, który może sprawdzić, co niestandardowe zapytania służy do żądania dodatkowego wcięcia:

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

JAXBElementProvider i JSONProvider są obsługiwane przez program JAXB Marshaller, dlatego domyślnie sprawdzają właściwość Marshaller.JAXB_FORMATTED_OUTPUT w bieżącej wiadomości.

Prowadzi to do kodu tak:

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 witryny discusses registration of interceptors.

Answer 2

Można wdrożyć MessageBodyWriter. Jest to mechanizm JAX-RS, który pozwala przesłonić sposób, w jaki obiekt jest kierowany do formatu 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<Object>{ 

    @Context 
    protected Providers providers; 

    public boolean isWriteable(Class<?> type, Type genericType, 
     Annotation[] annotations, MediaType mediaType) { 
     return true; 
    } 

    public void writeTo(Object object, Class<?> type, Type genericType, 
     Annotation[] annotations, MediaType mediaType, 
     MultivaluedMap<String, Object> httpHeaders, 
     OutputStream entityStream) throws IOException, 
     WebApplicationException { 
     try { 
      ContextResolver<JAXBContext> resolver 
       = providers.getContextResolver(JAXBContext.class, mediaType); 
      JAXBContext jaxbContext; 
      if(null == resolver || null == (jaxbContext = resolver.getContext(type))) { 
       jaxbContext = JAXBContext.newInstance(type); 
      } 
      Marshaller m = jaxbContext.createMarshaller(); 
      m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); 
      m.marshal(object, entityStream); 
     } catch(JAXBException jaxbException) { 
      throw new WebApplicationException(jaxbException); 
     } 
    } 

    public long getSize(Object t, Class<?> type, Type genericType, 
     Annotation[] annotations, MediaType mediaType) { 
     return -1; 
    } 

} 

Aby uzyskać więcej informacji

Poniżej znajduje się link do kompletnego przykład gdzie MessageBodyWriter jest używany jako część usługi JAX-RS.

• http://blog.bdoughan.com/2012/03/moxy-as-your-jax-rs-json-provider.html