Zenn
🐡

Flutter webでFirestore Databaseを使ったリアルタイムデータ管理

2024/07/01に公開
Flutter
Google Cloud
Dart
Cloud Firestore
firebasedatabase
tech

はじめに

この記事では、Firestore Databaseを使用したリアルタイムデータ管理の方法について説明します。具体的には、Firestoreの基本概念と利点、Firestoreの設定方法、データの読み取り・書き込みの基本操作、およびFirestoreルールの設定とセキュリティについて解説します。

Firestoreの基本概念と利点

基本概念

Firestoreは、Firebaseが提供するNoSQLのクラウドデータベースサービスであり、スケーラブルかつ柔軟なデータベースソリューションを提供します。データはコレクションとドキュメントの形式で保存されます。

  • コレクション: ドキュメントのグループ。各コレクションには一意のIDがあります。
  • ドキュメント: フィールドと値のペアで構成されるデータ単位。各ドキュメントにも一意のIDがあります。

利点

  • リアルタイム同期: データの変更が即座に反映され、リアルタイムでデータを取得できます。
  • オフラインサポート: オフライン時にもデータにアクセスでき、再接続時に自動的に同期されます。
  • スケーラビリティ: 大規模なアプリケーションでもスケーラブルなデータベース構造を提供します。

Firestoreの設定方法

Firebaseプロジェクトの作成

  1. Firebaseコンソールにアクセスし、プロジェクトを作成します。
  2. プロジェクトが作成されたら、左側のナビゲーションメニューから「Firestore Database」を選択し、「データベースの作成」をクリックします。
  3. 「生産モード」または「テストモード」のいずれかを選択しますが、セキュリティ設定のために「生産モード」を推奨します。

FlutterプロジェクトへのFirestore導入

次に、FlutterプロジェクトにFirestoreを導入します。

flutter pub add cloud_firestore

これにより、Firestore用のパッケージがプロジェクトに追加されます。

データの読み取り・書き込みの基本操作

データの書き込み

以下のコードスニペットは、Firestoreにデータを追加する方法を示しています。

import 'package:cloud_firestore/cloud_firestore.dart';

void addUser() {
  FirebaseFirestore.instance.collection('users').add({
    'name': 'John Doe',
    'age': 25,
    'email': 'johndoe@example.com',
  }).then((DocumentReference doc) {
    print('DocumentSnapshot added with ID: ${doc.id}');
  }).catchError((error) {
    print('Error adding document: $error');
  });
}

データの読み取り

次に、Firestoreからデータを読み取る方法を示します。

void getUsers() {
  FirebaseFirestore.instance.collection('users').get().then((QuerySnapshot querySnapshot) {
    querySnapshot.docs.forEach((doc) {
      print(doc["name"]);
    });
  }).catchError((error) {
    print('Error getting documents: $error');
  });
}

データのリアルタイム更新

リアルタイムでデータの更新をリッスンする方法を示します。

void listenToUserUpdates() {
  FirebaseFirestore.instance.collection('users').snapshots().listen((QuerySnapshot querySnapshot) {
    querySnapshot.docs.forEach((doc) {
      print(doc["name"]);
    });
  });
}

Firestoreルールの設定とセキュリティ

Firestoreルールの基本

Firestoreのセキュリティルールは、データの読み取りおよび書き込みアクセスを制御します。ルールは、Firestoreコンソールの「ルール」タブから設定できます。

例: 全てのユーザーが自分のデータのみ読み書きできるようにする

以下は、認証されたユーザーが自分のドキュメントにのみアクセスできるようにするルールの例です。

service cloud.firestore {
  match /databases/{database}/documents {
    match /users/{userId} {
      allow read, write: if request.auth != null && request.auth.uid == userId;
    }
  }
}

セキュリティベストプラクティス

  • 最小権限の原則: 必要な最低限の権限のみを付与するようにルールを設定します。
  • ルールのテスト: ルールが期待通りに動作するかをテストツールを使って確認します。
  • 定期的なレビュー: ルールを定期的にレビューし、セキュリティ上のリスクがないか確認します。

データの更新と削除

データの更新

Firestore内のデータを更新する方法を示します。

void updateUser(String docId) {
  FirebaseFirestore.instance.collection('users').doc(docId).update({
    'name': 'Jane Doe',
    'age': 26,
  }).then((_) {
    print('DocumentSnapshot updated');
  }).catchError((error) {
    print('Error updating document: $error');
  });
}

データの削除

Firestore内のデータを削除する方法を示します。

void deleteUser(String docId) {
  FirebaseFirestore.instance.collection('users').doc(docId).delete().then((_) {
    print('DocumentSnapshot deleted');
  }).catchError((error) {
    print('Error deleting document: $error');
  });
}

Firestoreのクエリ

Firestoreのクエリを使用して、条件に基づいてデータを取得する方法を示します。

単純なクエリ

void getUserByName(String name) {
  FirebaseFirestore.instance.collection('users').where('name', isEqualTo: name).get().then((QuerySnapshot querySnapshot) {
    querySnapshot.docs.forEach((doc) {
      print(doc["name"]);
    });
  }).catchError((error) {
    print('Error getting documents: $error');
  });
}

複合クエリ

void getUsersByAgeRange(int minAge, int maxAge) {
  FirebaseFirestore.instance.collection('users').where('age', isGreaterThanOrEqualTo: minAge).where('age', isLessThanOrEqualTo: maxAge).get().then((QuerySnapshot querySnapshot) {
    querySnapshot.docs.forEach((doc) {
      print(doc["name"]);
    });
  }).catchError((error) {
    print('Error getting documents: $error');
  });
}

Firestoreのトランザクション

Firestoreのトランザクションを使用して、複数の読み取り・書き込み操作をアトミックに行う方法を示します。

void runTransaction() {
  FirebaseFirestore.instance.runTransaction((transaction) async {
    DocumentReference userRef = FirebaseFirestore.instance.collection('users').doc('user_id');

    DocumentSnapshot snapshot = await transaction.get(userRef);

    if (!snapshot.exists) {
      throw Exception('User does not exist!');
    }

    int newAge = snapshot['age'] + 1;

    transaction.update(userRef, {'age': newAge});
  }).then((_) {
    print('Transaction completed');
  }).catchError((error) {
    print('Transaction failed: $error');
  });
}

まとめ

Firestoreを使用すると、リアルタイムでスケーラブルなデータベースを簡単に構築できます。この記事では、Firestoreの基本概念、設定方法、データの読み取り・書き込みの基本操作、データの更新と削除、クエリの使用、トランザクションの実行、そしてセキュリティルールの設定について解説しました。これらを活用して、安全で効率的なデータ管理システムを構築してください。

Discussion