Flutter社交云聊天插件locality_social_cloud_chat的使用

locality_social_cloud_chat 是一个用于管理一对一消息和群聊的实时聊天系统。它支持消息传递、反应、通知和邀请功能，并且与 locality_social_cloud API 集成。

功能

• 端到端加密：使用 ECDH 椭圆曲线 M-511 和 ChaCha20 进行加密。
• 消息反应：用户可以对消息进行预定义或自定义的反应。
• 事件驱动架构：使用 PubSub 模型响应特定类型的消息（如文本、媒体）。
• 群聊：邀请用户加入群聊并管理接受情况。
• 高效的UI更新：使用 ThrottledChangeNotifier 进行优化的状态更新。
• 消息观察者：实时跟踪消息状态（如已读、已发送和反应）。

开始使用

该项目使用了 Locality Social Cloud 库。 要使用它，你需要有一个 Social Cloud Developer Account 并获取你的应用密钥。

在项目中添加以下依赖：

flutter pub add locality_social_cloud
flutter pub add locality_social_cloud_chat
flutter pub get

配置Locality Social Cloud

从 Locality Social Cloud 获取你的应用ID和应用密钥，并配置它们：

LocalitySocialCloud.configure(app_id: 'YOUR_APP_ID', app_secret: 'YOUR_APP_SECRET');

然后运行 flutter pub get 安装包。

导入库

import 'package:locality_social_cloud_chat/locality_social_cloud_chat.dart';

示例用法

1. 初始化直接消息聊天

创建一个 DirectMessagesChat 实例用于一对一消息通信：

DirectMessagesChat chat = await DirectMessagesFacade.getTargetUserChat(
      loggedInUser,
      targetUser
  );

2. 发送消息

向聊天中发送一条新消息：

chat.sendMessage({
  'content': 'Hello, this is a message!',
});

你可以监听状态更新：

chat.addListener(() {
    ...
});

这是一个限流器，意味着它最多每秒调用 120 次，并且只有当有新的状态可用时才会被调用。你可以像使用 Provider 一样将其集成到你的UI中。如果你想确保某些事件在同步后才发生，可以使用 locality_social_cloud 中的 Timeline：

chat.timeline.whenSynchronized(() {
    for (var chatMessage in chat.chatMessages) {
      String messageUuid = chatMessage.payload['message_uuid'];
      ....
    }
  });

3. 添加消息反应

对特定消息进行反应：

chat.reactToMessage('message_uuid_123', 'like');

4. 跟踪消息状态

你可以通过订阅 MessageObserver 来监控消息是否已送达或已读：

MessageObserver chatMessageObserver = chat.messageObserversByChatMessageUUID[messageUuid]!;
if (!messageObserver.seen) {
    print('Message not seen yet');
}
messageObserver.addListener((){
    // 当状态改变时将被调用
    if (messageObserver.seen) {
        print('Message seen');
    }
});

使用此代码块在 timeline 同步时执行：

chat.timeline.whenSynchronized(() {
    ...
});

如果你有特殊消息类型，如照片消息，会触发照片下载，你可以使用：

chat.whenMessageOfTypeReceived('photo_message', (messageObserver) {
    
});

5. 处理群聊邀请

邀请用户加入群聊或接受邀请：

chat.inviteToGroupChat('Cool Group', 'group_uuid_456', 'group_topic', BigInt.from(123456));
chat.acceptGroupChatInvitation('message_uuid_789', 'group_uuid_456');

使用邀请来创建群聊。GroupChats 类将持有从接受的邀请中生成的群聊。

GroupChats.getInstance().addListener(() {
    List<GroupChat> groupChats = GroupChats.getInstance().groupChats;
    for(GroupChat groupChat in groupChats) {
      print("We are connected to the groupchat ... "+groupChat.title);
    }
  });

事件处理

DirectMessagesChat 类监听各种聊天相关的事件（如消息添加、反应、已读、已发送等）。你可以通过实现自定义操作来处理这些事件。

进入和离开聊天

当用户进入或离开聊天时，你可以影响他们是否已经查看过消息：

chat.enterChat();  // 将所有消息标记为已读。
chat.leaveChat();  // 将聊天标记为未读。

示例代码

以下是完整的示例代码：

import 'dart:math';

import 'package:locality_social_cloud/api/discover_users.dart';
import 'package:locality_social_cloud/api/locality_auth.dart';
import 'package:locality_social_cloud/api/locality_social_cloud.dart';
import 'package:locality_social_cloud/api/locality_user.dart';
import 'package:locality_social_cloud/api/logged_in_user.dart';
import 'package:locality_social_cloud_chat/locality_social_cloud_chat.dart';

Future<LoggedInUser> getLoggedInUser() async {
  LocalitySocialCloud.configure(appId: "....", appSecret: "........");
  LoggedInUserOrError loggedInUserOrError =
      await LocalitySocialCloud.auth("userName", "password");

  if (loggedInUserOrError.isError()) {
    throw Exception(
        "Could not log in to the Locality Social Cloud. Please verify that appId and appSecret are correct.");
  }

  LoggedInUser loggedInUser = loggedInUserOrError.getUser();
  LocalitySocialCloud.connect(loggedInUser);

  return loggedInUser;
}

const bool testDiscoverUsers = false;

void main() async {
  LoggedInUser loggedInUser = await getLoggedInUser();

  if (testDiscoverUsers) {
    DiscoverUsers discoverUsers = LocalitySocialCloud.discoverUsers();

    discoverUsers.addListener(() {
      for (int i = 0; i < discoverUsers.discoveredUsers.length; i++) {
        print("Discovered user with id ${discoverUsers.discoveredUsers[i].id}");
        print("And public key ${discoverUsers.discoveredUsers[i].publicKey}");
      }
    });

    discoverUsers.startingWith("Malti");
    // 如果我们不结束这个程序，程序将在结果未知之前终止
    await Future.delayed(const Duration(milliseconds: 1000));
  }

  DirectMessagesChat chat = await DirectMessagesFacade.getTargetUserChat(
      loggedInUser,
      LocalityUser("testuser2",
          "6a090d80590af1852ff0540a2a370fa209e2662e9d7ccaeb9b704d014cc92b8e69a4cf0695284983040c22d511e46f68f9e8e0c19d3ccd19203d028cf6bdf264/6dfde80699b9e231d90a1a81cc4c5fa60f93de3f7d216a9616a7c8c9dfc686beeb23884cefb2b9f0b45cd264f0f0aa82bd518081056e73dd634e132084d5218d"));

  chat.sendMessage({
    'content': "Hello World sdf dsf !!",
  });
  chat.sendMessage({
    'content': "Hello World! dsfsd fdsf !",
  });
  chat.sendMessage({
    'content': "Hello World!!",
  });

  /// 它是一个限流器，所以它最多每秒调用120次notifyListeners，以批量方式将状态变化转移到渲染引擎。
  chat.addListener(() {
    print("LOOK! IT IS THROTTLED!");
  });

  GroupChats.getInstance().addListener(() {
    List<GroupChat> groupChats = GroupChats.getInstance().groupChats;
    for (GroupChat groupChat in groupChats) {
      print("We are connected to the groupchat ... " + groupChat.title);
    }
  });

  /// 这将在本地时间线与全局时间线同步后被调用。
  chat.timeline.whenSynchronized(() {
    for (var chatMessage in chat.chatMessages) {
      String messageUuid = chatMessage.payload['message_uuid'];
      MessageObserver chatMessageObserver =
          chat.messageObserversByChatMessageUUID[messageUuid]!;
      chatMessageObserver.addListener(() {
        print(
            "MESSAGE ${messageUuid.substring(0, 12)}... received a like. Likecounter: ${chatMessageObserver.reactions.length}");
      });
      print("CHAT MESSAGE ${chatMessage.payload}");
      if (Random().nextInt(25) > 12) {
        chat.reactToMessage(messageUuid, 'like');
      }
    }
  });

  // 我们不知道何时可以停止程序。在实践中，UI会永远运行。
  await Future.delayed(const Duration(milliseconds: 10000));
}