firestore_obj 是一个用于简化 Flutter 应用与 Firestore 数据库交互的插件。它通过将 Firestore 文档映射到 Dart 对象，使得开发者可以更方便地进行 CRUD 操作。以下是如何使用 firestore_obj 插件的基本步骤：

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 firestore_obj 依赖：

dependencies:
  flutter:
    sdk: flutter
  firestore_obj: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

2. 初始化 Firestore

在使用 firestore_obj 之前，确保你已经初始化了 Firestore。通常，你可以在 main.dart 中进行初始化：

import 'package:firebase_core/firebase_core.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();
  runApp(MyApp());
}

3. 创建数据模型

firestore_obj 通过将 Firestore 文档映射到 Dart 对象来工作。你需要创建一个数据模型类，并继承 FirestoreObject。

import 'package:firestore_obj/firestore_obj.dart';

class User extends FirestoreObject {
  String? name;
  int? age;
  String? email;

  User({this.name, this.age, this.email});

  @override
  Map<String, dynamic> toMap() {
    return {
      'name': name,
      'age': age,
      'email': email,
    };
  }

  @override
  User fromMap(Map<String, dynamic> map) {
    return User(
      name: map['name'],
      age: map['age'],
      email: map['email'],
    );
  }
}

4. 使用 FirestoreCollection 进行 CRUD 操作

FirestoreCollection 是 firestore_obj 提供的用于操作 Firestore 集合的类。你可以使用它来进行增删改查操作。

添加文档

final userCollection = FirestoreCollection<User>(path: 'users');
final user = User(name: 'John Doe', age: 30, email: 'john@example.com');
await userCollection.add(user);

获取文档

final user = await userCollection.doc('documentId').get();
print(user.name);

更新文档

final user = User(name: 'John Doe', age: 31, email: 'john@example.com');
await userCollection.doc('documentId').update(user);

删除文档

await userCollection.doc('documentId').delete();

查询文档

final users = await userCollection.where('age', isGreaterThan: 25).get();
for (var user in users) {
  print(user.name);
}

5. 监听实时更新

firestore_obj 还支持实时监听 Firestore 数据的变化。

userCollection.snapshots().listen((snapshot) {
  for (var user in snapshot) {
    print(user.name);
  }
});

6. 处理嵌套对象

如果你的 Firestore 文档中包含嵌套对象，你可以在 toMap 和 fromMap 方法中进行处理。

class Address {
  String? city;
  String? street;

  Address({this.city, this.street});

  Map<String, dynamic> toMap() {
    return {
      'city': city,
      'street': street,
    };
  }

  Address fromMap(Map<String, dynamic> map) {
    return Address(
      city: map['city'],
      street: map['street'],
    );
  }
}

class User extends FirestoreObject {
  String? name;
  Address? address;

  User({this.name, this.address});

  @override
  Map<String, dynamic> toMap() {
    return {
      'name': name,
      'address': address?.toMap(),
    };
  }

  @override
  User fromMap(Map<String, dynamic> map) {
    return User(
      name: map['name'],
      address: Address().fromMap(map['address']),
    );
  }
}

7. 错误处理

在进行 Firestore 操作时，建议添加错误处理逻辑。

try {
  final user = await userCollection.doc('documentId').get();
  print(user.name);
} catch (e) {
  print('Error: $e');
}