Transformerを使用したサロゲートペアの出力について

Question

以下のようにTransformerを使用してxmlを出力しましたが、サロゲートペア文字を含む場合、文字参照で表示されます
「𠀋」と出力するには、どのようにすれば良いでしょうか？

サロゲート文字: 𠀋
出力:&#131083；(文字化けするためセミコロンを全角にしてあります)

package xml;

import java.io.File;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

import org.w3c.dom.Document;
import org.w3c.dom.Element;

public class XMLClass {

	static String kenmei[] = {"T𠀋okyo", "Kanagawa","Chiba","Saitama","Gunma","Tochigi","Ibaraki"};

	public static void main(String[] args) {

        // Documentインスタンスの生成
        DocumentBuilder documentBuilder = null;
        try {
             documentBuilder = DocumentBuilderFactory.newInstance()
                       .newDocumentBuilder();
        } catch (ParserConfigurationException e) {
             e.printStackTrace();
        }
    Document document = documentBuilder.newDocument();
    // standalone 属性を記述しない
    document.setXmlStandalone( true );

	 // XML文書の作成
    Element nihon = document.createElement("nihon");
    document.appendChild(nihon);
    Element chiiki = document.createElement("kanto");
    nihon.appendChild(chiiki);
    for (int i = 0; i <= 6; i++ ) {
        Element ken = (Element) document.createElement("ken").cloneNode(false);
        chiiki.appendChild(ken);
        ken.appendChild(document.createTextNode(kenmei[i]));
    }

    // XMLファイルの作成
    File file = new File("Kanto.xml");
    write(file, document);
	}


	public static boolean write(File file, Document document) {

        // Transformerインスタンスの生成
        Transformer transformer = null;
        try {
             TransformerFactory transformerFactory = TransformerFactory
                       .newInstance();
             transformer = transformerFactory.newTransformer();
        } catch (TransformerConfigurationException e) {
             e.printStackTrace();
             return false;
        }

        // Transformerの設定
        transformer.setOutputProperty("indent", "yes"); //改行指定
        transformer.setOutputProperty("encoding", "UTF-8"); // エンコーディング
        transformer.setOutputProperty("{http://xml.apache.org/xalan}indent-amount", "2");//インデントの桁指定



        // XMLファイルの作成
        try {
             transformer.transform(new DOMSource(document), new StreamResult(
                       file));
        } catch (TransformerException e) {
             e.printStackTrace();
             return false;
        }

        return true;
   }
}

Answer 1

復元できるなら𠀋のままでいいとおもいますがそれが不満なのであれば、UTF-16にすればいいのでは?

-  transformer.setOutputProperty("encoding", "UTF-8"); // エンコーディング
+  transformer.setOutputProperty("encoding", "UTF-16"); // エンコーディング

<?xml version="1.0" encoding="UTF-16"?><nihon>
  <kanto>
    <ken>T𠀋okyo</ken>
    <ken>Kanagawa</ken>
    <ken>Chiba</ken>
    <ken>Saitama</ken>
    <ken>Gunma</ken>
    <ken>Tochigi</ken>
    <ken>Ibaraki</ken>
  </kanto>
</nihon>

Comments

[momo1234567890]

すみません、文字コードについて、何度も文献を読み勉強はしているのですが、なかなか上手く理解できておりません。
関連して、質問させてください。

org.apache.commons.io.FileUtils.writeStringToFile(file,”𠀋“,StandardCharset.UTF_8)でファイル出力をし、それをサクラエディタなどで文字コードをUTF-8の状態で開くと、”𠀋”と表示出来るのは何故なのでしょうか？

[shiketa]

エディタの問題ではないですね。
XML的には、空白(0x20)を` `と書いてもいいし` `と書いてもいいし` `と書いてもいい。同様に「𠀋」を`𠀋`と書いてもいいし`𠀋`と書いてもいい。
JDKがデフォルトで提供するTransformerは、UTF-8のときサロゲートペア文字を`𠀋`のような形でエスケープして出力する仕様なのでしょう。
* https://docs.oracle.com/javase/jp/8/docs/api/javax/xml/transform/TransformerFactory.html
TransformerFactoryが提供するTransformerFactoryの実装クラスはシステムプロパティjavax.xml.transform.TransformerFactoryで設定できます。目的のカタチで出力する Transformer を返す、TransformerFactoryを実装すればあなたの好きなカタチで出力できると思います。

[momo1234567890]

大変納得できました。
ずっと不思議だと思っていましたが、腑に落ちました。
大変ありがとうございます。
これからも勉強を続けます！
ありがとうございました。

[shiketa]

かなり乱暴ですが、生成されたXMLを操作する、という手も。
```java
// XMLファイルの作成
try {
// transformer.transform(new DOMSource(document), new StreamResult(file));

ByteArrayOutputStream baos = new ByteArrayOutputStream();
transformer.transform(new DOMSource(document), new StreamResult(baos));

String xml = baos.toString();
while (true) {
Matcher ma = Pattern.compile(".*(\\&#(\\d+);).*", Pattern.DOTALL).matcher(xml);
if (!ma.matches()) break;

final String g1 = ma.group(1);
final String g2 = ma.group(2);
final String text = new String(new int[] { Integer.parseInt(g2) }, 0, 1);
xml = xml.replaceAll(g1, text);
}

PrintStream ps = new PrintStream(new FileOutputStream(file), true, "UTF-8");
ps.print(xml);
ps.close();
}
```