Flutter即时通讯插件sop_cometchat的使用

sop_cometchat

sop_cometchat 是一个用于 Flutter 的即时通讯插件项目。它提供了跨平台的即时通讯功能，支持 Android 和 iOS 平台。

使用步骤

以下是使用 sop_cometchat 插件的基本步骤：

1. 添加依赖

在项目的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  sop_cometchat: ^1.0.0

然后运行以下命令以更新依赖：

flutter pub get

2. 初始化插件

在应用启动时初始化插件。通常在 main.dart 中进行初始化。

import 'package:flutter/material.dart';
import 'package:sop_cometchat/sop_cometchat.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: ChatPage(),
    );
  }
}

class ChatPage extends StatefulWidget {
  [@override](/user/override)
  _ChatPageState createState() => _ChatPageState();
}

class _ChatPageState extends State<ChatPage> {
  [@override](/user/override)
  void initState() {
    super.initState();
    // 初始化插件
    CometChat.init("your_app_id", "your_region");
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("CometChat 示例"),
      ),
      body: Center(
        child: Text("CometChat 已初始化！"),
      ),
    );
  }
}

3. 登录用户

在用户登录之前，需要调用 login 方法。假设我们有一个用户名和用户 ID。

Future<void> login(String uid) async {
  try {
    await CometChat.login(uid);
    print("用户登录成功！");
  } catch (e) {
    print("登录失败: $e");
  }
}

在按钮点击事件中调用登录方法：

ElevatedButton(
  onPressed: () {
    login("testUser1"); // 替换为实际的用户 ID
  },
  child: Text("登录"),
)

4. 发送消息

登录成功后，可以发送消息给其他用户或群组。

Future<void> sendMessage(String receiverUid, String messageText) async {
  try {
    CometChatMessage message = CometChatMessage(
      receiverId: receiverUid,
      messageType: CometChatMessage.RECEIVER_TYPE_USER,
      text: messageText,
    );

    CometChat.sendMessage(message).then((sentMessage) {
      print("消息已发送: ${sentMessage.text}");
    }).catchError((error) {
      print("发送消息失败: $error");
    });
  } catch (e) {
    print("发送消息失败: $e");
  }
}

在按钮点击事件中调用发送消息方法：

ElevatedButton(
  onPressed: () {
    sendMessage("testUser2", "你好，这是测试消息！");
  },
  child: Text("发送消息"),
)

5. 接收消息

为了接收消息，需要监听消息事件。

[@override](/user/override)
void initState() {
  super.initState();

  // 监听消息事件
  CometChat.addMessageListener("messageListenerId", (message) {
    print("接收到新消息: ${message.text}");
  });
}

完整示例代码

以下是完整的示例代码，展示了如何使用 sop_cometchat 插件实现基本的即时通讯功能。

import 'package:flutter/material.dart';
import 'package:sop_cometchat/sop_cometchat.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: ChatPage(),
    );
  }
}

class ChatPage extends StatefulWidget {
  [@override](/user/override)
  _ChatPageState createState() => _ChatPageState();
}

class _ChatPageState extends State<ChatPage> {
  final TextEditingController _controller = TextEditingController();

  [@override](/user/override)
  void initState() {
    super.initState();
    // 初始化插件
    CometChat.init("your_app_id", "your_region");

    // 监听消息事件
    CometChat.addMessageListener("messageListenerId", (message) {
      print("接收到新消息: ${message.text}");
    });
  }

  Future<void> login(String uid) async {
    try {
      await CometChat.login(uid);
      print("用户登录成功！");
    } catch (e) {
      print("登录失败: $e");
    }
  }

  Future<void> sendMessage(String receiverUid, String messageText) async {
    try {
      CometChatMessage message = CometChatMessage(
        receiverId: receiverUid,
        messageType: CometChatMessage.RECEIVER_TYPE_USER,
        text: messageText,
      );

      CometChat.sendMessage(message).then((sentMessage) {
        print("消息已发送: ${sentMessage.text}");
      }).catchError((error) {
        print("发送消息失败: $error");
      });
    } catch (e) {
      print("发送消息失败: $e");
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("CometChat 示例"),
      ),
      body: Column(
        children: [
          ElevatedButton(
            onPressed: () {
              login("testUser1"); // 替换为实际的用户 ID
            },
            child: Text("登录"),
          ),
          TextField(
            controller: _controller,
          ),
          ElevatedButton(
            onPressed: () {
              if (_controller.text.isNotEmpty) {
                sendMessage("testUser2", _controller.text); // 替换为实际的接收者 ID
                _controller.clear();
              }
            },
            child: Text("发送消息"),
          ),
        ],
      ),
    );
  }
}