XML

Java – XML要素をXPath指定で取得・参照する方法

JavaでXML要素をXPath指定で取得・参照するには、javax.xml.xpathパッケージを使用します。

まず、DocumentBuilderでXMLをパースしてDocumentオブジェクトを作成します。

その後、XPathFactoryからXPathオブジェクトを生成し、evaluateメソッドを使用してXPath式を評価します。

結果は文字列やノードリストとして取得可能です。

目次から探す

JavaでXPathを使用する準備

JavaでXPathを使用するためには、まずXMLを扱うためのライブラリをインポートする必要があります。

Javaには標準でXMLを扱うためのAPIが用意されており、XPathもその一部として利用できます。

以下の手順で準備を進めます。

必要なライブラリのインポート

XPathを使用するためには、以下のクラスをインポートします。

これらはJavaの標準ライブラリに含まれています。

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpression;
import javax.xml.xpath.XPathFactory;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
import java.io.File;

XMLファイルの準備

XPathを使用するためには、解析するXMLファイルが必要です。

以下のようなサンプルXMLファイルを用意します。

ファイル名はsample.xmlとします。

<books>
    <book>
        <title>Java入門</title>
        <author>山田太郎</author>
        <year>2020</year>
    </book>
    <book>
        <title>Python入門</title>
        <author>佐藤花子</author>
        <year>2021</year>
    </book>
</books>

プロジェクトのセットアップ

Javaの開発環境(JDK)をインストールします。
上記のXMLファイルをプロジェクトのルートディレクトリに配置します。
App.javaという名前のJavaファイルを作成し、必要なインポート文を追加します。

これで、XPathを使用するための準備が整いました。

次のステップでは、実際にXPathを使ってXML要素を取得する方法を解説します。

JavaでXMLをパースする方法

JavaでXMLをパースするためには、DocumentBuilderを使用してXMLファイルを読み込み、Documentオブジェクトを生成します。

このDocumentオブジェクトを使って、XMLの内容にアクセスすることができます。

以下に具体的な手順を示します。

XMLファイルの読み込み

まず、XMLファイルを読み込むためのコードを作成します。

以下のサンプルコードでは、sample.xmlというファイルを読み込み、Documentオブジェクトを生成します。

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.w3c.dom.Document;
import java.io.File;
public class App {
    public static void main(String[] args) {
        try {
            // DocumentBuilderFactoryのインスタンスを生成
            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
            
            // DocumentBuilderを生成
            DocumentBuilder builder = factory.newDocumentBuilder();
            
            // XMLファイルを読み込み、Documentオブジェクトを生成
            File xmlFile = new File("sample.xml");
            Document document = builder.parse(xmlFile);
            
            // XMLの内容を正しく読み込めたか確認
            document.getDocumentElement().normalize();
            System.out.println("XMLファイルが正常に読み込まれました。");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

DocumentBuilderFactoryを使用して、DocumentBuilderのインスタンスを生成します。
DocumentBuilderを使って、指定したXMLファイルをパースし、Documentオブジェクトを作成します。
normalize()メソッドを呼び出すことで、XMLの構造を正規化します。

これにより、ノードの整合性が保たれます。

例外処理を行い、エラーが発生した場合にはスタックトレースを表示します。

上記のコードを実行すると、以下のような出力が得られます。

XMLファイルが正常に読み込まれました。

このようにして、JavaでXMLをパースする準備が整いました。

次のステップでは、XPathを使用してXML要素を取得する方法を解説します。

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

XPathを使用すると、XMLドキュメント内の特定の要素や属性を簡単に取得することができます。

Javaでは、XPathクラスを使用してXPath式を評価し、XML要素を取得します。

以下に具体的な手順とサンプルコードを示します。

XPathを使った要素の取得

以下のサンプルコードでは、先ほど読み込んだDocumentオブジェクトから、特定の要素(この場合は書籍のタイトル)をXPathを使って取得します。

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpression;
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 {
            // DocumentBuilderFactoryのインスタンスを生成
            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
            DocumentBuilder builder = factory.newDocumentBuilder();
            File xmlFile = new File("sample.xml");
            Document document = builder.parse(xmlFile);
            document.getDocumentElement().normalize();
            // XPathFactoryのインスタンスを生成
            XPathFactory xPathFactory = XPathFactory.newInstance();
            XPath xpath = xPathFactory.newXPath();
            // XPath式を定義
            String expression = "/books/book/title";
            XPathExpression xPathExpression = xpath.compile(expression);
            // XPath式を評価し、結果を取得
            NodeList nodeList = (NodeList) xPathExpression.evaluate(document, XPathConstants.NODESET);
            // 取得したタイトルを表示
            for (int i = 0; i < nodeList.getLength(); i++) {
                System.out.println("書籍タイトル: " + nodeList.item(i).getTextContent());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

XPathFactoryを使用して、XPathのインスタンスを生成します。
XPath式を定義します。

この例では、/books/book/titleという式を使用して、すべての書籍のタイトルを取得します。

evaluateメソッドを使用して、XPath式を評価し、結果をNodeListとして取得します。
取得したタイトルをループで表示します。

上記のコードを実行すると、以下のような出力が得られます。

書籍タイトル: Java入門
書籍タイトル: Python入門

このようにして、XPathを使用してXML要素を簡単に取得することができます。

次のステップでは、XPathで取得できるデータの種類について解説します。

XPathで取得できるデータの種類

XPathを使用すると、XMLドキュメントからさまざまな種類のデータを取得することができます。

以下に、XPathで取得できる主なデータの種類を示します。

ノードセット

ノードセットは、XPath式によって選択されたノードの集合です。

例えば、特定の要素や属性を持つノードを取得することができます。

例: /books/book はすべてのbook要素を含むノードセットを返します。

文字列

XPathを使用して、特定のノードのテキスト内容を取得することができます。

これは、ノードのtext()関数を使用して実現します。

例: /books/book/title/text() は、すべての書籍タイトルの文字列を取得します。

数値

XPathでは、数値を取得することも可能です。

数値は、ノードの属性やテキスト内容から取得できます。

例: /books/book/year は、すべての書籍の出版年を数値として取得します。

ブール値

XPath式は、条件に基づいてブール値(真または偽)を返すこともできます。

これにより、特定の条件を満たすノードの存在を確認できます。

例: count(/books/book[year > 2020]) > 0 は、2020年以降に出版された書籍が存在するかどうかを確認します。

属性値

XPathを使用して、特定の要素の属性値を取得することもできます。

属性は、要素の特性を示すために使用されます。

例: /books/book/@author は、すべての書籍の著者属性を取得します。

XPathを使用することで、XMLドキュメントから多様なデータを効率的に取得することができます。

次のステップでは、実際の実践例を通じて、XPathを使ったXML要素の参照方法を解説します。

実践例：XPathを使ったXML要素の参照

ここでは、XPathを使用してXML要素を参照する具体的な実践例を示します。

前回の例で使用したsample.xmlファイルを基に、書籍のタイトル、著者、出版年を取得するプログラムを作成します。

以下のコードでは、XPathを使用して書籍のタイトル、著者、出版年を取得し、コンソールに表示します。

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpression;
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 {
            // DocumentBuilderFactoryのインスタンスを生成
            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
            DocumentBuilder builder = factory.newDocumentBuilder();
            File xmlFile = new File("sample.xml");
            Document document = builder.parse(xmlFile);
            document.getDocumentElement().normalize();
            // XPathFactoryのインスタンスを生成
            XPathFactory xPathFactory = XPathFactory.newInstance();
            XPath xpath = xPathFactory.newXPath();
            // 書籍のタイトルを取得
            String titleExpression = "/books/book/title";
            XPathExpression titleXPathExpression = xpath.compile(titleExpression);
            NodeList titleNodeList = (NodeList) titleXPathExpression.evaluate(document, XPathConstants.NODESET);
            // 書籍の著者を取得
            String authorExpression = "/books/book/author";
            XPathExpression authorXPathExpression = xpath.compile(authorExpression);
            NodeList authorNodeList = (NodeList) authorXPathExpression.evaluate(document, XPathConstants.NODESET);
            // 書籍の出版年を取得
            String yearExpression = "/books/book/year";
            XPathExpression yearXPathExpression = xpath.compile(yearExpression);
            NodeList yearNodeList = (NodeList) yearXPathExpression.evaluate(document, XPathConstants.NODESET);
            // 取得した情報を表示
            for (int i = 0; i < titleNodeList.getLength(); i++) {
                System.out.println("書籍タイトル: " + titleNodeList.item(i).getTextContent());
                System.out.println("著者: " + authorNodeList.item(i).getTextContent());
                System.out.println("出版年: " + yearNodeList.item(i).getTextContent());
                System.out.println("-------------------------");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

DocumentBuilderを使用してXMLファイルを読み込み、Documentオブジェクトを生成します。
XPathを使用して、書籍のタイトル、著者、出版年をそれぞれ取得するためのXPath式を定義します。
各XPath式を評価し、結果をNodeListとして取得します。
ループを使用して、取得した書籍の情報をコンソールに表示します。

上記のコードを実行すると、以下のような出力が得られます。

書籍タイトル: Java入門
著者: 山田太郎
出版年: 2020
-------------------------
書籍タイトル: Python入門
著者: 佐藤花子
出版年: 2021
-------------------------

このようにして、XPathを使用してXML要素を参照し、必要な情報を取得することができます。

次のステップでは、エラーハンドリングと注意点について解説します。

エラーハンドリングと注意点

XPathを使用してXMLを操作する際には、いくつかのエラーハンドリングや注意点があります。

これらを理解しておくことで、より堅牢なプログラムを作成することができます。

以下に、主なポイントを示します。

例外処理

XMLのパースやXPathの評価中に発生する可能性のある例外を適切に処理することが重要です。

以下の例外に注意が必要です。

ParserConfigurationException: XMLパーサーの設定に問題がある場合に発生します。
SAXException: XMLの構文に問題がある場合に発生します。
IOException: ファイルの読み込み中にエラーが発生した場合に発生します。
XPathExpressionException: XPath式の評価中にエラーが発生した場合に発生します。

これらの例外を適切にキャッチし、エラーメッセージを表示することで、問題の特定が容易になります。

XMLファイルの存在確認

XMLファイルを読み込む前に、ファイルが存在するかどうかを確認することが重要です。

ファイルが存在しない場合、FileNotFoundExceptionが発生します。

以下のように確認できます。

File xmlFile = new File("sample.xml");
if (!xmlFile.exists()) {
    System.out.println("XMLファイルが見つかりません。");
    return; // プログラムを終了
}

XPath式の正確性

XPath式が正しくない場合、XPathExpressionExceptionが発生します。

XPath式を定義する際には、XMLの構造を正確に理解し、適切な式を使用することが重要です。

XPath式をテストするために、XMLエディタやオンラインツールを使用することをお勧めします。

ノードの存在確認

XPathを使用して取得したノードが存在するかどうかを確認することも重要です。

ノードが存在しない場合、NodeListの長さが0になります。

以下のように確認できます。

if (nodeList.getLength() == 0) {
    System.out.println("指定したノードは存在しません。");
}

XMLの構造変更への対応

XMLの構造が変更された場合、XPath式が正しく機能しなくなる可能性があります。

XMLの仕様が変更される場合は、XPath式を見直し、必要に応じて修正することが重要です。

エラーハンドリングと注意点を理解し、適切に対処することで、XPathを使用したXML操作がより安全で効果的になります。

次のステップでは、XPathを活用した応用例について解説します。

XPathを活用した応用例

XPathは、XMLデータを効率的に操作するための強力なツールです。

ここでは、XPathを活用したいくつかの応用例を紹介します。

これにより、実際のプロジェクトでの利用方法を理解しやすくなります。

特定の条件に基づくデータの抽出

XPathを使用して、特定の条件を満たすノードを抽出することができます。

たとえば、2021年以降に出版された書籍のタイトルを取得する例を示します。

String expression = "/books/book[year > 2020]/title";
XPathExpression xPathExpression = xpath.compile(expression);
NodeList nodeList = (NodeList) xPathExpression.evaluate(document, XPathConstants.NODESET);
for (int i = 0; i < nodeList.getLength(); i++) {
    System.out.println("2021年以降の書籍タイトル: " + nodeList.item(i).getTextContent());
}

複数の条件を組み合わせたデータの取得

XPathでは、複数の条件を組み合わせてデータを取得することも可能です。

たとえば、著者が「山田太郎」で、2020年以降に出版された書籍のタイトルを取得する例を示します。

String expression = "/books/book
		
		
			
				
			
			
				About the author
			
		
	/title";
XPathExpression xPathExpression = xpath.compile(expression);
NodeList nodeList = (NodeList) xPathExpression.evaluate(document, XPathConstants.NODESET);
for (int i = 0; i < nodeList.getLength(); i++) {
    System.out.println("山田太郎の書籍タイトル: " + nodeList.item(i).getTextContent());
}

属性を使用したデータの取得

XMLの属性を使用してデータを取得することもできます。

たとえば、書籍の著者属性を取得する例を示します。

String expression = "/books/book/@author";
XPathExpression xPathExpression = xpath.compile(expression);
NodeList nodeList = (NodeList) xPathExpression.evaluate(document, XPathConstants.NODESET);
for (int i = 0; i < nodeList.getLength(); i++) {
    System.out.println("著者: " + nodeList.item(i).getNodeValue());
}

データの集計

XPathを使用して、特定の条件を満たすノードの数をカウントすることもできます。

たとえば、2020年以降に出版された書籍の数をカウントする例を示します。

String expression = "count(/books/book[year > 2020])";
XPathExpression xPathExpression = xpath.compile(expression);
Double count = (Double) xPathExpression.evaluate(document, XPathConstants.NUMBER);
System.out.println("2020年以降に出版された書籍の数: " + count.intValue());

XMLデータの更新

XPathを使用して取得したノードを基に、XMLデータを更新することも可能です。

たとえば、特定の書籍の出版年を更新する場合、以下のようにします。

String expression = "/books/book[title='Java入門']/year";
XPathExpression xPathExpression = xpath.compile(expression);
NodeList nodeList = (NodeList) xPathExpression.evaluate(document, XPathConstants.NODESET);
if (nodeList.getLength() > 0) {
    nodeList.item(0).setTextContent("2022"); // 出版年を2022年に更新
    System.out.println("出版年を更新しました。");
}

XPathを活用することで、XMLデータの操作がより柔軟かつ効率的になります。

特定の条件に基づくデータの抽出や集計、更新など、さまざまな応用が可能です。

これらの技術を活用して、実際のプロジェクトでのXMLデータ処理を行ってみてください。