Как сгенерировать блок CDATA с помощью JAXB?

Ответ 1

Примечание. Я EclipseLink JAXB (MOXy) ведет и член группы JAXB (JSR-222).

Если вы используете MOXy в качестве поставщика JAXB, вы можете использовать расширение @XmlCDATA:

package blog.cdata;

import javax.xml.bind.annotation.XmlRootElement;
import org.eclipse.persistence.oxm.annotations.XmlCDATA;

@XmlRootElement(name="c")
public class Customer {

   private String bio;

   @XmlCDATA
   public void setBio(String bio) {
      this.bio = bio;
   }

   public String getBio() {
      return bio;
   }

}

Дополнительная информация

• http://bdoughan.blogspot.com/2010/07/cdata-cdata-run-run-data-run.html
• http://blog.bdoughan.com/2011/05/specifying-eclipselink-moxy-as-your.html

Ответ 2

Используйте Marshaller#marshal(ContentHandler) JAXB Marshaller#marshal(ContentHandler) для ContentHandler объект ContentHandler. Просто переопределения characters метода на реализации ContentHandler вы используете (например, JDOM SAXHandler, Apache XMLSerializer и т.д.):

public class CDataContentHandler extends (SAXHandler|XMLSerializer|Other...) {
    // see http://www.w3.org/TR/xml/#syntax
    private static final Pattern XML_CHARS = Pattern.compile("[<>&]");

    public void characters(char[] ch, int start, int length) throws SAXException {
        boolean useCData = XML_CHARS.matcher(new String(ch,start,length)).find();
        if (useCData) super.startCDATA();
        super.characters(ch, start, length);
        if (useCData) super.endCDATA();
    }
}

Это намного лучше, чем использование XMLSerializer.setCDataElements(...) потому что вам не нужно жестко указывать любой список элементов. Он автоматически выводит блоки CDATA только тогда, когда требуется.

Ответ 3

Решение:

• Ответ fred - это всего лишь обходное решение, которое будет терпеть неудачу при проверке содержимого, когда Marshaller связано с Schema, потому что вы изменяете только строковый литерал и не создаете разделы CDATA. Поэтому, если вы только переписываете String из foo в <! [CDATA [foo]] > , длина строки распознается Xerces с 15 вместо 3.
• Решение MOXy является специфичным для реализации и не работает только с классами JDK.
• Решение с getSerializer ссылается на устаревший класс XMLSerializer.
• Решение LSSerializer - это просто боль.

Я изменил решение a2ndrade с помощью реализации XMLStreamWriter. Это решение работает очень хорошо.

XMLOutputFactory xof = XMLOutputFactory.newInstance();
XMLStreamWriter streamWriter = xof.createXMLStreamWriter( System.out );
CDataXMLStreamWriter cdataStreamWriter = new CDataXMLStreamWriter( streamWriter );
marshaller.marshal( jaxbElement, cdataStreamWriter );
cdataStreamWriter.flush();
cdataStreamWriter.close();

Это реализация CDataXMLStreamWriter. Класс делегата просто делегирует все вызовы методов для данной реализации XMLStreamWriter.

import java.util.regex.Pattern;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

/**
 * Implementation which is able to decide to use a CDATA section for a string.
 */
public class CDataXMLStreamWriter extends DelegatingXMLStreamWriter
{
   private static final Pattern XML_CHARS = Pattern.compile( "[&<>]" );

   public CDataXMLStreamWriter( XMLStreamWriter del )
   {
      super( del );
   }

   @Override
   public void writeCharacters( String text ) throws XMLStreamException
   {
      boolean useCData = XML_CHARS.matcher( text ).find();
      if( useCData )
      {
         super.writeCData( text );
      }
      else
      {
         super.writeCharacters( text );
      }
   }
}

Ответ 4

Вот пример кода, на который ссылается упомянутый выше сайт:

import java.io.File;
import java.io.StringWriter;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.apache.xml.serialize.OutputFormat;
import org.apache.xml.serialize.XMLSerializer;
import org.w3c.dom.Document;

public class JaxbCDATASample {

    public static void main(String[] args) throws Exception {
        // unmarshal a doc
        JAXBContext jc = JAXBContext.newInstance("...");
        Unmarshaller u = jc.createUnmarshaller();
        Object o = u.unmarshal(...);

        // create a JAXB marshaller
        Marshaller m = jc.createMarshaller();

        // get an Apache XMLSerializer configured to generate CDATA
        XMLSerializer serializer = getXMLSerializer();

        // marshal using the Apache XMLSerializer
        m.marshal(o, serializer.asContentHandler());
    }

    private static XMLSerializer getXMLSerializer() {
        // configure an OutputFormat to handle CDATA
        OutputFormat of = new OutputFormat();

        // specify which of your elements you want to be handled as CDATA.
        // The use of the '^' between the namespaceURI and the localname
        // seems to be an implementation detail of the xerces code.
        // When processing xml that doesn't use namespaces, simply omit the
        // namespace prefix as shown in the third CDataElement below.
        of.setCDataElements(
            new String[] { "ns1^foo",   // <ns1:foo>
                   "ns2^bar",   // <ns2:bar>
                   "^baz" });   // <baz>

        // set any other options you'd like
        of.setPreserveSpace(true);
        of.setIndenting(true);

        // create the serializer
        XMLSerializer serializer = new XMLSerializer(of);
        serializer.setOutputByteStream(System.out);

        return serializer;
    }
}

Ответ 5

По тем же причинам, что и Майкл Эрнст, я не был так доволен большинством ответов здесь. Я не мог использовать его решение, поскольку мое требование заключалось в том, чтобы помещать теги CDATA в определенный набор полей - как в решении raidlstorfer OutputFormat.

Мое решение состоит в том, чтобы маршалировать документ DOM, а затем сделать нулевое преобразование XSL для вывода. Трансформаторы позволяют вам устанавливать, какие элементы обернуты в теги CDATA.

Document document = ...
jaxbMarshaller.marshal(jaxbObject, document);

Transformer nullTransformer = TransformerFactory.newInstance().newTransformer();
nullTransformer.setOutputProperty(OutputKeys.INDENT, "yes");
nullTransformer.setOutputProperty(OutputKeys.CDATA_SECTION_ELEMENTS, "myElement {myNamespace}myOtherElement");
nullTransformer.transform(new DOMSource(document), new StreamResult(writer/stream));

Дополнительная информация здесь: http://javacoalface.blogspot.co.uk/2012/09/outputting-cdata-sections-with-jaxb.html

Ответ 6

Следующий простой способ добавляет поддержку CDATA в JAX-B, которая не поддерживает CDATA изначально:

• объявить расширяемую строку настраиваемого простого типа CDataString, чтобы идентифицировать поля, которые должны обрабатываться через CDATA
• Создайте настраиваемый CDataAdapter, который анализирует и печатает содержимое в CDataString
• используйте привязки JAXB, чтобы связать CDataString и вы CDataAdapter. CdataAdapter добавит/удалит в/из CdataStrings в Marshall/Unmarshall time
• Объявить обработчик эскиза символов , который не удаляет символ при печати строк CDATA и устанавливает это как Marshaller CharacterEscapeEncoder

Et voila, любой элемент CDataString будет инкапсулирован во время Marshall. В немаршалом время автоматически будет удалено.

Ответ 7

Дополнение ответа @a2ndrade.

Я нахожу один класс для расширения в JDK 8. Но отметил, что класс находится в пакете com.sun. Вы можете сделать одну копию кода, если этот класс может быть удален в будущем JDK.

public class CDataContentHandler extends com.sun.xml.internal.txw2.output.XMLWriter {
  public CDataContentHandler(Writer writer, String encoding) throws IOException {
    super(writer, encoding);
  }

  // see http://www.w3.org/TR/xml/#syntax
  private static final Pattern XML_CHARS = Pattern.compile("[<>&]");

  public void characters(char[] ch, int start, int length) throws SAXException {
    boolean useCData = XML_CHARS.matcher(new String(ch, start, length)).find();
    if (useCData) {
      super.startCDATA();
    }
    super.characters(ch, start, length);
    if (useCData) {
      super.endCDATA();
    }
  }
}

Как использовать:

  JAXBContext jaxbContext = JAXBContext.newInstance(...class);
  Marshaller marshaller = jaxbContext.createMarshaller();
  StringWriter sw = new StringWriter();
  CDataContentHandler cdataHandler = new CDataContentHandler(sw,"utf-8");
  marshaller.marshal(gu, cdataHandler);
  System.out.println(sw.toString());

Пример результата:

<?xml version="1.0" encoding="utf-8"?>
<genericUser>
  <password><![CDATA[dskfj>><<]]></password>
  <username>UNKNOWN::UNKNOWN</username>
  <properties>
    <prop2>v2</prop2>
    <prop1><![CDATA[v1><]]></prop1>
  </properties>
  <timestamp/>
  <uuid>cb8cbc487ee542ec83e934e7702b9d26</uuid>
</genericUser>

Ответ 8

Как и в Xerxes-J 2.9, XMLSerializer устарел. Предложение заключается в замене его на DOM Level 3 LSSerializer или API преобразования JAXP для XML. Кто-нибудь пробовал подходить?

Ответ 9

Следующий код предотвратит кодирование элементов CDATA:

Marshaller marshaller = context.createMarshaller();
marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

StringWriter stringWriter = new StringWriter();
PrintWriter printWriter = new PrintWriter(stringWriter);
DataWriter dataWriter = new DataWriter(printWriter, "UTF-8", new CharacterEscapeHandler() {
    @Override
    public void escape(char[] buf, int start, int len, boolean b, Writer out) throws IOException {
        out.write(buf, start, len);
    }
});

marshaller.marshal(data, dataWriter);

System.out.println(stringWriter.toString());

Он также сохранит UTF-8 в качестве вашей кодировки.

Ответ 10

Просто слово предупреждения: согласно документации javax.xml.transform.Transformer.setOutputProperty(...), вы должны использовать синтаксис квалифицированных имен при указании элемента из другого пространства имен. Согласно JavaDoc (Java 1.6 rt.jar):

"(...) Например, если URI и локальное имя были получены из элемента, определенного с помощью, то квалифицированное имя будет" {http://xyz.foo.com/yada/baz.html} Foo. Обратите внимание, что префикс не используется. "

Ну, это не сработает - класс реализации из Java 1.6 rt.jar, то есть com.sun.org.apache.xalan.internal.xsltc.trax.TransformerImpl интерпретирует элементы, принадлежащие другому пространству имен, только тогда правильно, когда они объявляются как " http://xyz.foo.com/yada/baz.html:foo", потому что в реализации кто-то разбирает его в поисках последнего двоеточия. Поэтому вместо вызова:

transformer.setOutputProperty(OutputKeys.CDATA_SECTION_ELEMENTS, "{http://xyz.foo.com/yada/baz.html}foo")

который должен работать в соответствии с JavaDoc, но в итоге анализируется как "http" и "//xyz.foo.com/yada/baz.html", вы должны вызывать

transformer.setOutputProperty(OutputKeys.CDATA_SECTION_ELEMENTS, "http://xyz.foo.com/yada/baz.html:foo")

По крайней мере, в Java 1.6.