Flutter实时MongoDB数据库操作插件edmax_realtime_mongo_lite的使用

Edmax Realtime Mongo Lite | WARNING [UNSTABLE VERSION]

功能概述

edmax_realtime_mongo_lite 是一个轻量级的Dart包，旨在帮助开发者实现数据的实时同步。

包的功能

• 连接到WebSocket服务器以接收实时更新。
• 监听数据库的变化，并在应用程序中触发相应的动作。
• 将传入的JSON消息解析为结构化的Dart对象（DataSnapshot）。
• 提供简单的API，方便开发者与实时数据交互，确保Flutter或Dart应用中的平滑高效更新。

关键特性

• 单例模式：确保WebSocket连接只有一个实例。
• 监听器管理：允许开发者注册监听器以处理不同的事件（如数据变化、断开连接、错误等）。
• JSON解析：自动将JSON数据解析为结构化的Dart对象，便于在应用中使用。
• 错误处理：内置错误处理机制，用于管理连接问题和意外的数据格式。
• WebSocket通道订阅支持：可选地支持需要客户端订阅特定通道的WebSocket。

开发者为何应使用它？

• 易于使用：提供简单直观的API，设置实时数据同步时几乎无需冗长的样板代码。
• 实时数据：适用于需要从服务器即时获取更新的应用程序，例如聊天应用、实时新闻流或协作工具。
• 可定制性：该包设计灵活，开发者可以自定义监听器并处理不同类型的数据操作。

示例用法

以下是一个完整的示例，展示如何在Flutter项目中使用 edmax_realtime_mongo_lite 插件。

1. 配置项目入口文件 main.dart

// Your App Entry Point main.dart
// 设置WebSocket URL
void main() {
  EdmaxRealtimeMongo(wsUrl: "ws://localhost:8080/");
  runApp(const MyApp());
}

2. 创建自定义的监听类

// Your Custom Listener Class
import 'package:edmax_realtime_mongo_lite/edmax_realtime_mongo_lite.dart';
import 'package:edmax_realtime_mongo_lite/tools/snapshot.dart';
import 'package:flutter/material.dart';

class HelloWorld extends StatefulWidget {
  const HelloWorld({super.key});

  @override
  State<HelloWorld> createState() => _HelloWorldState();
}

class _HelloWorldState extends State<HelloWorld> with EdmaxRealtimeMongoListener {

  @override
  void initState() {
    super.initState();
    // 初始化监听器，传递URL和快照（如果需要）
    EdmaxRealtimeMongo.initialize(
      listener: this,
      endpoint: "",
      snapshot: "",
    );
  }

  @override
  void dispose() {
    super.dispose();
    // 确保释放资源
    EdmaxRealtimeMongo.initialize(
      listener: null,
      endpoint: "",
      snapshot: "",
    );
  }

  @override
  Widget build(BuildContext context) {
    return const Placeholder();
  }

  @override
  void onDataChange(DataSnapshot dataSnapshot) {
    print('数据已更改: ${dataSnapshot.snapshot}');
  }

  @override
  void onDataRemoved() {
    print('数据已被移除，重新加载...');
  }

  @override
  void onDisconnected() {
    print('已断开与服务器的连接');
  }

  @override
  void onError(String error) {
    print('发生错误: $error');
  }
}

JSON结构要求

为了使此包正常工作，服务器返回的JSON必须符合以下结构：

{
  "snapshot": "contents",
  "operation": "update",
  "data": {
    "_id": "66b8b265d47bdeb08e7a8581",
    "leading": "<img src=\"https://example.com/image.jpg\"/>",
    "content": "Your content here",
    "createdAt": "2024-08-10T14:30:00Z",  // ISO 8601日期时间字符串
    "updatedAt": "2024-08-11T09:15:00Z",  // ISO 8601日期时间字符串
    "tag": "_community"
  }
}