「Java8」TransformerクラスでXML文字列を整形して出力するサンプル

2022年8月9日

環境
JavaSE 1.8
Eclipse 4.14.0

構文
public abstract void transform(Source xmlSource,Result outputTarget)　throws TransformerException
XML SourceをResultに変換します。Transformerがインスタンス化され、Transformerインスタンスが変更された際の特定の変換動作は、
有効なTransformerFactoryの設定によって判定されます。

使用例

package com.arkgame.study;

import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.StringWriter;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

import org.w3c.dom.Document;

public class CollectionsDemo {

      private static final String CHARSET = "UTF-8";
      // メソッドのプロパティの値は結果ツリーを出力するために使用される全体的なメソッドを識別します
      private static final String METHOD = "xml";
      // indentは、結果ツリーを出力する際にTransformerがさらに空白を追加するかどうかを指定します。
      private static final String INDENT = "yes";

      public static void main(String[] args) throws Exception {
            // XML文字列
            String strXml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><user><name><city>東京</city></name></user>";
            System.out.println("整形前のxml文字列\n" + strXml);
            try (InputStream in = new ByteArrayInputStream(strXml.getBytes(CHARSET));
                  StringWriter swr = new StringWriter()) {

                  // Documentオブジェクト生成
                  DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
                  DocumentBuilder db = dbf.newDocumentBuilder();
                  Document doc = db.parse(in);
                  doc.setXmlStandalone(true);

                  // Transformerオブジェクト生成し、フォーマット指定
                  Transformer tfm = TransformerFactory.newInstance().newTransformer();
                  tfm.setOutputProperty(OutputKeys.METHOD, METHOD);
                  // standalone="yes"指定
                  tfm.setOutputProperty(OutputKeys.INDENT, INDENT);
                  tfm.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");

                  // 変換処理
                  tfm.transform(new DOMSource(doc), new StreamResult(swr));

                  System.out.println("\nXML文字列を整形して出力する結果");
                  // 出力
                  System.out.println(swr);

                  swr.close();
            }
      }
}

実行結果

整形前のxml文字列
<?xml version="1.0" encoding="UTF-8"?><user><name><city>東京</city></name></user>

XML文字列を整形して出力する結果
<?xml version="1.0" encoding="UTF-8"?><user>
  <name>
    <city>東京</city>
  </name>
</user>