XML

Java – XMLドキュメントから要素を取得する方法まとめ

JavaでXMLドキュメントから要素を取得するには、主に以下の方法があります。

DOMパーサーを使用する場合、DocumentBuilderでXMLをパースし、getElementsByTagNameやgetElementByIdを用いて要素を取得します。

XPathを使用する場合、XPathFactoryとXPathを利用して特定のパスに基づく要素を抽出します。

SAXパーサーではイベント駆動型で要素を処理しますが、直接的な取得よりも逐次処理に適しています。

目次から探す
  1. DOMパーサーを使用した要素の取得方法
  2. XPathを使用した要素の取得方法
  3. SAXパーサーを使用した要素の取得方法
  4. StAXを使用した要素の取得方法
  5. 外部ライブラリを使用したXML操作
  6. まとめ

DOMパーサーを使用した要素の取得方法

Javaでは、DOM(Document Object Model)パーサーを使用してXMLドキュメントを操作することができます。

DOMパーサーは、XML文書をメモリ内にツリー構造として読み込み、要素を簡単に取得・操作できるようにします。

以下に、DOMパーサーを使用してXMLから要素を取得する方法を示します。

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import java.io.File;
public class App {
    public static void main(String[] args) {
        try {
            // XMLファイルを指定
            File xmlFile = new File("sample.xml");
            
            // DocumentBuilderFactoryをインスタンス化
            DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
            
            // DocumentBuilderを作成
            DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
            
            // XMLファイルを読み込み、Documentオブジェクトを生成
            Document doc = dBuilder.parse(xmlFile);
            doc.getDocumentElement().normalize(); // 正規化
            
            // ルート要素を取得
            Element root = doc.getDocumentElement();
            System.out.println("ルート要素: " + root.getNodeName());
            
            // 特定の要素を取得
            NodeList nodeList = doc.getElementsByTagName("要素名"); // 取得したい要素名を指定
            
            // 要素の数を表示
            System.out.println("要素の数: " + nodeList.getLength());
            
            // 各要素の内容を表示
            for (int i = 0; i < nodeList.getLength(); i++) {
                Element element = (Element) nodeList.item(i);
                System.out.println("要素の内容: " + element.getTextContent());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

XMLファイルの例

以下のようなXMLファイル(sample.xml)を用意してください。

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <要素名>内容1</要素名>
    <要素名>内容2</要素名>
    <要素名>内容3</要素名>
</root>
ルート要素: root
要素の数: 3
要素の内容: 内容1
要素の内容: 内容2
要素の内容: 内容3

このコードでは、XMLファイルを読み込み、DOMパーサーを使用して特定の要素を取得しています。

getElementsByTagNameメソッドを使用することで、指定した要素名のすべての要素を取得し、その内容を表示しています。

DOMパーサーは、XMLの構造をツリー形式で扱うため、要素の取得や操作が直感的に行えます。

XPathを使用した要素の取得方法

XPath(XML Path Language)は、XMLドキュメント内の要素や属性を選択するための言語です。

Javaでは、XPathを使用してXMLから特定の要素を簡単に取得することができます。

以下に、XPathを使用してXMLから要素を取得する方法を示します。

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathFactory;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
import java.io.File;
public class App {
    public static void main(String[] args) {
        try {
            // XMLファイルを指定
            File xmlFile = new File("sample.xml");
            
            // DocumentBuilderFactoryをインスタンス化
            DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
            
            // DocumentBuilderを作成
            DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
            
            // XMLファイルを読み込み、Documentオブジェクトを生成
            Document doc = dBuilder.parse(xmlFile);
            doc.getDocumentElement().normalize(); // 正規化
            
            // XPathFactoryをインスタンス化
            XPathFactory xPathFactory = XPathFactory.newInstance();
            XPath xPath = xPathFactory.newXPath();
            
            // XPath式を使用して要素を取得
            String expression = "/root/要素名"; // 取得したい要素のXPath式
            NodeList nodeList = (NodeList) xPath.evaluate(expression, doc, XPathConstants.NODESET);
            
            // 要素の数を表示
            System.out.println("要素の数: " + nodeList.getLength());
            
            // 各要素の内容を表示
            for (int i = 0; i < nodeList.getLength(); i++) {
                System.out.println("要素の内容: " + nodeList.item(i).getTextContent());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

XMLファイルの例

以下のようなXMLファイル(sample.xml)を用意してください。

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <要素名>内容1</要素名>
    <要素名>内容2</要素名>
    <要素名>内容3</要素名>
</root>
要素の数: 3
要素の内容: 内容1
要素の内容: 内容2
要素の内容: 内容3

このコードでは、XPathを使用してXMLファイルから特定の要素を取得しています。

XPath式を指定することで、XMLの構造に基づいて要素を選択できます。

evaluateメソッドを使用して、XPath式に一致する要素を取得し、その内容を表示しています。

XPathを使用することで、複雑なXML構造からも簡単に要素を抽出することが可能です。

SAXパーサーを使用した要素の取得方法

SAX(Simple API for XML)パーサーは、XMLドキュメントを逐次的に読み込むためのイベント駆動型のパーサーです。

SAXパーサーは、メモリ使用量が少なく、大きなXMLファイルを処理するのに適しています。

以下に、SAXパーサーを使用してXMLから要素を取得する方法を示します。

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import java.io.File;
public class App {
    public static void main(String[] args) {
        try {
            // SAXParserFactoryをインスタンス化
            SAXParserFactory factory = SAXParserFactory.newInstance();
            
            // SAXParserを作成
            SAXParser saxParser = factory.newSAXParser();
            
            // XMLファイルを指定
            File xmlFile = new File("sample.xml");
            
            // XMLの内容を処理するためのハンドラを作成
            DefaultHandler handler = new DefaultHandler() {
                boolean isElementName = false; // 要素名のフラグ
                @Override
                public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
                    if (qName.equalsIgnoreCase("要素名")) {
                        isElementName = true; // 要素名の開始
                    }
                }
                @Override
                public void endElement(String uri, String localName, String qName) throws SAXException {
                    if (qName.equalsIgnoreCase("要素名")) {
                        isElementName = false; // 要素名の終了
                    }
                }
                @Override
                public void characters(char[] ch, int start, int length) throws SAXException {
                    if (isElementName) {
                        // 要素名の内容を表示
                        System.out.println("要素の内容: " + new String(ch, start, length));
                    }
                }
            };
            
            // XMLファイルをパース
            saxParser.parse(xmlFile, handler);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

XMLファイルの例

以下のようなXMLファイル(sample.xml)を用意してください。

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <要素名>内容1</要素名>
    <要素名>内容2</要素名>
    <要素名>内容3</要素名>
</root>
要素の内容: 内容1
要素の内容: 内容2
要素の内容: 内容3

このコードでは、SAXパーサーを使用してXMLファイルから要素を取得しています。

DefaultHandlerクラスを拡張し、要素の開始、終了、及び内容を処理するメソッドをオーバーライドしています。

charactersメソッド内で要素の内容を表示することで、特定の要素の情報を取得しています。

SAXパーサーは、メモリ効率が良く、大きなXMLファイルの処理に適していますが、DOMパーサーのように全体をメモリに読み込むことはないため、要素のランダムアクセスはできません。

StAXを使用した要素の取得方法

StAX(Streaming API for XML)は、XMLをストリームとして処理するためのAPIです。

StAXは、プル型のAPIであり、開発者がXMLの読み取りや書き込みを制御できるため、効率的にXMLを処理することができます。

以下に、StAXを使用してXMLから要素を取得する方法を示します。

import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLEventWriter;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.events.XMLEvent;
import javax.xml.stream.events.StartElement;
import javax.xml.stream.events.Characters;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.File;
public class App {
    public static void main(String[] args) {
        try {
            // XMLファイルを指定
            File xmlFile = new File("sample.xml");
            
            // XMLInputFactoryをインスタンス化
            XMLInputFactory inputFactory = XMLInputFactory.newInstance();
            
            // XMLEventReaderを作成
            XMLEventReader eventReader = inputFactory.createXMLEventReader(new FileInputStream(xmlFile));
            
            // イベントを読み取る
            while (eventReader.hasNext()) {
                XMLEvent event = eventReader.nextEvent();
                
                // 開始要素を検出
                if (event.isStartElement()) {
                    StartElement startElement = event.asStartElement();
                    String elementName = startElement.getName().getLocalPart();
                    
                    // 要素名が一致する場合
                    if (elementName.equals("要素名")) {
                        event = eventReader.nextEvent(); // 次のイベントを取得
                        if (event.isCharacters()) {
                            Characters characters = event.asCharacters();
                            // 要素の内容を表示
                            System.out.println("要素の内容: " + characters.getData());
                        }
                    }
                }
            }
            eventReader.close(); // イベントリーダーを閉じる
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

XMLファイルの例

以下のようなXMLファイル(sample.xml)を用意してください。

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <要素名>内容1</要素名>
    <要素名>内容2</要素名>
    <要素名>内容3</要素名>
</root>
要素の内容: 内容1
要素の内容: 内容2
要素の内容: 内容3

このコードでは、StAXを使用してXMLファイルから要素を取得しています。

XMLEventReaderを使用してXMLのイベントを逐次的に読み取り、開始要素を検出した際にその内容を表示しています。

StAXは、プル型のAPIであるため、必要なときに必要なデータを取得できる柔軟性があります。

これにより、メモリ使用量を抑えつつ、大きなXMLファイルを効率的に処理することが可能です。

外部ライブラリを使用したXML操作

Javaでは、標準のAPIを使用してXMLを操作することができますが、外部ライブラリを使用することで、より簡単かつ効率的にXMLを扱うことができます。

ここでは、人気のある外部ライブラリであるJDOMとDOM4Jを使用したXML操作の方法を紹介します。

JDOMを使用したXML操作

JDOMは、JavaでXMLを扱うためのシンプルで直感的なAPIを提供します。

以下に、JDOMを使用してXMLから要素を取得する方法を示します。

import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.input.SAXBuilder;
import java.io.File;
import java.util.List;
public class App {
    public static void main(String[] args) {
        try {
            // XMLファイルを指定
            File xmlFile = new File("sample.xml");
            
            // SAXBuilderをインスタンス化
            SAXBuilder saxBuilder = new SAXBuilder();
            
            // XMLファイルを読み込み、Documentオブジェクトを生成
            Document document = saxBuilder.build(xmlFile);
            
            // ルート要素を取得
            Element rootElement = document.getRootElement();
            
            // 特定の要素を取得
            List<Element> elements = rootElement.getChildren("要素名");
            
            // 各要素の内容を表示
            for (Element element : elements) {
                System.out.println("要素の内容: " + element.getText());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

DOM4Jを使用したXML操作

DOM4Jは、XMLを操作するための強力で柔軟なライブラリです。

以下に、DOM4Jを使用してXMLから要素を取得する方法を示します。

import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import java.io.File;
import java.util.List;
public class App {
    public static void main(String[] args) {
        try {
            // XMLファイルを指定
            File xmlFile = new File("sample.xml");
            
            // SAXReaderをインスタンス化
            SAXReader reader = new SAXReader();
            
            // XMLファイルを読み込み、Documentオブジェクトを生成
            Document document = reader.read(xmlFile);
            
            // ルート要素を取得
            Element rootElement = document.getRootElement();
            
            // 特定の要素を取得
            List<Element> elements = rootElement.elements("要素名");
            
            // 各要素の内容を表示
            for (Element element : elements) {
                System.out.println("要素の内容: " + element.getText());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

XMLファイルの例

以下のようなXMLファイル(sample.xml)を用意してください。

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <要素名>内容1</要素名>
    <要素名>内容2</要素名>
    <要素名>内容3</要素名>
</root>
要素の内容: 内容1
要素の内容: 内容2
要素の内容: 内容3

外部ライブラリのインストール方法

  • JDOM:
  • Mavenを使用する場合、以下の依存関係をpom.xmlに追加します。 
    <dependency>
        <groupId>org.jdom</groupId>
        <artifactId>jdom2</artifactId>
        <version>2.0.6</version>
    </dependency>
  • DOM4J:
  • Mavenを使用する場合、以下の依存関係をpom.xmlに追加します。 
    <dependency>
        <groupId>org.dom4j</groupId>
        <artifactId>dom4j</artifactId>
        <version>2.1.3</version>
    </dependency>

JDOMやDOM4Jを使用することで、XMLの操作がより簡単になります。

これらのライブラリは、XMLの読み込み、要素の取得、内容の表示などを直感的に行うことができ、開発者にとって非常に便利です。

特に、XMLの構造が複雑な場合や、大量のデータを扱う場合に効果的です。

まとめ

この記事では、JavaにおけるXMLドキュメントから要素を取得するためのさまざまな方法について解説しました。

DOMパーサー、XPath、SAXパーサー、StAX、そして外部ライブラリであるJDOMやDOM4Jを使用することで、XMLデータの操作が効率的に行えることがわかりました。

これらの手法を活用して、XMLを扱うアプリケーションの開発に挑戦してみてください。

関連記事

[Java] XMLとJSONを相互に変換する方法を解説

Java – XMLとJSONを相互に変換する方法を解説

[Java] XML文書を解析できるパーサーまとめ – DOM/SAX/StAX

Java – XML文書を解析できるパーサーまとめ – DOM/SAX/StAX

[Java] XMLをファイルに出力する方法

Java – XMLをファイルに出力する方法

[Java] XMLから特定の要素を削除する方法

Java – XMLから特定の要素を削除する方法

[Java] XMLで要素が存在するか検索する方法

Java – XMLで要素が存在するか検索する方法

[Java] XMLとCSVを相互に変換する方法

Java – XMLとCSVを相互に変換する方法

[Java] XMLをJavaオブジェクトに変換する方法

Java – XMLをJavaオブジェクトに変換する方法

[Java] XMLオブジェクトをただの文字列に変換する方法

Java – XMLオブジェクトをただの文字列に変換する方法

[Java] XMLに要素を追加する方法まとめ

Java – XMLに要素を追加する方法まとめ

[Java] XMLをJavaオブジェクトに変換、JavaオブジェクトをXML文字列に変換する方法

Java – XMLをJavaオブジェクトに変換、JavaオブジェクトをXML文字列に変換する方法

Back to top button