搜索插件、代码仓与 APP 分类

插件详情v0.1.2

flutter_mqchat

MqChat 客户端,此包使您能够使用 MQTT 协议作为聊天协议,代理服务器应实现 HiveMq-Chat-Extension 规范。

AndroidiOSmacOSWindowsLinux
近 30 天下载
48
喜欢数
15
Pub 分数
125

安装插件

flutter pub add flutter_mqchat

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

FlutterMQChat 是一个 Flutter 包,可使用 MQTT 协议实现实时聊天功能,专为支持 HiveMQ-Chat-Extension 规范的代理服务器设计。它通过抽象 MQTT 复杂性,简化了双向消息传递,非常适合轻量级、低延迟的聊天应用。该包支持 Android、iOS、macOS、Windows 和 Linux 等多个平台,确保跨平台一致性。对于需要即时消息传递且开销极小的应用程序尤其有用。

适合场景

  • 实时消息应用
  • 基于物联网的聊天系统
  • 跨平台聊天客户端
  • 低延迟通信
  • 协作工具

主要特点

  • 基于MQTT的聊天协议
  • HiveMQ-Chat-Extension 兼容
  • 多平台支持
  • 消息处理的简单 API
  • 轻便高效

适合对象

  • 开发实时聊天功能的开发者
  • 在基础设施中使用 MQTT 的团队
  • 需要可扩展消息传递的应用程序
  • 针对多个操作系统的项目
  • 物联网或嵌入式聊天应用

使用建议

  • 需要一个带有 HiveMQ-Chat-Extension 的代理
  • 仅限支持 MQTT 的环境
  • 无内置用户认证
  • 依赖外部代理设置
  • 不适用于高安全聊天,除非采取额外措施

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Flutter client of MqChat, a protocol built over MQTT for chatting purposes.

The Broker should install HiveMQ Chat-Extension first.

Features

Use MQTT as a chat protocol, to create a modern chat application that supports all needed features. This is a flutter client of MqChat.

  • [x] Login
  • [x] Send/receive messages (text, image, vide, location, document, contact messages)
  • [x] Send Files
  • [x] Typing indicators
  • [x] Presence
  • [x] Group Chat
  • [x] Private Chat invitation

Getting started

Install the package flutter-mqchat:

flutter pub add flutter-mqchat

Usage

A full and rich example can be found in /example folder.

1. Login

User login using an existing account:

bool connected = await ChatApp.instance()!.clientHandler.connect(
        host: "broker.url.com",
        username: "user@test.com",
        password: "user_pass");

After a successful login, the mqtt client will receive updates. The first updates to be received are profile details, rooms that users is member of, ongoing invitations and messages (if message archiving is supported by the broker).

2. Listen to my profile changes
ChatApp.instance()!.archiveHandler.getUser().listen((user) {
      //insert/update user to database
    });
3. Listen to rooms

Whenever the logged in user is added to a room (or room details changed), the room details will be added to the Conversations stream.

ChatApp.instance()!.archiveHandler.getAllConversations().listen((rooms) {
      //insert/update rooms on the Database
    });
4. Listen to new messages
ChatApp.instance()!.messageReader.getChatMessages().listen((message) {
      var dbMessage = message.toDbMessage();
      // insert the message to the database
      // send chatmarker if the message is not mine
    });
5. Listen to ChatMarkers
ChatApp.instance()!
        .messageReader
        .getChatMarkerMessages()
        .listen((markerMessage) {

      String messageId = markerMessage.referenceId;
      if (markerMessage.status == ChatMarker.displayed) {
          //update the database record
      } else if (markerMessage.status == ChatMarker.delivered) {
          //update the database record
      }
    });
6. Listen to new chat invitations
ChatApp.instance()!
        .invitationHandler
        .newInvitationsStream()
        .listen((invitation) {
          if(invitation.type == MessageType.EventInvitationRequest) {
            //new invitation request
            //insert invitation record to the database, notify the user
          }
          if(invitation.type == MessageType.EventInvitationResponseAccept || invitation.type == MessageType.EventInvitationResponseReject) {
            //responded to invitation, update the local record and wait the server to sync the new contact (if accepted).
            //Do not insert a room, the user will receive a new room details triggered by getAllConversations()
          }
    });
7. Listen to invitatioin updates

We use this to listen to the invitations that the user has sent. It could be:

  • Info: When receive an affirmation that the invitation is sent
  • Error: When there is an error (like the user is not found)
ChatApp.instance()!
        .invitationHandler
        .invitationUpdatesStream()
        .listen((invitation) {
      if (invitation.invitationMessageType == InvitationMessageType.INFO) {
       //update the invitation record to be confirmed
      }
      else if (invitation.invitationMessageType == InvitationMessageType.ERROR) {
        //notify the user, and delete the record in inserted
      }
    });
8. Send a text Message
ChatMessage newMessage = ChatMessage(
        id: "generated_random_id",
        type: MessageType.ChatText,
        text: "Hello there",
        roomId: "[room_id]",
        fromId: "[my_id]",//optional
        sendTime: DateTime.now().millisecondsSinceEpoch,
        fromName: "[my_name]");
8.1 Send the message as regular message
ChatApp.instance()!
          .messageSender
          .sendChatMessage(newMessage, "[room_id]");
8.2 Send the message as a reply to another message
ChatMessage replyToMessage = ...; //the message to reply to
ChatApp.instance()!
          .messageSender
          .replyToMessage(replyToMessage, newMessage, widget.contactChat.roomId);
9. Send File Message
 ChatApp.instance()!.messageSender.sendFileChatMessage(
          type: MessageType.ChatImage,//for example
          fileLocalPath: path,
          room: "[room_id]");
10. Send typing indicator
ChatApp.instance()!
          .eventsSender
          .sendIsTyping(true, "[room_id]");
11. Listen to typing indicator
ChatApp.instance()!.messageReader.getTypingMessages().listen((event) {
    //using event.roomId and event.isTyping and event.fromId, update the ui state
    
    });
12. Send new chat invitation
ChatApp.instance()!
        .eventsSender
        .sendInvitation("[invitee_username]", "[invitation_random_id]");

Additional information

TODO: Tell users more about the package: where to find more information, how to contribute to the package, how to file issues, what response they can expect from the package authors, and more.

所属分类

依赖

依赖清单 6 项

源码仓库

使用此插件的项目

暂无相关数据。