CodeGym /コース /C# SELF /高度なXML操作: XmlDocument と XPath

高度なXML操作: XmlDocument と XPath

C# SELF
レベル 48, レッスン 2
使用可能

1. はじめに

巨大な XML を想像してみて。SOAP サービスや銀行の API から届くやつね。入れ子になった要素が何百もあって構造もバラバラ。あなたは先月のある支払いの金額だけを見つけたい。シリアライズでやるのは向いてない — 面倒で、どこを見ればいいか事前に分からない。XML ツリーを拡大して素早く枝を辿る「虫眼鏡」が必要なんだ。

そういう時のために .NET には昔から強力な道具がある。クラス XmlDocument とクエリ言語 XPath だ。今日学ぶこと:

  • XML を DOM ツリーに読み込む;
  • 手動で、あるいは XPath を使って要素を移動・検索する;
  • XML ドキュメントの内容を修正する;
  • ノードの追加、削除、変更;
  • 複雑な選択に XPath を使う。

2. XmlDocument とは何か?

XmlDocument は名前空間 System.Xml のクラスだ。これは DOM (Document Object Model) の実装で、XML ファイル全体をメモリ上のオブジェクトツリーとして表現する。

少し理論と例え話

もし XmlSerializer がオブジェクトを LEGO のブロックに分解してまた組み立てるコンストラクタのようなものだとすれば、XmlDocument は実際の木をいじるようなものだよ。根があって、枝(要素)があって、葉(テキストノード)がある。ツリーを歩いて枝を追加したり葉を切ったり移植したりできる。

XML ドキュメントの簡単な読み込み

例えばこんな XML があるとする:

<users>
  <user id="1">
    <name>オリガ</name>
    <age>28</age>
  </user>
  <user id="2">
    <name>イゴール</name>
    <age>35</age>
  </user>
</users>

これをメモリに読み込む:

using System.Xml;

string xml = @"
<users>
  <user id='1'>
    <name>オリガ</name>
    <age>28</age>
  </user>
  <user id='2'>
    <name>イゴール</name>
    <age>35</age>
  </user>
</users>";

XmlDocument doc = new XmlDocument();
doc.LoadXml(xml); // または doc.Load("ファイルへのパス.xml");

LoadXml(あるいはファイルからなら Load)を呼ぶと、ドキュメントの全内容にアクセスできるようになる。

3. DOM ツリーのナビゲーション

DOM ツリーの構造

読み込み後、XML ドキュメントは様々なタイプのノードからなるツリーになる:

ノードの種類 .NETでのクラス 例
Document XmlDocument
<users>...</users>
Element XmlElement
<user>, <name>
Attribute XmlAttribute
id="1"
Text XmlText オリガ, 28
Comment XmlComment
<!-- コメント -->

目的の要素にアクセスするには、ChildNodes、Attributes、ParentNode などのプロパティを使って「木を歩く」必要がある。

ルート要素を取得する

XmlElement root = doc.DocumentElement;
Console.WriteLine(root.Name); // users

子要素を列挙する

foreach (XmlNode node in root.ChildNodes)
{
    if (node is XmlElement user)
    {
        // user — は <user id="...">...</user> です
        string id = user.GetAttribute("id");
        string name = user["name"].InnerText;
        string age = user["age"].InnerText;
        Console.WriteLine($"ユーザー {id}: {name}, 年齢 {age}");
    }
}

重要: user["name"] によるアクセスは、直接の子要素に <name> が存在する場合にのみ有効だよ。

属性とテキストへのアクセス

var firstUser = root.FirstChild as XmlElement;
string id = firstUser.GetAttribute("id"); // "1"
string name = firstUser["name"].InnerText; // "オリガ"

4. XML ドキュメントの変更

値の変更

オリガが突然「若返り」たいと言い出したとする:

var olga = root.FirstChild as XmlElement;
olga["age"].InnerText = "22"; // これで <age>22</age> になる

新しいユーザーの追加

XmlElement newUser = doc.CreateElement("user");
newUser.SetAttribute("id", "3");

XmlElement name = doc.CreateElement("name");
name.InnerText = "ヴァシリーサ";
XmlElement age = doc.CreateElement("age");
age.InnerText = "19";

newUser.AppendChild(name);
newUser.AppendChild(age);
root.AppendChild(newUser);

要素の削除

2 番目のユーザー("イゴール")を削除する:

XmlNode userToDelete = root.SelectSingleNode("user[@id='2']");
if (userToDelete != null)
    root.RemoveChild(userToDelete);

変更の保存

doc.Save("users_updated.xml");
// または doc.OuterXml — XML の文字列を得る

5. XPath — XML の検索と選択の言語

ツリー操作だけだと「条件で探す」場合に疲れてしまう。例えば年齢が 25 より大きいユーザーを全部探したいときとかね。そんなときに使うのが XPath — XML ツリーをたどるための言語だ。

基本的な XPath の使い方

XPath クエリは SelectSingleNode(最初に見つかったノードを返す)や SelectNodes(ノードのコレクションを返す)で実行できる。

例: id = 1 のユーザーを見つける

XmlNode user = root.SelectSingleNode("user[@id='1']");
Console.WriteLine(user["name"].InnerText); // オリガ

例: 25 歳より上の全ユーザーを見つける

XmlNodeList nodes = root.SelectNodes("user[age>25]");
foreach (XmlNode u in nodes)
{
    Console.WriteLine(u["name"].InnerText); // オリガ と イゴール を表示(もしイゴールがまだ削除されていなければ)
}

XPath — 簡単な構文

XPath 式 何を返すか
/users/user
ルートの <users> の中にあるすべての <user> 要素
user[@id='3']
id=3 のユーザー
user[age>25]
25 歳より上のユーザー
user/name
すべてのユーザーの <name> 要素
user[last()]
最後の <user>
user[position()<3]
最初の 2 つの <user>

さらに詳しい例や構文は: XPath のドキュメント を見てね。

別の例: ネストされた要素による選択

XML がもっと複雑だとする:

<library>
  <book>
    <title>蠅の王</title>
    <author>
      <firstname>ウィリアム</firstname>
      <lastname>ゴールディング</lastname>
    </author>
  </book>
  <book>
    <title>スワン氏の方へ</title>
    <author>
      <firstname>マルセル</firstname>
      <lastname>プルースト</lastname>
    </author>
  </book>
</library>
XmlDocument doc = new XmlDocument();
doc.LoadXml(libraryXml);
XmlNodeList authors = doc.SelectNodes("/library/book/author/lastname");
foreach (XmlNode lastName in authors)
    Console.WriteLine(lastName.InnerText);

出力されるもの:

ゴールディング
プルースト

6. XPath: フィルタ、論理、計算

論理フィルタ

年齢が 18 以上かつ 30 以下のすべてのユーザーの名前を出す:

// [age>=18 and age<=30]
XmlNodeList youngUsers = root.SelectNodes("user[age>=18 and age<=30]");
foreach (XmlNode u in youngUsers)
    Console.WriteLine(u["name"].InnerText);

属性の扱い

属性は @ で選ぶ。id が "1" で始まるユーザーを見つける:

XmlNodeList nodes = root.SelectNodes("user[starts-with(@id, '1')]");

ノード数のカウント

C# の SelectNodes メソッド内で直接 count() を使うことはできない(コレクションを返すので数ではない)。でもこうすればいい:

int count = root.SelectNodes("user").Count;

ネストされたフィルタ

XmlNodeList nodes = doc.SelectNodes("/library/book[author/lastname='ゴールディング']");

7. XPath と名前空間

XML が名前空間(xmlns)を使っていると、状況はちょっと面倒になる!そんなときは XmlNamespaceManager を使おう:

<catalog xmlns="http://books.example.com">
  <book>
    <title>アルゴリズム</title>
  </book>
</catalog>
doc.LoadXml(xml);
XmlNamespaceManager nsmgr = new XmlNamespaceManager(doc.NameTable);
nsmgr.AddNamespace("b", "http://books.example.com");

XmlNodeList books = doc.SelectNodes("/b:catalog/b:book", nsmgr);
foreach (XmlNode book in books)
    Console.WriteLine(book.SelectSingleNode("b:title", nsmgr)?.InnerText);

8. DOM を使った XML の修正

ランタイムでノードを追加する

最初のユーザーに新しい要素 <email> を追加してみる:

XmlElement email = doc.CreateElement("email");
email.InnerText = "olga@gmail.com";
olga.AppendChild(email);

属性の変更

olga.SetAttribute("id", "99"); // これで id="99" になる

XPath を使ったノードの削除

XmlNodeList nodesToRemove = root.SelectNodes("user[age<20]");
foreach (XmlNode node in nodesToRemove)
    root.RemoveChild(node);

9. 便利なコツ

検索と一括構造変更

大きな XML が来て、色んな <record type="..."> 要素が混ざっているとする。属性 type が "customer" のものだけ残して、それぞれに子要素 <status>active</status> を追加したい場合:

XmlNodeList customerNodes = root.SelectNodes("record[@type='customer']");
foreach (XmlElement record in customerNodes)
{
    XmlElement status = doc.CreateElement("status");
    status.InnerText = "active";
    record.AppendChild(status);
}

XML ノードツリー (DOM)


users
├─ user (id="1")
│   ├─ name ("オリガ")
│   └─ age ("28")
├─ user (id="2")
│   ├─ name ("イゴール")
│   └─ age ("35")

XPath による選択例

XPath クエリ 返すもの
/users/user[1]
最初のユーザー (id="1")
/users/user[last()]
最後のユーザー (id="2")
/users/user[age>30]
30 歳以上のすべて(イゴール)
/users/user[@id='2']
id="2" のユーザー

実用的な適用例

  • 古い API との統合。 多くの政府系や銀行では SOAP/XML がまだ現役。巨大な XML レスポンスの中から素早く探して変更できると何十時間もの作業を救える。
  • データ移行。 システム移行時は XML をパースして複雑な選択や変換、一括変更をする必要が多い。
  • Excel へのインポート/エクスポート。 多くの B2B 製品では入力がまだ XML だったりする。そこで XPath は大きなデータモデルを作らずに必要な情報を取り出す速い手段になる。

10. エラー、注意点、典型的な落とし穴

NullReferenceException: 存在しない要素にアクセスすると(例えば el["something"].InnerText)、その子要素が全く無ければ例外になる。必ず null チェックをしよう。

XPath と起点の違い: スラッシュ / なしの式は現在のノードの子孫から探し、先頭に / がある式はドキュメントのルートから探す。起点が違うと結果が空になることがあるので注意。

名前空間の扱い: XmlNamespaceManager を使わないと、xmlns を含む XML に対する XPath クエリは何も返さないよ。

列挙中の修正: SelectNodes の結果をループしてその場でノードを削除するなら、先に配列などに保存してから繰り返すこと。さもないとコレクションが走行中に変わってエラーになる。

テキストノードと要素ノードの違い: 要素の間には空白や改行のテキストノードが入ることがある。厳密に選択したいなら XmlElement のみを扱うか、NodeType でフィルタしよう。

2
タスク
C# SELF, レベル 48, レッスン 2
ロック未解除
XPathを使った要素の検索
XPathを使った要素の検索
コメント
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION