Flutter云数据库解析插件firestore_api_parser的使用

发布于 1周前 作者 ionicwang 来自 Flutter

Flutter云数据库解析插件firestore_api_parser的使用

简介

firestore_api_parser 是一个Flutter和Dart插件，允许你将Firestore用于表示其文档或集合的JSON格式转换为常规的JSON数据格式。这个插件特别适用于在Windows和Linux平台上开发Flutter应用的开发者，因为官方的 cloud_firestore 插件不支持这些平台（除了macOS）。通过使用Firebase提供的REST API，你可以轻松地与Cloud Firestore进行交互，并且使用 firestore_api_parser 来处理数据格式的转换。

动机

作为Flutter开发者，我们在开发Windows和Linux平台的应用时发现，现有的Firebase插件（如 cloud_firestore）并不支持这些平台（除了macOS）。虽然可以使用Firebase提供的REST API，但Cloud Firestore返回的数据是以一种特殊的JSON格式表示的，这可能会增加开发时间。因此，我们创建了这个插件来简化从Firestore格式到标准JSON格式的转换过程。

使用场景

  • Windows、Linux 和 Dart 控制台应用：如果你正在为这些平台开发Flutter应用，可以使用 firestore_api_parser 来帮助你转换来自Firestore文档或集合的数据。
  • iOS、macOS、Android 和 Web：对于这些平台，建议使用官方的 cloud_firestore 插件，它已经很好地支持这些平台。
  • 通过REST API 与 Firestore 交互：你可以使用此插件来接收、发送和转换来自Firestore文档或集合的数据。

功能

  • JSON 转换：将标准JSON格式的数据转换为Cloud Firestore REST API可理解的格式，反之亦然。
  • 支持的数据类型：
    • stringValue (String)
    • integerValue (int)
    • doubleValue (double)
    • booleanValue (bool)
    • mapValue (Map)
    • arrayValue (List)
    • timestampValue (DateTime)
    • geoPointValue (Map)
    • referenceValue (String)
    • nullValue (null)

开始使用

安装
  1. 在 pubspec.yaml 文件中添加以下依赖项：
dependencies:
  firestore_api_parser: ^<latest_version>
  1. 导入包：
import 'package:firestore_api_parser/firestore_api_parser.dart';
示例代码

下面是一个完整的示例，展示了如何使用 firestore_api_parser 进行数据转换。我们将创建一个 Agent 对象，将其转换为Firestore格式的JSON，然后再将其转换回标准JSON格式。

import 'package:firestore_api_parser/firestore_api_parser.dart';

// 假设有一个 Agent 类，使用 json_serializable 进行序列化
import 'agent.dart';

void main() {
  // 创建一个 Agent 对象
  final names = {'lastname': 'BOND', 'firstname': 'James', 'initial': 'JB'};

  final bond = Agent(
    names: names,
    missions: [
      {'2022': 'No Time To Die'},
      {'2015': 'Spectre'},
      {'2006': 'Casino Royale'},
    ],
    status: 'In service',
    round: 20.5,
    timestamp: DateTime.utc(2021, 10, 7, 19, 0, 0),  // 使用 UTC 时间
    storageRef: 'projects/my_great_project/databases/(default)/documents/USERS/[doc_id]',  // Firestore 文档引用
    nullable: null,
    coordinates: const {'latitude': -64, 'longitude': -86},  // 地理位置
  );

  // 将 Agent 对象转换为 Firestore 格式的 JSON
  final firestoreJsonDoc = FirestoreApiParser.convertToFirestoreDocument(json: bond.toJson());

  // 或者使用扩展方法
  // final firestoreJsonDoc = bond.toJson().toFirestoreJson;

  print('Firestore JSON Document: $firestoreJsonDoc');

  // 将 Firestore 格式的 JSON 转换为标准 JSON
  final standardJson = FirestoreApiParser.convertToStandardJson(doc: firestoreJsonDoc);

  // 或者使用扩展方法
  // final standardJson = firestoreJsonDoc.toStandardJson;

  print('Standard JSON: $standardJson');

  // 你还可以使用以下方法解析和转换 Firestore 集合为 JSON
  // final document = FirestoreApiParser.parseCollection(collection: firestoreCollection);
}
扩展方法

你还可以使用扩展方法来简化编码和解码操作：

final firestoreJsonDoc = bond.toJson().toFirestoreJson;  // 编码为 Firestore JSON 结构
final standardJson = firestoreJsonDoc.toStandardJson;  // 解码为标准 JSON
特殊数据类型的处理

  • 参考值 (referenceValue)：参考值必须符合 Firestore 的路径格式，例如：

    final reference = 'projects/my_great_project/databases/(default)/documents/';
// 也可以指向特定的集合或文档
final collectionReference = 'projects/my_great_project/databases/(default)/documents/my_collection';
final documentReference = 'projects/my_great_project/databases/(default)/documents/my_collection/docid';

  • 地理坐标 (geoPointValue)：地理坐标必须是一个包含 latitude 和 longitude 键的 Map：

    final geoPointValue = {'latitude': -64, 'longitude': -86};

  • 时间戳 (timestampValue)：时间戳需要以 ISO 8601 格式传递，例如：

    final timestamp = DateTime.parse('2021-10-07T19:00:00Z');
推荐的做法

为了获得更好的结果并避免意外行为，建议使用 json_serializable 包（或其他JSON序列化工具）来序列化你的数据对象。例如：

import 'package:json_annotation/json_annotation.dart';

part 'agent.g.dart';

[@JsonSerializable](/user/JsonSerializable)()
class Agent {
  final String storageRef;
  final DateTime timestamp;
  final String? nullable;
  final double round;
  final Map<String, num> coordinates;
  final String status;
  final Map<String, dynamic> names;
  final List missions;

  Agent({
    required this.coordinates,
    required this.storageRef,
    required this.timestamp,
    required this.round,
    required this.names,
    required this.missions,
    required this.status,
    this.nullable,
  });

  factory Agent.fromJson(Map<String, dynamic> data) => _$AgentFromJson(data);

  Map<String, dynamic> toJson() => _$AgentToJson(this);
}

更多关于Flutter云数据库解析插件firestore_api_parser的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

Harmonyos Next教程
1 回复

更多关于Flutter云数据库解析插件firestore_api_parser的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是一个关于如何在Flutter项目中使用firestore_api_parser插件来解析Firebase Firestore数据库的示例代码。firestore_api_parser这个插件（假设存在，因为这不是官方插件，所以这里做假设性说明）可能帮助简化Firestore数据的解析过程。下面是一个示例，展示如何使用这个插件来从Firestore获取数据并解析它。

1. 添加依赖

首先，你需要在pubspec.yaml文件中添加firestore_api_parser依赖（假设它已经在pub.dev上发布）：

dependencies:
  flutter:
    sdk: flutter
  cloud_firestore: ^x.y.z  # 确保你使用的是最新版本
  firestore_api_parser: ^a.b.c  # 假设的版本号

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

2. 配置Firebase

确保你的Firebase项目已经配置好，并且你已经在Firebase控制台中添加了你的Flutter应用。你还需要在google-services.json（Android）和GoogleService-Info.plist（iOS）文件中添加Firebase配置。

3. 初始化Firestore并解析数据

以下是一个完整的示例，展示如何使用firestore_api_parser从Firestore获取数据并解析它：

import 'package:flutter/material.dart';
import 'package:cloud_firestore/cloud_firestore.dart';
import 'package:firestore_api_parser/firestore_api_parser.dart';  // 假设的导入路径

// 假设你有一个数据模型
class User {
  String id;
  String name;
  int age;

  User({required this.id, required this.name, required this.age});

  // 从Map解析数据
  factory User.fromJson(Map<String, dynamic> json) {
    return User(
      id: json['id'] as String,
      name: json['name'] as String,
      age: json['age'] as int,
    );
  }

  // 转换为Map以便存储
  Map<String, dynamic> toJson() {
    return {
      'id': id,
      'name': name,
      'age': age,
    };
  }
}

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Firestore API Parser Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late FirebaseFirestore _firestore;
  List<User> users = [];

  @override
  void initState() {
    super.initState();
    _firestore = FirebaseFirestore.instance;
    fetchUsers();
  }

  void fetchUsers() async {
    try {
      QuerySnapshot querySnapshot = await _firestore.collection('users').get();
      List<User> parsedUsers = querySnapshot.docs.map((doc) {
        // 假设firestore_api_parser提供了这样的解析功能
        // 这里我们使用假设的parseDocument方法
        Map<String, dynamic> data = doc.data() as Map<String, dynamic>;
        return User.fromJson(parseDocument(data));  // 假设parseDocument是插件提供的方法
      }).toList();

      setState(() {
        users = parsedUsers;
      });
    } catch (e) {
      print(e.toString());
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Firestore Users'),
      ),
      body: ListView.builder(
        itemCount: users.length,
        itemBuilder: (context, index) {
          User user = users[index];
          return ListTile(
            title: Text('Name: ${user.name}'),
            subtitle: Text('Age: ${user.age}'),
          );
        },
      ),
    );
  }
}

// 假设的parseDocument方法（实际应根据插件API实现）
Map<String, dynamic> parseDocument(Map<String, dynamic> data) {
  // 这里只是一个占位符，实际应根据插件的API来实现解析逻辑
  return data;
}

注意事项

  1. 插件API：上面的代码假设firestore_api_parser提供了一个parseDocument方法来解析文档数据。你需要根据实际的插件API文档来替换这个占位符。
  2. 错误处理：在实际应用中，你需要添加更详细的错误处理逻辑。
  3. 数据模型：确保你的数据模型与Firestore中的数据结构相匹配。

由于firestore_api_parser并非一个实际存在的官方插件（根据我的知识截止日期），因此上述代码中的parseDocument方法只是一个占位符。你需要根据插件的实际API来调整代码。如果firestore_api_parser实际上存在并有不同的API，请参考它的官方文档来正确使用。

回到顶部