Flutter即时通讯插件rongcloud_im_wrapper_plugin的使用

Flutter即时通讯插件rongcloud_im_wrapper_plugin的使用

本教程是为了让新手快速了解融云 Flutter 即时通讯能力库。在本教程中，您可以体验集成 SDK 的基本流程和基础通信能力。

融云开发者账户

融云开发者账户是使用融云 SDK 产品的必要条件。

在开始之前，请先[前往融云官网注册开发者账户]。注册后，开发者后台将自动为您创建一个应用，默认为开发环境应用，使用国内数据中心。请获取该应用的 App Key，在本教程中使用。

App Secret 用于生成数据签名，仅在请求融云服务端 API 接口时使用。本教程中暂不涉及。

如果您已拥有融云开发者账户，您可以直接选择合适的环境，创建应用。

应用的 App Key / Secret 是获取连接融云服务器身份凭证的必要条件，请注意不要泄露。

导入 SDK

1. 在项目的 pubspec.yaml 中添加依赖

dependencies:
  flutter:
    sdk: flutter

  rongcloud_im_wrapper_plugin: 5.12.1+1

1. 在项目路径执行 flutter pub get 来下载相关插件

初始化

1. 使用 SDK 功能前，需要 import 下面的头文件

import 'package:rongcloud_im_wrapper_plugin/rongcloud_im_wrapper_plugin.dart';

1. 开发者在使用融云 SDK 所有功能之前，开发者必须先调用此方法初始化 SDK 并配置相关引擎参数。

RCIMIWEngineOptions options = RCIMIWEngineOptions.create();
RCIMIWEngine engine = await RCIMIWEngine.create(appkey, options);

注意：请使用开发功能之前从融云开发者后台注册得到的 Appkey

连接融云

1. Token 即用户令牌，相当于您 APP 上当前用户连接融云的身份凭证。在您连接融云服务器之前，您需要请求您的 App Server，您的 App Server 通过融云 Server API 获取 Token 并返回给您的客户端，客户端获取到这个 Token 即可连接融云服务器。

2. timeout 连接超时时间，单位：秒。

注：如果 code == 31004 即过 Token 无效，是因为您在开发者后台设置了 Token 过期时间或者 Token 和初始化的 AppKey 不同环境，您需要请求您的服务器重新获取 Token 并再次用新的 Token 建立连接。

engine.connect(
  token,
  timeout,
);

engine.onConnected = (
  int? code,
  String? userId,
) {
  // 处理连接成功后的逻辑
};

监听消息

实现此功能需要开发者实现消息监听回调。

代码示例

设置消息接收监听器，用于接收所有类型的实时或者离线消息。

engine.onMessageReceived = (
  RCIMIWMessage? message,
  int? left,
  bool? offline,
  bool? hasPackage,
) {
  // 处理接收到的消息
};

发送消息

RCIMIWTextMessage? textMessage = await engine.createTextMessage(
  conversationType,
  targetId,
  channelId,
  text,
);

engine.sendMessage(textMessage);

监听消息发送结果

engine.onMessageAttached = (
  RCIMIWMessage? message,
) {
  // 处理消息附着的结果
};

engine.onMessageSent = (
  int? code,
  RCIMIWMessage? message,
) {
  // 处理消息发送的结果
};

退出登录

engine.disconnect(receivePush);

引擎销毁

engine.destroy();

完整示例Demo

以下是一个完整的示例代码，展示了如何使用 rongcloud_im_wrapper_plugin 插件进行即时通讯的基本操作：

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(MyApp());
}

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

class _MyAppState extends State<MyApp> {
  RCIMIWEngine? engine;

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

  Future<void> initSDK() async {
    final options = RCIMIWEngineOptions.create();
    engine = await RCIMIWEngine.create('YOUR_APP_KEY', options);

    engine?.onConnected = (int? code, String? userId) {
      if (code == 0) {
        print('Connected as user $userId');
      } else {
        print('Connection failed with code $code');
      }
    };

    engine?.onMessageReceived = (
      RCIMIWMessage? message,
      int? left,
      bool? offline,
      bool? hasPackage,
    ) {
      if (message != null) {
        print('Received message: ${message.content}');
      }
    };
  }

  Future<void> connectToRongCloud(String token) async {
    try {
      await engine?.connect(token, 10); // 10 seconds timeout
    } catch (e) {
      print('Failed to connect: $e');
    }
  }

  Future<void> sendMessage(String text, String targetId) async {
    final message = await engine?.createTextMessage(
      RCConversationType.Private, // Conversation type
      targetId,
      null,
      text,
    );

    if (message != null) {
      await engine?.sendMessage(message);
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('RongCloud IM Example')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () async {
                  await connectToRongCloud('YOUR_TOKEN');
                },
                child: Text('Connect'),
              ),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: () async {
                  await sendMessage('Hello, RongCloud!', 'targetUserId');
                },
                child: Text('Send Message'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}