web-dev-qa-db-ja.com

JAXBを使用してCDATAブロックを生成する方法は？

JAXBを使用してデータをXMLにシリアル化します。クラスコードは次のように簡単です。一部のArgsの値のCDATAブロックを含むXMLを生成したい。たとえば、現在のコードは次のXMLを生成します。

<command>
   <args>
      <arg name="test_id">1234</arg>
      <arg name="source">&lt;html>EMAIL&lt;/html></arg>
   </args>
</command>

「ソース」引数をCDATAでラップして、次のようにします。

<command>
   <args>
      <arg name="test_id">1234</arg>
      <arg name="source"><[![CDATA[<html>EMAIL</html>]]></arg>
   </args>
</command>

以下のコードでこれを達成するにはどうすればよいですか？

@XmlRootElement(name="command")
public class Command {

        @XmlElementWrapper(name="args")
        protected List<Arg>  arg;
    }
@XmlRootElement(name="arg")
public class Arg {

        @XmlAttribute
        public String name;
        @XmlValue
        public String value;

        public Arg() {};

        static Arg make(final String name, final String value) {
            Arg a = new Arg();
            a.name=name; a.value=value;
            return a; }
    }
javaxmljaxbcdata
39
Shreerang

注：私は EclipseLink JAXB（MOXy） リードおよび JAXB（JSR-222） エキスパートグループのメンバー.

JAXBプロバイダーとしてMOXyを使用している場合、@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;
   }

}

詳細情報

28
bdoughan

JAXBの Marshaller#marshal(ContentHandler) を使用して ContentHandler オブジェクトにマーシャリングします。使用しているContentHandler実装のcharactersメソッドをオーバーライドするだけです（例：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ブロックを自動的に出力します。

20
a2ndrade

ソリューションのレビュー：

  • Fredの答えは単なる回避策であり、Marshallerがスキーマにリンクされている場合、文字列リテラルのみを変更し、CDATAセクションを作成しないため、コンテンツの検証中に失敗します。したがって、ストリングをfooから<！[CDATA [foo]]>に書き換えるだけの場合、ストリングの長さは3ではなく15のXercesによって認識されます。
  • MOXyソリューションは実装固有であり、JDKのクラスでのみ機能しません。
  • 非推奨のXMLSerializerクラスへのgetSerializer参照を使用したソリューション。
  • LSSerializerのソリューションは苦痛です。

XMLStreamWriter実装を使用して、a2ndradeのソリューションを変更しました。このソリューションは非常にうまく機能します。

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 );
      }
   }
}
16
Michael Ernst

上記のサイトで参照されているコードサンプルは次のとおりです。

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;
    }
}
10
ra9r

マイケル・エルンストと同じ理由で、私はここでの答えのほとんどに満足していませんでした。 raiglstorferのOutputFormatソリューションのように、定義済みのフィールドセットにCDATAタグを配置する必要があるため、彼のソリューションは使用できませんでした。

私の解決策は、DOMドキュメントにマーシャリングしてから、出力を行うためにnull 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

9
Reg Whitton

次の簡単な方法は、CDATAをネイティブにサポートしないJAX-BのCDATAサポートを追加します。

  1. カスタム単純型CDataString拡張文字列を宣言して、CDATAを介して処理する必要があるフィールドを識別します
  2. CDataStringのコンテンツを解析および印刷するカスタムCDataAdapterを作成します
  3. JAXBバインディングを使用してCDataStringとCDataAdapterをリンクします。 CdataAdapterは、マーシャル/アンマーシャル時にCdataStringsに/からデータを削除します。
  4. CDATA文字列を印刷するときに文字をエスケープしないカスタム文字エスケープハンドラーを宣言し、これをMarshaller CharacterEscapeEncoderとして設定します

出来上がり、CDataString要素はマーシャル時にカプセル化されます。非整列化時に、は自動的に削除されます。

5
fred

@a2ndradeの回答の補足。

JDK 8で拡張するクラスが1つありますが、クラスはcom.Sunパッケージにあることに注意してください。このクラスが将来のJDKで削除される可能性がある場合に備えて、コードのコピーを1つ作成できます。

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>
4
bluearrow

Xerxes-J 2.9の時点で、XMLSerializerは非推奨になりました。提案は、DOM Level 3 LSSerializerまたはJAXPのXML用変換APIに置き換えることです。誰かがアプローチを試みましたか？

2
NBW

警告の言葉：javax.xml.transform.Transformer.setOutputProperty（...）のドキュメントによると、別のネームスペースの要素を示す場合は、修飾名の構文を使用する必要があります。 JavaDoc（Java 1.6 rt.jar）によると：

"（...）たとえば、URIで定義された要素から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。

0
zetzer

次のコードは、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エンコーディングとして。

0
Paulius Matulionis