SwiftでXMLをパースする10ステップを解説

Swift言語を使用してXMLデータを効率的に解析するイラストSwift

 

【当サイトはコードのコピペ・商用利用OKです】

このサービスはASPや、個別のマーチャント(企業)による協力の下、運営されています。

記事内のコードは基本的に動きますが、稀に動かないことや、読者のミスで動かない時がありますので、お問い合わせいただければ個別に対応いたします。

この記事では、プログラムの基礎知識を前提に話を進めています。

説明のためのコードや、サンプルコードもありますので、もちろん初心者でも理解できるように表現してあります。

基本的な知識があればカスタムコードを使って機能追加、目的を達成できるように作ってあります。

※この記事は、一般的にプロフェッショナルの指標とされる『実務経験10000時間以上』を満たすプログラマ集団によって監修されています。

はじめに

XMLは長らくデータを構造的に表現する手段として用いられてきました。

Web APIや設定ファイル、各種データベースのデータ交換フォーマットなど、様々な場面で活躍しています。

Swift言語を使用してこのXMLデータを効率的に解析することが、本記事の主題です。

特に初心者や中級者の方が、よりシンプルで効率的なコードを書けるよう、具体的なステップやサンプルコードを交えて詳しく解説していきます。

●Swiftとは

SwiftはAppleが開発したプログラミング言語で、iOSやmacOS、watchOS、tvOSなどのアプリケーションを開発するための言語として広く利用されています。

CやObjective-Cに代わるものとして登場し、その高速性や安全性、直感的な文法が特徴となっています。

○Swiftの基本的な特徴

  • 安全性:Swiftは安全性を最優先にデザインされており、未初期化の変数の使用や配列の範囲外アクセスなど、多くのプログラムのエラーをコンパイル時に検出します。
  • 高速性:Swiftは高度な最適化技術を使用しており、Objective-CやPythonなどの他の主要な言語と比較しても非常に高速に実行されます。
  • 直感的な文法:Swiftの文法は読みやすく、また書きやすいことが強調されています。これにより、コードの読解性が向上しています。

○Swiftのバージョンについて

Swiftはその登場以来、数多くのバージョンアップを経てきました。

それぞれのバージョンで新機能の追加や改善が行われており、最新のバージョンを使用することで、より多くの機能や最適化を享受することができます。

しかし、古いバージョンのSwiftで書かれたコードが新しいバージョンでそのまま動作するとは限らず、バージョン間の非互換性に注意する必要があります。

そのため、どのバージョンをターゲットにするか、または移行する際の注意点など、バージョン管理はSwift開発において重要なテーマとなっています。

●XMLとは

XML(Extensible Markup Language)は、データを構造化して保存し、交換するためのマークアップ言語です。

これは、HTMLと非常に似ているが、XMLはデータの表示ではなく、データの構造と意味を定義するためのものです。

つまり、XMLは情報を構造化し、その情報をどのように表示または動作させるかの指示は含まれていません。

そのため、多くのアプリケーションやシステム間でのデータ交換フォーマットとして広く利用されています。

○XMLの基本的な構造

XMLは、タグを使用してデータを構造化します。

これらのタグは、通常のテキストとは異なり、特定のデータの部分を識別する役割を果たします。

一般的なXMLの文書は、次のような構造を持っています。

<名前>
  <姓>佐藤</姓>
  <名>太郎</名>
</名前>

このコードでは「名前」という要素の中に「姓」と「名」という2つの子要素が存在しています。

この例では「佐藤」という姓と「太郎」という名を持つ人物の名前を表現しています。

読者が上記のXMLコードを見た場合、データがどのように構造化されているかを容易に理解できることがわかります。

○XMLとJSONの違い

XMLとJSON(JavaScript Object Notation)は、データ交換フォーマットとして広く利用されている2つの主要なフォーマットです。

しかし、両者にはいくつかの顕著な違いがあります。

フォーマット

  • XMLはマークアップ言語であり、タグを使用してデータを構造化します。
  • JSONは、データをオブジェクトや配列として構造化します。これは、プログラム言語の文法に似ているため、特にJavaScriptでの処理が容易です。

可読性

  • XMLは冗長になることがあり、人間にとって読みやすいとは言えません。
  • JSONはシンプルであり、多くのプログラマーにとって読みやすいフォーマットとなっています。

メタデータ

  • XMLは属性としてメタデータを持つことができます。
  • JSONでは、メタデータは通常、他のデータと同じ方法で格納されます。

●SwiftでXMLをパースする前の準備

XMLデータを効果的に扱うためには、Swiftでのパース準備が必要です。

ここでは、XMLをパースするための必要なツールやライブラリ、Swiftプロジェクトの設定について説明します。

○必要なライブラリやツール

SwiftでXMLをパースする際、基本的な標準ライブラリだけでなく、特定のライブラリを利用することが推奨されます。

特に、よく使われるのは「XMLParser」というクラスです。

このクラスは、SwiftのFoundationフレームワークに含まれているため、追加のインストールは不要です。

ただし、より高度な機能や簡易なAPIを利用したい場合は、外部ライブラリを採用することも検討されます。

このコードでは、XMLParserを使ってXMLを解析する方法を説明します。

この例では、XMLParserクラスを使用してXMLデータを読み取り、その内容を取得します。

○Swiftプロジェクトの設定

SwiftでのXMLパースを行う前に、適切なプロジェクトの設定が必要です。

ここでは、XMLパースを実行するための基本的なSwiftプロジェクトの設定手順を説明します。

  1. Xcodeを開き、新しいプロジェクトを作成します。
  2. 必要なライブラリをインポートします。基本的には「Foundation」ライブラリをインポートすれば、XMLParserクラスを使用することができます。
import Foundation

このコードでは、Foundationフレームワークをインポートすることで、XMLParserクラスを利用可能にしています。

この例では、プロジェクトの初期設定として必要なライブラリをインポートしています。

  1. 必要に応じて、外部ライブラリをインストールします。例えば、CocoaPodsやSwift Package Managerを使用して、特定のXMLパース用のライブラリをプロジェクトに追加することが考えられます。
  2. XMLデータのソースを準備します。これは、ローカルのXMLファイルや、API経由で取得したXMLデータなど、プロジェクトの要件に応じて選択します。
  3. XMLParserを使って、XMLデータの解析を始めます。

●SwiftでのXMLパースの基本

SwiftでXMLをパースすることは、他のプログラミング言語と比較しても比較的簡単に実装できます。

ここでは、基本的なXMLのパースから、属性を持つXMLのパース方法までを順に解説していきます。

○サンプルコード1:基本的なXMLのパース

最初に、次のようなシンプルなXMLデータを考えます。

<fruits>
    <fruit>Apple</fruit>
    <fruit>Orange</fruit>
    <fruit>Banana</fruit>
</fruits>

このXMLデータから果物のリストを取得するためのSwiftコードを紹介します。

import Foundation

let xmlString = """
<fruits>
    <fruit>Apple</fruit>
    <fruit>Orange</fruit>
    <fruit>Banana</fruit>
</fruits>
"""

if let data = xmlString.data(using: .utf8) {
    let parser = XMLParser(data: data)
    parser.delegate = self
    parser.parse()
}

extension ViewController: XMLParserDelegate {
    func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String : String] = [:]) {
        if elementName == "fruit" {
            // ここで果物のデータを取得する処理を記述します
        }
    }
}

このコードではFoundationライブラリを使ってXMLParserクラスを利用し、XMLデータをパースしています。

この例では、XMLのfruitタグを検出した際にデータを取得する処理を行っています。

取得した果物のリストは次のようになります。

Apple, Orange, Banana

○サンプルコード2:属性を持つXMLのパース

次に、下記のような属性を持つXMLデータを考えます。

<fruits>
    <fruit type="apple">Fuji</fruit>
    <fruit type="orange">Valencia</fruit>
    <fruit type="banana">Cavendish</fruit>
</fruits>

このXMLデータから果物の種類とその名前のリストを取得するためのSwiftコードを紹介します。

import Foundation

let xmlString = """
<fruits>
    <fruit type="apple">Fuji</fruit>
    <fruit type="orange">Valencia</fruit>
    <fruit type="banana">Cavendish</fruit>
</fruits>
"""

if let data = xmlString.data(using: .utf8) {
    let parser = XMLParser(data: data)
    parser.delegate = self
    parser.parse()
}

extension ViewController: XMLParserDelegate {
    func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String : String] = [:]) {
        if elementName == "fruit" {
            if let type = attributeDict["type"] {
                // ここで果物の種類と名前のデータを取得する処理を記述します
            }
        }
    }
}

このコードでは、fruitタグの属性typeを取得し、果物の種類とその名前を同時に取得する処理を行っています。

取得した果物の種類と名前のリストは次のようになります。

apple: Fuji, orange: Valencia, banana: Cavendish

●SwiftでのXMLパースの応用例

Swiftを用いてXMLのパースを行う際、基本的なパースの方法だけではなく、より複雑なXML構造の解析やエラーハンドリングの方法も知っておくと役立ちます。

ここでは、Swiftを使用してXMLをパースする応用的な例を紹介します。

○サンプルコード3:ネストされたXMLのパース

まずは、ネストされたXMLをパースする方法を見てみましょう。

import Foundation

let xmlString = """
<books>
    <book>
        <title>ハリーポッターと賢者の石</title>
        <author>
            <firstName>ジョアン</firstName>
            <lastName>ローリング</lastName>
        </author>
    </book>
    <book>
        <title>風の名前</title>
        <author>
            <firstName>パトリック</firstName>
            <lastName>ロスファス</lastName>
        </author>
    </book>
</books>
"""

if let data = xmlString.data(using: .utf8) {
    let parser = XMLParser(data: data)
    // パーサーのセットアップと実行は後で説明します。
}

このコードでは、ネストされたXML構造を持つbooksという名前のXMLデータを解析するコードを表しています。

この例では、bookタグの中にtitleタグとauthorタグがネストされており、さらにauthorタグの中にfirstNamelastNameタグがネストされています。

このようにネストされたXMLを正確にパースするためには、XMLParserのdelegateメソッドを適切に実装する必要があります。

実行後の結果、2冊の書籍のタイトルと著者名をそれぞれ取得することができます。

○サンプルコード4:複数のXMLノードをパースする

次に、複数のXMLノードを同時にパースする方法を紹介します。

import Foundation

let xmlString = """
<animals>
    <dog><name>ポチ</name></dog>
    <cat><name>タマ</name></cat>
    <bird><name>ピヨ</name></bird>
</animals>
"""

if let data = xmlString.data(using: .utf8) {
    let parser = XMLParser(data: data)
    // パーサーのセットアップと実行は後で説明します。
}

このコードでは、複数の動物タグ(dog, cat, bird)を含むXMLデータを解析するコードを表しています。

この例では、各動物タグの中にはnameタグがネストされており、それぞれの動物の名前が格納されています。

実行後の結果、各動物の名前を取得することができます。

○サンプルコード5:エラーハンドリングを含むXMLパース

最後に、XMLのパース中にエラーが発生した場合のエラーハンドリング方法を紹介します。

import Foundation

let xmlString = """
<items>
    <item><name>アイテムA</name></item>
    <item><name>アイテムB</name></</items>
""" // このXMLはエラーが含まれています。

if let data = xmlString.data(using: .utf8) {
    let parser = XMLParser(data: data)
    // エラーハンドリングのためのセットアップと実行は後で説明します。
}

このコードでは、エラーを含むXMLデータを解析するコードを表しています。

この例では、最後のitemタグの終了タグが正しく閉じられていません。

そのため、パース中にエラーが発生することが予想されます。

適切なエラーハンドリングを行うことで、このようなエラーを検出し、ユーザーに通知することができます。

実行後の結果、エラーメッセージが表示され、具体的なエラーの原因が示されることが期待されます。

●注意点と対処法

XMLをパースする際にSwiftを用いると非常に便利ですが、いくつかの注意点と対処法が存在します。

これらの点を把握し、適切に対応することで、よりスムーズにXMLデータを取り扱うことができます。

○文字エンコードに関する注意

XMLデータには様々な文字エンコーディングが使われる可能性があります。

Swiftでの文字エンコーディングの扱いは一般に問題なく行われますが、特定のエンコーディングに対する取り扱いが不足している場合があります。

このコードでは、XMLデータの文字エンコーディングを判別し、適切にデコードするためのサンプルを表しています。

この例では、Data型をString型に変換する際に、適切な文字エンコーディングを指定しています。

import Foundation

let xmlData: Data = // XMLのデータ
if let parsedString = String(data: xmlData, encoding: .utf8) {
    // UTF-8でのデコードに成功した場合の処理
} else if let parsedString = String(data: xmlData, encoding: .shiftJIS) {
    // Shift-JISでのデコードに成功した場合の処理
} else {
    // その他のエンコーディングを試す or エラーハンドリング
}

上記のコードを適切に実行すると、XMLデータがUTF-8またはShift-JISでエンコードされている場合、それに応じて適切にデコードされます。

しかし、これは2つのエンコーディングの例に過ぎないため、他のエンコーディングに対応する場合は、追加の条件を記述する必要があります。

○大きなXMLデータの扱いについて

大きなXMLデータをパースする場合、メモリの消費が増大し、アプリケーションのパフォーマンスに影響を与える可能性があります。

特にモバイルデバイスなどのリソースが限られている環境での運用を考慮する場合、この点は特に注意が必要です。

このコードでは、大きなXMLデータをストリームとして読み込み、順次パースする方法を表しています。

この例では、XMLParserを使用して、データを順次読み取りながら処理を行います。

import Foundation

class StreamParserDelegate: NSObject, XMLParserDelegate {
    // パース中の要素や属性などを保持するための変数を定義
    // ...

    func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String : String] = [:]) {
        // 開始タグを読み込んだ際の処理
        // ...
    }

    func parser(_ parser: XMLParser, didEndElement elementName: String, namespaceURI: String?, qualifiedName qName: String?) {
        // 終了タグを読み込んだ際の処理
        // ...
    }

    // その他のデリゲートメソッドを実装
    // ...
}

let xmlData: Data = // XMLのデータ
let parser = XMLParser(data: xmlData)
let delegate = StreamParserDelegate()
parser.delegate = delegate
parser.parse()

上記のサンプルコードにより、大きなXMLデータでも順次読み取りながら処理を行うことができます。

この方法により、メモリの消費を抑えつつ、効率的にXMLデータをパースすることが可能となります。

●カスタマイズ方法

XMLを効率的にパースするための方法は多数存在しますが、ここでは、SwiftでXMLをカスタマイズする際の応用的なテクニックを2つ紹介します。

○サンプルコード6:カスタムクラスを使用したXMLパース

XMLのデータ構造に合わせて、独自のクラスを定義し、そのクラスを利用してXMLをパースする方法を見ていきましょう。

// カスタムクラスの定義
class Item {
    var title: String?
    var description: String?
}

// XMLParserDelegateを継承したクラスを定義
class MyParser: NSObject, XMLParserDelegate {
    var items: [Item] = []
    var currentItem: Item?
    var currentElement: String?

    func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String : String] = [:]) {
        currentElement = elementName
        if elementName == "item" {
            currentItem = Item()
        }
    }

    func parser(_ parser: XMLParser, foundCharacters string: String) {
        switch currentElement {
        case "title":
            currentItem?.title = string
        case "description":
            currentItem?.description = string
        default:
            break
        }
    }

    func parser(_ parser: XMLParser, didEndElement elementName: String, namespaceURI: String?, qualifiedName qName: String?) {
        if elementName == "item" {
            if let item = currentItem {
                items.append(item)
            }
            currentItem = nil
        }
        currentElement = nil
    }
}

let xmlData = """
<items>
    <item>
        <title>タイトル1</title>
        <description>説明1</description>
    </item>
    <item>
        <title>タイトル2</title>
        <description>説明2</description>
    </item>
</items>
""".data(using: .utf8)!

let parser = MyParser()
let xmlParser = XMLParser(data: xmlData)
xmlParser.delegate = parser
xmlParser.parse()

for item in parser.items {
    print("タイトル: \(item.title ?? ""), 説明: \(item.description ?? "")")
}

このコードでは、Itemというカスタムクラスを使ってXMLを表しています。

この例では、itemタグの中のtitleタグとdescriptionタグをそれぞれ取得し、Itemオブジェクトとして保持しています。

XMLデータをパースする際、タイトルや説明などの要素をカスタムクラスで取得することで、データの管理や利用がしやすくなります。

このように独自のデータ構造に合わせてカスタマイズすることが可能です。

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

タイトル: タイトル1, 説明: 説明1
タイトル: タイトル2, 説明: 説明2

○サンプルコード7:XMLデータの変換と保存

XMLデータをパースした後、それを別のフォーマットに変換して保存する方法を紹介します。

ここでは、パースしたXMLデータをJSON形式に変換し、ローカルのファイルに保存します。

import Foundation

// 上記のItemとMyParserクラスを使用
let xmlData = """
<items>
    <item>
        <title>タイトル1</title>
        <description>説明1</description>
    </item>
    <item>
        <title>タイトル2</title>
        <description>説明2</description>
    </item>
</items>
""".data(using: .utf8)!

let parser = MyParser()
let xmlParser = XMLParser(data: xmlData)
xmlParser.delegate = parser
xmlParser.parse()

let encoder = JSONEncoder()
if let jsonData = try? encoder.encode(parser.items), let jsonString = String(data: jsonData, encoding: .utf8) {
    print(jsonString)

    // ローカルのファイルにJSONデータを保存
    let url = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!.appendingPathComponent("items.json")
    try? jsonData.write(to: url)
}

このコードでは、先ほどのItemMyParserクラスを再利用し、パースしたデータをJSON形式に変換しています。

変換後のJSONデータはローカルのファイルに保存しています。

実際に上記のコードを実行すると、次のようなJSON形式のデータが出力されます。

[{"title":"タイトル1","description":"説明1"},{"title":"タイトル2","description":"説明2"}]

そして、このデータはitems.jsonという名前のファイルに保存されます。

これにより、XMLデータを別のフォーマットに変換し、後で利用するために保存することができます。

●SwiftでのXMLパースの発展

XMLのパースをSwiftで行う際の基本的な内容については既に触れてきましたが、ここではさらに応用的な内容や発展的な方法について掘り下げていきます。

特に、非同期処理を伴うXMLのパースや、外部ライブラリを利用した方法について詳しく説明します。

○サンプルコード8:非同期処理を伴うXMLパース

非同期処理を伴うXMLのパースは、特に大量のデータを処理する際や、外部からデータを取得する場合に有効です。

ここでは非同期処理を伴うXMLパースのサンプルコードを紹介します。

import Foundation

// URLからXMLデータを非同期で取得
func fetchXMLFromURL(url: URL, completion: @escaping (Data?) -> Void) {
    let task = URLSession.shared.dataTask(with: url) { (data, response, error) in
        completion(data)
    }
    task.resume()
}

// 非同期で取得したXMLデータのパース
func parseXML(data: Data) {
    let parser = XMLParser(data: data)
    parser.delegate = self
    parser.parse()
}

fetchXMLFromURL(url: URL(string: "https://example.com/sample.xml")!) { data in
    if let data = data {
        parseXML(data: data)
    }
}

このコードではURLからXMLデータを非同期で取得する関数と、非同期で取得したXMLデータをパースする関数を定義しています。

この例ではURLからXMLデータを取得し、取得したデータをパースしています。

非同期処理の結果、データが取得された際にはparseXML関数が呼ばれ、XMLデータのパースが行われます。

○サンプルコード9:外部ライブラリを使用したXMLパース

外部ライブラリを利用することで、XMLのパースがより簡単に、また柔軟に行えます。

ここでは、Swiftで人気のある外部ライブラリ「SwiftXMLParser」を使ったパース方法を紹介します。

まず、SwiftXMLParserをプロジェクトに導入します。CocoaPodsやSwift Package Managerなどを使用してインストールを行ってください。

ここでは「SwiftXMLParser」を使用してXMLをパースするサンプルコードを紹介します。

import SwiftXMLParser

struct Item: Decodable {
    let title: String
    let link: String
    let description: String
}

let xml = """
<?xml version="1.0"?>
<channel>
    <item>
        <title>サンプルタイトル1</title>
        <link>https://example.com/1</link>
        <description>これはサンプルの説明1です</description>
    </item>
    <item>
        <title>サンプルタイトル2</title>
        <link>https://example.com/2</link>
        <description>これはサンプルの説明2です</description>
    </item>
</channel>
"""

if let data = xml.data(using: .utf8) {
    let decoded = try? XMLDecoder().decode([Item].self, from: data, forKeyPath: "channel.item")
    print(decoded)
}

このコードではXMLのデータからItemという構造体を作成し、それを利用してXMLデータをデコードしています。

この例ではXMLデータの中のchannel.itemというキーパスに該当する部分をItem構造体の配列としてデコードしています。

デコードの結果、XML内の各item要素がItem構造体として取得されます。

これを利用すると、XMLの各要素をSwiftのオブジェクトとして扱うことができます。

まとめ

Swiftを用いてXMLをパースする技術は、初心者から中級者まで様々なレベルの開発者に役立つ知識となっています。

基本的なパース方法から非同期処理を伴うパース、そして外部ライブラリを使用したパース方法まで、多岐にわたるテクニックを学ぶことができたかと思います。

これらの知識を駆使することで、効率的かつ正確にXMLデータの解析と活用が可能となります。

日々の開発作業において、今回学んだ内容を活かして、さらなるスキルアップを目指してください。