はじめに (対象読者・この記事でわかること)

この記事は、Swiftを用いたiOSアプリ開発に興味があり、Firebase Firestoreをデータベースとして利用している開発者を対象としています。特に、TableViewを用いたリスト表示とデータ削除の連携に悩んでいる方に最適です。

この記事を読むことで、SwiftのTableViewでセルを削除する際に、対応するFirestoreドキュメントも連携して削除する方法を理解できます。特に、ドキュメントIDの取得方法に焦点を当てて解説するため、データの一貫性を保ちながら効率的な削除処理を実装できるようになります。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。 - Swiftの基本的な文法と構文 - iOS開発におけるTableViewの基本的な実装方法 - Firebaseプロジェクトの設定とFirestoreの基本的な操作 - StoryboardまたはSwiftUIでのUI作成の基本的な知識

FirestoreとTableViewの連携の基本

iOSアプリ開発において、Firestoreをデータベースとして利用し、そのデータをTableViewに表示するケースは非常に一般的です。しかし、ユーザーがTableViewからセルを削除した際に、対応するFirestoreドキュメントも削除する必要がある場合、実装が少し複雑になります。

特に、ドキュメントIDの取得方法が分からずに苦戦している開発者も多いのではないでしょうか。この記事では、その具体的な解決策をステップバイステップで解説します。

TableViewのセル削除とFirestoreドキュメント削除の実装方法

ステップ1：Firestoreドキュメントに一意のIDを割り当てる

まず、Firestoreドキュメントに一意のIDを割り当てる必要があります。通常、Firestoreではドキュメント作成時に自動でIDが生成されますが、これをTableViewのセルと関連付ける必要があります。

Swift

import Firebase

class ViewController: UIViewController, UITableViewDataSource, UITableViewDelegate {

    var items: [DocumentSnapshot] = []
    let db = Firestore.firestore()

    override func viewDidLoad() {
        super.viewDidLoad()

        // Firestoreからデータを取得
        db.collection("items").addSnapshotListener { (querySnapshot, error) in
            guard let documents = querySnapshot?.documents else { return }
            self.items = documents
            self.tableView.reloadData()
        }
    }

    // その他のTableViewのデリゲートメソッド...
}

このコードでは、Firestoreのitemsコレクションからドキュメントを取得し、DocumentSnapshotの配列として保持しています。DocumentSnapshotにはドキュメントIDが含まれているため、これを後で利用できます。

ステップ2：セル削除時にドキュメントIDを取得して削除処理を行う

次に、TableViewのセルが削除された際に、対応するドキュメントを削除する処理を実装します。

Swift

func tableView(_ tableView: UITableView, commit editingStyle: UITableViewCell.EditingStyle, forRowAt indexPath: IndexPath) {
    if editingStyle == .delete {
        let documentID = items[indexPath.row].documentID

        // Firestoreからドキュメントを削除
        db.collection("items").document(documentID).delete { error in
            if let error = error {
                print("Error removing document: \(error)")
            } else {
                print("Document successfully removed!")
            }
        }

        // TableViewからセルを削除
        items.remove(at: indexPath.row)
        tableView.deleteRows(at: [indexPath], with: .fade)
    }
}

このコードでは、items[indexPath.row].documentIDでドキュメントIDを取得し、それを使ってFirestoreから対応するドキュメントを削除しています。その後、TableViewのデータ配列からも該当アイテムを削除し、UIを更新しています。

ステップ3：削除処理の確認ダイアログを追加する

ユーザーが誤って削除してしまうのを防ぐため、削除前に確認ダイアログを表示するのが一般的です。

Swift

func tableView(_ tableView: UITableView, editingStyleForRowAt indexPath: IndexPath) -> UITableViewCell.EditingStyle {
    return .delete
}

func tableView(_ tableView: UITableView, titleForDeleteConfirmationButtonForRowAt indexPath: IndexPath) -> String? {
    return "削除"
}

func tableView(_ tableView: UITableView, shouldIndentWhileEditingRowAt indexPath: IndexPath) -> Bool {
    return false
}

func tableView(_ tableView: UITableView, commit editingStyle: UITableViewCell.EditingStyle, forRowAt indexPath: IndexPath) {
    if editingStyle == .delete {
        let alert = UIAlertController(title: "確認", message: "このアイテムを削除しますか？", preferredStyle: .alert)

        alert.addAction(UIAlertAction(title: "キャンセル", style: .cancel, handler: nil))

        alert.addAction(UIAlertAction(title: "削除", style: .destructive) { _ in
            let documentID = self.items[indexPath.row].documentID

            // Firestoreからドキュメントを削除
            self.db.collection("items").document(documentID).delete { error in
                if let error = error {
                    print("Error removing document: \(error)")
                } else {
                    print("Document successfully removed!")
                }
            }

            // TableViewからセルを削除
            self.items.remove(at: indexPath.row)
            tableView.deleteRows(at: [indexPath], with: .fade)
        })

        present(alert, animated: true, completion: nil)
    }
}

このコードでは、削除ボタンがタップされた際に確認ダイアログを表示し、ユーザーが削除を確認した場合のみFirestoreドキュメントとTableViewセルの両方を削除するようにしています。

ハマった点やエラー解決

ドキュメントIDの取得方法が分からない

多くの開発者が最初に直面する問題は、どのようにドキュメントIDを取得すればよいか分からないことです。Firestoreのドキュメントには自動で一意のIDが割り当てられますが、これをコード内で取得する方法が分からないと苦戦します。

解決策： DocumentSnapshotオブジェクトにはdocumentIDプロパティがあり、これを使ってドキュメントIDを取得できます。前述のコードのように、items[indexPath.row].documentIDのようにアクセスすることで、簡単にドキュメントIDを取得できます。

削除処理のタイミングが合わない

Firestoreのドキュメント削除は非同期処理であるため、削除が完了する前にTableViewのUI更新が行われてしまうと、データの不整合が発生する可能性があります。

解決策： Firestoreのdelete()メソッドはcompletionハンドラを引数に取るため、このハンドラ内でTableViewの更新処理を行うようにします。これにより、ドキュメントの削除が確実に完了した後にUIが更新されるようになります。

Swift

db.collection("items").document(documentID).delete { error in
    if let error = error {
        print("Error removing document: \(error)")
    } else {
        print("Document successfully removed!")
        // ここでTableViewの更新処理を行う
        DispatchQueue.main.async {
            self.items.remove(at: indexPath.row)
            tableView.deleteRows(at: [indexPath], with: .fade)
        }
    }
}

エラーハンドリングの不足

ネットワークの問題や権限の問題などでドキュメント削除に失敗した場合に、適切なエラーハンドリングを行わないと、ユーザーに問題が発生したことが伝わりません。

解決策： 削除処理のcompletionハンドラでエラーが発生した場合に、アラートやトースト通知などでユーザーに通知するようにします。

Swift

db.collection("items").document(documentID).delete { error in
    if let error = error {
        // エラーが発生した場合の処理
        print("Error removing document: \(error)")

        DispatchQueue.main.async {
            let alert = UIAlertController(title: "エラー", message: "削除に失敗しました。再試行してください。", preferredStyle: .alert)
            alert.addAction(UIAlertAction(title: "OK", style: .default, handler: nil))
            self.present(alert, animated: true, completion: nil)
        }
    } else {
        // 削除成功時の処理
        print("Document successfully removed!")

        DispatchQueue.main.async {
            self.items.remove(at: indexPath.row)
            tableView.deleteRows(at: [indexPath], with: .fade)
        }
    }
}

まとめ

本記事では、SwiftでTableViewのセルを削除する際に、対応するFirestoreドキュメントも削除する方法を解説しました。

  • DocumentSnapshotのdocumentIDプロパティを使ってドキュメントIDを取得する方法
  • 削除処理の前に確認ダイアログを表示する実装方法
  • 非同期処理のタイミングを考慮したUI更新方法
  • エラーハンドリングを適切に行う重要性

この記事を通して、データの一貫性を保ちながら、ユーザーフレンドリーな削除機能を実装できるようになったことを願っています。今後は、バッチ削除やオフライン対応など、さらに高度な機能についても記事にする予定です。

参考資料