benxu.AppPlatform.Firebase.Firestore 3.2.7

benxu.AppPlatform.Firebase.Firestore

Firebase Cloud Firestore 實作套件，提供雲端 NoSQL 資料庫功能，支援文件操作、即時監聽、批次寫入和交易。

功能特色

• 文件操作: 建立、讀取、更新、刪除文件 (CRUD)
• 集合查詢: 支援多種查詢條件和排序
• 即時監聽: 監聽文件和集合的即時變更
• 批次操作: 一次性執行多個寫入操作
• 交易支援: 保證資料一致性的交易操作
• 離線支援: 內建離線持久化功能

安裝

dotnet add package benxu.AppPlatform.Firebase.Firestore

快速開始

1. 設定服務

// 方式 1: 使用 Bootstrap
builder.UseAppPlatform(options =>
{
 options.UseFirestore(firestore =>
 {
 firestore.EnableOfflinePersistence = true;
 firestore.CacheSizeMegabytes = 100;
 });
});

// 方式 2: 手動註冊
builder.Services.AddFirestore(options =>
{
 options.EnableOfflinePersistence = true;
});

2. 定義資料模型

重要: 資料模型必須實作 IFirestoreObject 介面，並使用 [FirestoreProperty] 屬性標記要序列化的屬性。

using Plugin.Firebase.Firestore;

public class User : IFirestoreObject
{
 [FirestoreProperty("name")]
 public string Name { get; set; } = "";

 [FirestoreProperty("age")]
 public int Age { get; set; }

 [FirestoreProperty("email")]
 public string Email { get; set; } = "";

 [FirestoreProperty("createdAt")]
 public DateTimeOffset CreatedAt { get; set; }
}

注意事項:

• 類別必須是 public，否則反射無法正確存取
• [FirestoreProperty] 中的名稱會成為 Firestore 文件中的欄位名稱
• 重要: 時間欄位必須使用 DateTimeOffset（不是 DateTime），否則會發生類型轉換錯誤
• 支援的類型包括: string, int, long, double, bool, DateTimeOffset, 陣列, 字典等

3. 使用服務

@inject IFirestoreService Firestore

// 建立文件
var user = new User { Name = "張三", Age = 25 };
await Firestore.SetDocumentAsync("users", "user123", user);

// 讀取文件
var result = await Firestore.GetDocumentAsync<User>("users", "user123");
if (result.IsSuccess)
{
 Console.WriteLine($"Name: {result.Data.Name}");
}

// 查詢集合
var queryResult = await Firestore.QueryCollectionAsync<User>(
 "users",
 q => q.WhereGreaterThan("Age", 18)
 .OrderBy("Name")
 .Limit(10)
);

// 即時監聽
var listener = Firestore.ListenToDocument<User>(
 "users",
 "user123",
 onChanged: user => Console.WriteLine($"Updated: {user?.Name}"),
 onError: ex => Console.WriteLine($"Error: {ex.Message}")
);

// 取消監聽
listener.Dispose();

設定選項

支援平台

• Android 21.0+
• iOS 14.0+

依賴

• benxu.AppPlatform.Core
• Plugin.Firebase.Firestore (3.1.3)

授權

MIT License