Java : XML (DOM) の基本

Tweet

XMLの構文は知っているけど、Javaで扱うにはどうしたらよいのかな…
そんなかたを対象に、本記事ではXMLを扱う基本となる DOM (Document Object Model) API について解説していきます。

対象読者：XMLの構文は理解しているかた

概要

JavaでXMLを扱うには、大きく分けて３つの種類のAPIがあります。

本記事では、この中の DOM (Document Object Model) を解説していきます。

DOMのAPIは W3C によって勧告されています。Java独自の仕様ではありません。
そのため、Java以外のプログラミング言語(例えばC#やPythonなど)でも実装されています。

JavaでDOMが理解できれば、他の言語でもほぼ同じ使い方ができます。
なので理解しておいて損はないかな、と。

JAXP セキュリティ・ガイド

少し難しい内容ですが、大事なことなので早めにご紹介してしまいます。
今はまだ読まなくてもよいですが、XMLの扱いに慣れてきたら下記の公式ドキュメントもご確認ください。

Java API for XML Processing (JAXP)セキュリティ・ガイド (Java SE 18)

XML処理中の潜在的な攻撃である

• XML外部エンティティ(XXE)インジェクション攻撃
• 指数関数的エンティティ展開攻撃

について解説しています。

また、それらの攻撃を回避するためのXMLConstants.FEATURE_SECURE_PROCESSINGやプロパティについても詳しく説明されています。
外部からの信頼されていないXMLを読み込む場合は、上記のページを熟読することをおすすめします。

XMLテキスト → DOM

DOMでは、XMLをツリー構造に表現して操作していきます。

XMLテキストからDOMのツリー構造を生成することを、パース(Parse)といいます。
Parse = 解析ですね。

それではコード例を見てみましょう。

final var xml = """
        <root><child-a/><child-b/></root>
        """;

final var builderFactory = DocumentBuilderFactory.newInstance();
final var builder = builderFactory.newDocumentBuilder();

final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final Element root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var nodes = root.getChildNodes();
for (int i = 0; i < nodes.getLength(); i++) {
    final var node = nodes.item(i);

    //i = 0 : [child-a: null]
    //i = 1 : [child-b: null]
    System.out.println("i = " + i + " : " + node);
}

XML形式の文字列をパースしてDOMのツリー構造を生成します。
そして、ツリー構造の内容を確認しています。

コードを少しずつ見ていきましょう。

DOMのツリー構造では、ツリーの一番の親は Document となります。
そのため、Document を生成するための DocumentBuilder を生成するための DocumentBuilderFactory から生成していきます。

// DocumentBuilerを生成するためのFactoryを生成します。
final var builderFactory = DocumentBuilderFactory.newInstance();

// FactoryでDocumentBuilderを生成します。
final var builder = builderFactory.newDocumentBuilder();

// DocumentBuilderでDocumentを生成します。
// 対象となるXMLはInputStreamとして読み込ませています。(他にはURIやファイルからなども可能)
final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

Document は、ルートとなる１つの Element を持ちます。

final Element root = document.getDocumentElement();
System.out.println(root); // [root: null]

Element は複数の子ノードを持ちます。

final var nodes = root.getChildNodes();
for (int i = 0; i < nodes.getLength(); i++) {
    final var node = nodes.item(i);

    //i = 0 : [child-a: null]
    //i = 1 : [child-b: null]
    System.out.println("i = " + i + " : " + node);
}

ツリー構造は次のようなイメージになります。

DOM → XMLテキスト

DOMからXMLテキストに変換するには Transformer を使います。

Transformer は Java独自のAPI です。
DOM専用というわけではなく、SAX や StAX、文字列にも使える汎用的なAPIとなっています。

final var xml = """
        <root><child>aaa</child></root>
        """;

final var builderFactory = DocumentBuilderFactory.newInstance();
final var builder = builderFactory.newDocumentBuilder();

final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final var transformerFactory = TransformerFactory.newInstance();
final var transformer = transformerFactory.newTransformer();

final var source = new DOMSource(document);
final var result = new StreamResult(new StringWriter());

transformer.transform(source, result);

//<?xml version="1.0" encoding="UTF-8" standalone="no"?><root><child>aaa</child></root>
System.out.println(result.getWriter());

XMLテキストをまずDOM形式にパースして、それを Transformer で再びXMLテキストへと変換する例となります。
コードを少しずつ見ていきましょう。

// Transformerを生成するためのFactoryを生成します。
final var transformerFactory = TransformerFactory.newInstance();

// FactoryでTransformerを生成します。
final var transformer = transformerFactory.newTransformer();

DocumentBuilder のときと同じように、Transformer を生成するためにまず Factory を生成します。

Transformer.transform で実際に変換します。
Source → Result へと変換されます。

// SourceとしてDOMを使います。
final var source = new DOMSource(document);

// 結果はストリーム(文字列)で受け取ります。
final var result = new StreamResult(new StringWriter());

// 変換します。
transformer.transform(source, result);

Source と Result は SAX や StAX などにも対応しています。
詳細は API仕様をご参照ください。

//<?xml version="1.0" encoding="UTF-8" standalone="no"?><root><child>aaa</child></root>
System.out.println(result.getWriter());

無事、StringWriter 経由で結果を文字列として取得できました。

<?xml ～ ?> の部分は、XML宣言といいます。
Tranformer ではデフォルトで出力します。

もし出力させたくない場合は、次の setOutputProperty で設定できます。

出力形式の設定

Transformer.setOutputProperty ​を使うことで、出力形式を設定できます。
nameパラメータに指定できる文字列は、OutputKeys クラスに定義されています。

よく使うのは、

• OMIT_XML_DECLARATION
• INDENT

あたりでしょうか。

OMIT_XML_DECLARATION の例です。

final var xml = """
        <root><child>aaa</child></root>
        """;
... 省略 ...

final var transformer = transformerFactory.newTransformer();

// デフォルトは"no"
System.out.println(transformer.getOutputProperty(OutputKeys.OMIT_XML_DECLARATION)); // "no"

// "yes"に変更
transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");

final var source = new DOMSource(document);
final var result = new StreamResult(new StringWriter());

transformer.transform(source, result);

//<root><child>aaa</child></root>
System.out.println(result.getWriter());

OMIT_XML_DECLARATION を "yes" に設定すると、XML宣言の <?xml ～ ?> は出力しません。

INDENT の例です。

final var xml = """
        <root><child>aaa</child></root>
        """;
... 省略 ...

final var transformer = transformerFactory.newTransformer();

// デフォルトは"no"
System.out.println(transformer.getOutputProperty(OutputKeys.INDENT)); // "no"

// "yes"に変更
transformer.setOutputProperty(OutputKeys.INDENT, "yes");

final var source = new DOMSource(document);
final var result = new StreamResult(new StringWriter());

transformer.transform(source, result);

//<?xml version="1.0" encoding="UTF-8" standalone="no"?>
//<root>
//    <child>aaa</child>
//</root>
System.out.print(result.getWriter());

見やすいように、改行とスペースをいい感じに入れてくれます。

ただし、１点注意があります。
インデントされたXMLテキストをそのままパースすると、追加された改行とスペースは Textノードとしてツリー構造に追加されます。

final var xml = """
        <root>
            <child>aaa</child>
        </root>
        """;

final var builderFactory = DocumentBuilderFactory.newInstance();
final var builder = builderFactory.newDocumentBuilder();

final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();

final var nodes = root.getChildNodes();
for (int i = 0; i < nodes.getLength(); i++) {
    final var node = nodes.item(i);

    // 見やすさのため、半角スペースは * 改行は \n として表記します。

    //i = 0 : [#text: \n****]
    //i = 1 : [child: null]
    //i = 2 : [#text: \n]
    System.out.println("i = " + i + " : " + node);
}

ノードの操作

今までの例では、XMLテキストをパースすることにより、Nodeのツリー構造を作成してきました。
もちろん、XMLテキストなしで、１から Nodeのツリー構造を作成することも可能です。

コード例を見てみましょう。

final var builderFactory = DocumentBuilderFactory.newInstance();
final var builder = builderFactory.newDocumentBuilder();

// 空のDocumentを生成します。
final var document = builder.newDocument();

// ルートとなるElementを作成して、documentに追加します。
final var root = document.createElement("root");
document.appendChild(root);

// 子となるElement(child-a)を作成して、rootに追加します。
final var childA = document.createElement("child-a");
root.appendChild(childA);

// Textノードを作成して、child-aに追加します。
final var text = document.createTextNode("aaaa");
childA.appendChild(text);

// 子となるElement(child-b)を作成して、rootに追加します。
final var childB = document.createElement("child-b");
root.appendChild(childB);

// 属性ノード bbb="ccc" を作成して、child-bに設定します。
final var attr = document.createAttribute("bbb");
attr.setValue("ccc");

childB.setAttributeNode(attr);

final var transformerFactory = TransformerFactory.newInstance();
final var transformer = transformerFactory.newTransformer();

transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
transformer.setOutputProperty(OutputKeys.INDENT, "yes");

final var source = new DOMSource(document);
final var result = new StreamResult(new StringWriter());

transformer.transform(source, result);

//<root>
//    <child-a>aaaa</child-a>
//    <child-b bbb="ccc"/>
//</root>
System.out.print(result.getWriter());

Document.create～で各種ノードを生成し、appendChild で子ノードとして追加していく、というのが基本となります。

Node

Node は、すべてのツリー構造の要素の基底となるインタフェースです。

ただし、属性(Attr)は少し特殊で、ツリー構造の一部とはならずに Element に直接保持されます。

どのノードがどのノードを子ノードとして持てるのか？　もしくはノードを持てないのか？というのは上記の DOM仕様で定義されています。

主要なノードのみに絞ると次のようになります。

• Document -- Element (maximum of one), Comment
• Element -- Element, Text, Comment
• Attr -- Text
• Comment -- no children
• Text -- no children

Comment や Text は子ノードを持てないことが分かりますね。

Node の主要なメソッドは、ツリー構造に関するものです。
親ノードを取得(getParent)、子ノードを追加(appendChild​)、子ノードを取得(getChildNodes) などがあります。

final var element = document.createElement("element");
System.out.println(element.getNodeType() == Node.ELEMENT_NODE); // true

final var text = document.createTextNode("text");
System.out.println(text.getNodeType() == Node.TEXT_NODE); // true

final var attr = document.createAttribute("attr");
System.out.println(attr.getNodeType() == Node.ATTRIBUTE_NODE); // true

final var xml = """
        <root><child><child-child/></child></root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var child = root.getFirstChild();
System.out.println(child); // [child: null]

final var childChild = child.getFirstChild();
System.out.println(childChild); // [child-child: null]

final var childChildParent = childChild.getParentNode();
System.out.println(childChildParent); // [child: null]
System.out.println(childChildParent == child); // true

final var childParent = child.getParentNode();
System.out.println(childParent); // [root: null]
System.out.println(childParent == root); // true

final var xml = """
        <root><child-a/><child-b/><child-c/></root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var firstChild = root.getFirstChild();
System.out.println(firstChild); // [child-a: null]

final var xml = """
        <root><child-a/><child-b/><child-c/></root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var lastChild = root.getLastChild();
System.out.println(lastChild); // [child-c: null]

final var xml = """
        <root><child-a/><child-b/><child-c/></root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var nodes = root.getChildNodes();
for (int i = 0; i < nodes.getLength(); i++) {
    final var node = nodes.item(i);

    //i = 0 : [child-a: null]
    //i = 1 : [child-b: null]
    //i = 2 : [child-c: null]
    System.out.println("i = " + i + " : " + node);
}

final var xml = """
        <root><child-a/></root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var childB = document.createElement("child-b");
root.appendChild(childB);

final var text = document.createTextNode("bbb");
childB.appendChild(text);

...

transformer.transform(source, result);

//<root>
//    <child-a/>
//    <child-b>bbb</child-b>
//</root>
System.out.print(result.getWriter());

final var xml = """
        <root><child-z/></root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var childZ = root.getFirstChild();
System.out.println(childZ); // [child-z: null]

final var childY = document.createElement("child-y");
root.insertBefore(childY, childZ);

final var childX = document.createElement("child-x");
root.insertBefore(childX, childY);

...

transformer.transform(source, result);

//<root>
//    <child-x/>
//    <child-y/>
//    <child-z/>
//</root>
System.out.print(result.getWriter());

NodeList

Node.getChildNodes や Element.getElementsByTagName などで、複数の Node を返すときに使われます。

Java標準API の Listインタフェース ではないので、少し使いづらいですね。(拡張for文も使えません)
素直に、通常のfor文でループさせるのがよさそうです。

final var xml = """
        <root><child-a/><child-b/><child-c/></root>
        """;

final var builderFactory = DocumentBuilderFactory.newInstance();
final var builder = builderFactory.newDocumentBuilder();

final var document = builder.parse(new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var nodes = root.getChildNodes();
for (int i = 0; i < nodes.getLength(); i++) {
    final var node = nodes.item(i);

    //i = 0 : [child-a: null]
    //i = 1 : [child-b: null]
    //i = 2 : [child-c: null]
    System.out.println("i = " + i + " : " + node);
}

Document

Document は、DOMのツリー構造の一番親となるノードです。
ルートとなる１つの Elementノードを持ちます。

そして、Element や Text、Attr といった各種ノードを生成する役割をもちます。

final var xml = """
        <root><child/></root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var element = document.createElement("element");
System.out.println(element); // [element: null]
System.out.println(element.getNodeType() == Node.ELEMENT_NODE); // true

final var attr = document.createAttribute("aaa");
attr.setValue("bbb");

System.out.println(attr); // aaa="bbb"
System.out.println(attr.getNodeType() == Node.ATTRIBUTE_NODE); // true

final var text = document.createTextNode("abcd");
System.out.println(text); // [#text: abcd]
System.out.println(text.getNodeType() == Node.TEXT_NODE); // true

final var comment = document.createComment("abcd");
System.out.println(comment); // [#comment: abcd]
System.out.println(comment.getNodeType() == Node.COMMENT_NODE); // true

Element

Element は、XML構造の 要素 を表します。

子ノードとして Element、Comment、Text などを複数持つことが可能です。
また、子ノードとしてではないですが、属性(Attr)を複数持つことが可能です。

主要なメソッドとコード例になります。

final var element = document.createElement("element");
System.out.println(element.getTagName()); // "element"

final var xml = """
        <root>
            <child-a>
                <target>aaa</target>
            </child-a>
            <child-b>
                <target>bbb</target>
            </child-b>

            <target>ccc</target>
        </root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var nodes = root.getElementsByTagName("target");
for (int i = 0; i < nodes.getLength(); i++) {
    final var node = nodes.item(i);

    //i = 0 : aaa
    //i = 1 : bbb
    //i = 2 : ccc
    System.out.println("i = " + i + " : " + node.getTextContent());
}

// XML表記 : <element/>
final var element = document.createElement("element");

// XML表記 : <element aaa="bbb"/>
element.setAttribute("aaa", "bbb");

// XML表記 : <element aaa="bbb" xxx="yyy"/>
element.setAttribute("xxx", "yyy");

// 上書き
// XML表記 : <element aaa="bbb" xxx="zzz"/>
element.setAttribute("xxx", "zzz");

// XML表記 : <element/>
final var element = document.createElement("element");

// XML表記 : <element aaa="bbb"/>
element.setAttribute("aaa", "bbb");

final var attrValue = element.getAttribute("aaa");
System.out.println(attrValue); // bbb

// XML表記 : <element/>
final var element = document.createElement("element");

// XML表記 : <element aaa="bbb"/>
element.setAttribute("aaa", "bbb");

// XML表記 : <element/>
element.removeAttribute("aaa");

// XML表記 : <element/>
final var element = document.createElement("element");

final var attrA = document.createAttribute("aaa");
attrA.setValue("bbb");

final var attrX1 = document.createAttribute("xxx");
attrX1.setValue("yyy");

final var attrX2 = document.createAttribute("xxx");
attrX2.setValue("zzz");

// XML表記 : <element aaa="bbb"/>
element.setAttributeNode(attrA);
System.out.println(attrA == element.getAttributeNode("aaa")); // true

// XML表記 : <element aaa="bbb" xxx="yyy"/>
element.setAttributeNode(attrX1);
System.out.println(attrX1 == element.getAttributeNode("xxx")); // true

// 上書き
// XML表記 : <element aaa="bbb" xxx="zzz"/>
element.setAttributeNode(attrX2);
System.out.println(attrX2 == element.getAttributeNode("xxx")); // true

// XML表記 : <element aaa="bbb"/>
element.removeAttributeNode(attrX2);

これ以外にも、Node で定義されている appendChild ​や getChildNodes もよく使いますね。

Attr

Attr は要素の属性を表します。
ツリー構造にはならず、Element に直接保持されます。

final var xml = """
        <root aa="AA"/>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var attr = root.getAttributeNode("aa");
System.out.println(attr); // aa="AA"

System.out.println(attr.getName()); // aa
System.out.println(attr.getValue()); // AA

final var xml = """
        <root aa="AA"/>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var attr = root.getAttributeNode("aa");
System.out.println(attr); // aa="AA"

System.out.println(attr.getName()); // aa
System.out.println(attr.getValue()); // AA

final var xml = """
        <root aa="AA"/>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var attr = root.getAttributeNode("aa");
System.out.println(attr); // aa="AA"

// XML表記 : <root aa="BB"/>
attr.setValue("BB");

System.out.println(attr.getValue()); // BB

Text

Textノードは、XMLのテキストを表します。

final var xml = """
        <root>aaa</root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var child = root.getFirstChild();
if (child instanceof Text text) {
    System.out.println(text); // [#text: aaa]
    System.out.println(text.getData()); // "aaa"
}

final var xml = """
        <root>aaa</root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var child = root.getFirstChild();
if (child instanceof Text text) {
    System.out.println(text); // [#text: aaa]

    text.setData("bbb");

    System.out.println(text.getData()); // "bbb"
}

// rootのXML表記 : <root>bbb</root>

Comment

Commentノードは、XMLのコメント要素である <!-- ～ --> を表します。

final var xml = """
        <root><!--aaa--></root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var child = root.getFirstChild();
if (child instanceof Comment comment) {
    System.out.println(comment); // [#comment: aaa]
    System.out.println(comment.getData()); // "aaa"
}

final var xml = """
        <root><!--aaa--></root>
        """;
...

final var document = builder.parse(
        new ByteArrayInputStream(xml.getBytes()));

final var root = document.getDocumentElement();
System.out.println(root); // [root: null]

final var child = root.getFirstChild();
if (child instanceof Comment comment) {
    System.out.println(comment);

    comment.setData("bbb");

    System.out.println(comment.getData()); // "bbb"
}

// rootのXML表記 : <root><!--bbb--></root>

まとめ

XML は一時期に比べて使用率が減ってきた印象はあります。
代わりに、よりシンプルな JSON が人気でしょうか。

しかし、今回は紹介できませんでしたが、XML はスキーマ言語によって厳格にフォーマットを定義できます。
他にも XSLT で結果を変換できたりと機能が豊富です。まだまだ XML がすたれることはないでしょう。

本記事では扱いきれなかったものとして、

• SAX
• StAX
• DTD
• XML Schema
• XSLT
• XPath

などがあります。
興味のあるかたは、それらのキーワードで調べてみてみるのもおすすめです。

いずれ記事にもまとめられたらな、と思っています。

DOM のさらなる詳細が知りたいかたは、関連記事の各種 API使用例も参考にしていただけたら幸いです。

関連記事

• API 使用例
  • DocumentBuilder
  • DocumentBuilderFactory
  • DOMImplementation
  • DOMImplementationLS
  • LSSerializer
  • Node
    • Attr
    • CharacterData
    • Comment
    • Document
    • Element
    • Entity
    • EntityReference
    • Text
  • Transformer
  • TransformerFactory