IM 即时通讯
Android
新手接入指南
产品介绍
简介
主要功能
产品优势
海外数据中心
接口及业务限制
功能介绍
帐号集成与登录
群组功能
聊天室功能
聊天室标签功能
圈组功能
多端登录与互踢策略
质量数据监控台
更新日志
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能列表
快速集成 IM UIKit
组件导入
初始化
界面跳转
自定义用户信息
全局配置
IM UIKit API 概览
会话列表相关
集成会话列表界面
会话列表事件监听
自定义会话列表界面 UI
会话列表 API 概览
会话消息相关
集成会话界面
会话界面事件监听
实现自定义消息发送(含 UI)
自定义会话界面 UI
会话消息 API 概览
通讯录相关
集成通讯录界面
自定义通讯录界面 UI
通讯录界面事件监听
通讯录 API 概览
不含 UI 集成
使用说明
集成与初始化
登录管理
消息相关
消息概述
消息收发
自定义消息收发
消息配置选项
多媒体资源存储场景
广播消息收发
消息已读回执
消息撤回
消息重发与转发
消息更新
消息过滤
语音消息处理
插入本地消息
历史消息
最近会话
服务端会话服务
用户资料
用户关系
在线状态订阅
系统通知
离线推送与消息提醒
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
聊天室
圈组功能
登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
频道未读数管理
实时互动频道
频道分组
频道分组黑白名单
搜索服务器和频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
用户定制权限
频道分组身份组
自定义权限
成员权限查询与判定
身份组相关查询
圈组订阅机制
消息相关
图解圈组消息流转
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
会话消息回复(Thread)
圈组快捷评论
消息正在输入
获取频道最后一条消息
查询历史消息
圈组消息缓存
圈组消息搜索
系统通知
圈组离线推送
圈组内容审核
圈组相关抄送
圈组第三方回调
反垃圾
聊天扩展
其他
最佳实践
IM 应用隐私合规
聊天室重要消息投递
API 参考
Android API 参考
Android 端状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
常见问题
FAQ
错题集
Android 端推送问题排查
服务协议

实现圈组消息收发

更新时间: 2022/11/23 17:26:40

圈组是网易云信 IM 即时通讯服务的全新能力,可用来帮助您快速构建 “类 Discord 即时通讯社群”。本文介绍如何通过较少的代码集成 NetEase IM SDK (以下简称 NIM SDK)并调用 API,在您的应用中实现圈组消息收发。

使用前准备

  • 联系商务经理开通圈组试用权限。如尚未开通,您可通过云信官网首页右侧提供的微信和电话等联系方式咨询商务经理开通。

  • 登录云信控制台完成以下操作。


    创建应用并获取 App Key 和 App Secret 1. 在左侧导航栏中找到“应用”,并单击“创建”。
    创建应用
    2. 填写应用的基本信息后,单击“创建”。
    创建应用
    3. 创建应用后,可以在左侧导航栏中查看该应用,并单击 “App Key 管理”,并获取 App Key 和 App Secret。
    查看应用的AppKey
    注册云信 IM 账号,获取 accid 和 token

    注册云信 IM 账号,获取 accid 和 token。accid 和 token 将用于登录云信服务端。

    1. 在左侧导航栏中单击指定应用名称,进入该应用的详情页面。
    2. 在“功能管理”中单击“账号管理”。
    账号管理
    3. 在测试页面,单击“新建账号”,并填写账号(即accid)、昵称(即 name)、密码(即 Token)后,单击“确定”。
    确定

实现流程

流程概览

实现圈组消息收发的流程,可分为下图所示的 5 大步骤。

下图可能因为网络问题无法正常展示。如遇到该问题,一般刷新页面即可正常展示。

uml diagram

圈组服务端圈组服务器是两个不同概念,前者指云信服务端提供圈组功能的部分,后者为圈组的特殊概念,对应 Discord 的 Server, 为社群本身,具体参见圈组主要概念

步骤1: 集成 NIM SDK

本节仅介绍更为快速的 Gradle 自动集成方式。如需查看手动集成的具体说明,请参见手动集成

Gradle集成

  1. 若您需要创建新项目,在 Android Studio 里,在顶部菜单依次选择 File > New > New Project 新建工程,再依次选择 Phone and Tablet > Empty Activity,单击 Next
    image

    创建 Android 项目成功后,Android Studio 会自动开始同步 gradle, 您需要等同步成功后再进行下一步操作。

  2. 在项目根目录下的build.gradle文件中,配置repositories(使用 maven)。示例代码如下:

    allprojects {
        repositories {
            mavenCentral()
        }
    }
    
  3. 在主工程的 build.gradle 文件中,设置支持的 SO 库架构。

    android {
    defaultConfig {
        ndk {
            //设置支持的SO库架构
            abiFilters "armeabi-v7a", "x86","arm64-v8a","x86_64"
            }
    }
    }
    
  4. 在主工程的 build.gradle 文件中,添加必需的依赖:

    dependencies {
        implementation fileTree(dir: 'libs', include: '*.jar')
        // 添加依赖。注意,版本号必须一致。
        
        // IM基础功能 (必需)
        implementation "com.netease.nimlib:basesdk:${LATEST_VERSION}"
        // 通过云信来集成小米等厂商推送需要(可选)
        implementation "com.netease.nimlib:push:${LATEST_VERSION}"
    // 圈组功能(集成圈组必需)
    implementation "com.netease.nimlib:qchat:${LATEST_VERSION}"
    }
    

    SDK 的组件版本号必须一致,如圈组组件的版本号必须与其他组件的一致。可在SDK下载页面查看当前最新版本。

添加权限

根据实际应用需求,在 AndroidManifest.xml 中添加以下配置(请将 com.netease.nim.demo 替换为自己的包名),设置所需的权限。更多可添加的权限项,请参见初始化与集成

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
        package="com.netease.nim.demo">

    <!-- 权限声明 -->
    <!-- 访问网络状态-->
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    
    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE"/>
    
    
    <!-- 8.0+系统需要-->
    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
    
</manifest>

防止代码混淆

如果您的 APK 最终会经过代码混淆,请在proguard配置文件中加入以下代码防止混淆:

-dontwarn com.netease.nim.**
-keep class com.netease.nim.** {*;}

-dontwarn com.netease.nimlib.**
-keep class com.netease.nimlib.** {*;}

-dontwarn com.netease.share.**
-keep class com.netease.share.** {*;}

-dontwarn com.netease.mobsec.**
-keep class com.netease.mobsec.** {*;}

#如果你使用全文检索插件,需要加入
-dontwarn org.apache.lucene.**
-keep class org.apache.lucene.** {*;}

#如果你开启数据库功能,需要加入
-keep class net.sqlcipher.** {*;}

步骤2: 初始化 NIM SDK

将 SDK 集成到客户端后,需要先完成 SDK 的初始化才能使用其他功能。

v6.9.0 起,改用 AndroidX 支持库,Target API 改为 28,不再支持 support 库。

ApplicationonCreate 中,调用 init方法进行初始化。

示例代码如下:

public class NimApplication extends Application {
    public void onCreate() {
        NIMClient.init(this, loginInfo(), options());
    // 如果提供用户信息,将同时进行自动登录。如果当前还没有登录用户,请传入null。
    private LoginInfo loginInfo() {
        return null;
    }
    // 设置初始化配置参数,如果返回值为 null,则全部使用默认参数。
    private SDKOptions options() {
        SDKOptions options = new SDKOptions();
        return options;
      }// 可在 SDKOptions 中配置 App Key
    }
}

以上提供了一个简化的初始化示例,更多初始化信息请参见初始化 SDK

步骤3: 登录云信 IM 服务端

登录圈组服务端前,必须先登录 IM 服务端。

  1. 调用observeOnlineStatus方法监听 IM 登录状态。

    示例代码如下:

    NIMClient.getService(AuthServiceObserver.class).observeOnlineStatus(
        new Observer<StatusCode> () {
            public void onEvent(StatusCode status) {
        //获取状态的描述
        String desc = status.getDesc();
                if (status.wontAutoLogin()) {
                    // 被踢出、账号被禁用、密码错误等情况,自动登录失败,需要返回到登录界面进行重新登录操作
                }
            }
    }, true);
    
    
  2. (可选)调用observeLoginSyncDataStatus方法监听登录后数据同步过程。

    如您仅需集成圈组功能,不需要 IM 其他组件的功能,可跳过这一步。

    示例代码如下:

    NIMClient.getService(AuthServiceObserver.class).observeLoginSyncDataStatus(new Observer<LoginSyncStatus>() {
        @Override
        public void onEvent(LoginSyncStatus status) {
            if (status == LoginSyncStatus.BEGIN_SYNC) {
                LogUtil.i(TAG, "login sync data begin");
            } else if (status == LoginSyncStatus.SYNC_COMPLETED) {
                LogUtil.i(TAG, "login sync data completed");
            }
        }
    }, true);
    
  3. 调用AuthService#login方法开始手动登录。

    示例代码如下:

    public class LoginActivity extends Activity {
        public void doLogin() {
            LoginInfo info = new LoginInfo(); //传入accid和token
            RequestCallback<LoginInfo> callback =
                new RequestCallback<LoginInfo>() {
                        @Override
                        public void onSuccess(LoginInfo param) {
                            LogUtil.i(TAG, "login success");
                            // your code
                        }
    
                        @Override
                        public void onFailed(int code) {
                            if (code == 302) {
                                LogUtil.i(TAG, "账号密码错误");
                                // your code
                            } else {
                                // your code
                            }
                        }
    
                        @Override
                        public void onException(Throwable exception) {
                            // your code
                        }
            };
    
            //执行手动登录
            NIMClient.getService(AuthService.class).login(info).setCallback(callback);
        }
    }
    
  4. 登录开始后,observeOnlineStatus方法的Observer接口根据实际登录情况触发回调函数,返回具体的登录状态。如最终返回LOGINED,则代表登录成功。

    具体登录状态及其变化流程,请参见登录状态转换

步骤4: 登录云信圈组服务端

  1. 发送方和接收方调用observeStatusChange方法监听圈组登录状态。

    示例代码如下:

    NIMClient.getService(QChatServiceObserver.class).observeStatusChange(new Observer<QChatStatusChangeEvent>() {
    @Override
    public void onEvent(QChatStatusChangeEvent qChatStatusChangeEvent) {
        //当前状态
        StatusCode status = qChatStatusChangeEvent.getStatus();
    }
    },true);
    
  2. 接收方调用QChatServiceObserver#observeReceiveMessage方法监听圈组消息接收。

    示例代码如下:

    NIMClient.getService(QChatServiceObserver.class).observeReceiveMessage(new Observer<List<QChatMessage>>() {
        @Override
        public void onEvent(List<QChatMessage> qChatMessages) {
            //收到消息qChatMessages
            for (QChatMessage qChatMessage : qChatMessages) {
                //处理消息
            }
        }
    }, true);
    
  3. 发送方和接收方调用QChatService#login方法开始登录圈组服务端。

    目前移动端仅支持非独立模式登录圈组服务端,即必须先登录 IM 服务端。

    示例代码如下:

    QChatLoginParam loginParam = new QChatLoginParam();
    NIMClient.getService(QChatService.class).login(loginParam).setCallback(new RequestCallback<QChatLoginResult>() {
    @Override
    public void onSuccess(QChatLoginResult result) {
        LogUtil.i(TAG, "login success");
        // your code
    }
    
    @Override
    public void onFailed(int code) {
        LogUtil.i(TAG, "login failed");
        // your code
    }
    
    @Override
    public void onException(Throwable exception) {
        // your code
    }
    });
    
  4. 登录后,observeStatusChange方法的Observer接口触发回调函数,根据实际登录情况返回登录状态。如最终返回LOGINED,则代表登录成功。

    圈组登录状态及其变化流程与 IM 的相同,具体请参见本文文末的登录状态变化流程

步骤5: 圈组消息收发

本节以发送方与接收方的消息交互为例,介绍在不考虑用户权限管理的情况下,使用 SDK API 快速实现圈组文本消息收发的流程。


  1. 发送方调用QChatServiceObserver#observeMessageStatusChange)方法监听圈组消息发送状态。

    示例代码如下:

    NIMClient.getService(QChatServiceObserver.class).observeMessageStatusChange(new Observer<QChatMessage>() {
        @Override
        public void onEvent(QChatMessage qChatMessage) {
            //收到状态变化的消息qChatMessage
            
        }
    }, true);
    
  2. 发送方调用createServer方法创建圈组服务器。为更加快速实现消息收发,创建时可将QChatInviteMode设置为AGREE_NEED_NOT(1)(发送邀请后,不需要被邀请方同意,被邀请方立即加入服务器)。

    创建成功后,需记录服务器的 ID(serverId),后续步骤将需要传入serverId


    示例代码如下:

    QChatCreateServerParam param = new QChatCreateServerParam("测试");
    param.setInviteMode(QChatInviteMode.AGREE_NEED_NOT);
    QChatAntiSpamConfig antiSpamConfig = new QChatAntiSpamConfig("用户配置的对某些资料内容另外的反垃圾的业务ID");//非必须,请按需配置
    param.setAntiSpamBusinessId(antiSpamConfig);//非必须,请按需配置
    NIMClient.getService(QChatServerService.class).createServer(param).setCallback(
            new RequestCallback<QChatCreateServerResult>() {
                @Override
                public void onSuccess(QChatCreateServerResult result) {
                    // 创建成功
                    QChatServer server = result.getServer();
                }
    
                @Override
                public void onFailed(int code) {
                    // 创建失败,返回错误code
                }
    
                @Override
                public void onException(Throwable exception) {
                    // 创建异常
                        }
            });
    
  3. 发送方调用createChannel方法,调用时传入上一步中创建的圈组服务器的serverId,且将QChatChannelModeQChatChannelType分别设置为PUBLICMessageChannel,从而在圈组服务器中创建一个消息类型的公开频道。

    创建成功后,需记录频道的 ID(channelId),后续步骤将需要传入channelId


    示例代码如下:

    //建立一个消息类型的频道
    QChatCreateChannelParam param = new QChatCreateChannelParam(943445L, "测试频道", QChatChannelType.MessageChannel);
    param.setCustom("自定义扩展");
    param.setTopic("主题");
    //设置频道为公开频道
    param.setViewMode(QChatChannelMode.PUBLIC);
    QChatAntiSpamConfig antiSpamConfig = new QChatAntiSpamConfig("用户配置的对某些资料内容另外的反垃圾的业务ID");
    param.setAntiSpamBusinessId(antiSpamConfig);
    NIMClient.getService(QChatChannelService.class).createChannel(param).setCallback(
            new RequestCallback<QChatCreateChannelResult>() {
                @Override
                public void onSuccess(QChatCreateChannelResult result) {
                    //创建Channel成功,返回创建成功的Channel信息
                    QChatChannel channel = result.getChannel();
                }
    
                @Override
                public void onFailed(int code) {
                    //创建Channel失败,返回错误code
                }
    
                @Override
                public void onException(Throwable exception) {
                    //创建Channel异常
                }
            });
    
  4. 发送方调用inviteServerMembers方法,邀请接收方 加入圈组服务器。

    示例代码如下:

    List<String> accids = new ArrayList<>();
    accids.add("test");
    QChatInviteServerMembersParam param = new QChatInviteServerMembersParam(943445L,accids);
    param.setPostscript("邀请你加入测试服务器");
    NIMClient.getService(QChatServerService.class).inviteServerMembers(param).setCallback(
            new RequestCallback<QChatInviteServerMembersResult>() {
                @Override
                public void onSuccess(QChatInviteServerMembersResult result) {
                    //邀请成功,会返回因为用户服务器数量超限导致失败的accid列表
                    List<String> failedAccids = result.getFailedAccids();
                }
    
                @Override
                public void onFailed(int code) {
                    //邀请失败,返回错误code
                }
    
                @Override
                public void onException(Throwable exception) {
                    //邀请异常
                }
            });
    
  5. 发送方调用QChatMessageService#sendMessage方法,调用时传入圈组服务器与公开频道的ID,从而在公开频道中发送一条消息。

    示例代码如下:

    QChatSendMessageParam param = new QChatSendMessageParam(943445L,885305L, MsgTypeEnum.text);
    param.setBody("测试消息");
    //通过QChatSendMessageParam构造一个QChatMessage
    QChatMessage currentMessage = param.toQChatMessage();
    
    NIMClient.getService(QChatMessageService.class).sendMessage(param).setCallback(new RequestCallback<QChatSendMessageResult>() {
        @Override
        public void onSuccess(QChatSendMessageResult result) {
            //发送消息成功,返回发送成功的消息具体信息
            QChatMessage message = result.getSentMessage();
        }
    
        @Override
        public void onFailed(int code) {
            //发送消息失败,返回错误code
        }
    
        @Override
        public void onException(Throwable exception) {
            //发送消息异常
        }
    });
    
  6. QChatServiceObserver#observeReceiveMessage方法的Observer接口触发回调函数,接收方通过该回调收到消息。

后续步骤

为保障通信安全,如果您在调试环境中的使用的是云信控制台生成的测试用 IM 账号 和 token,请确保在后续的正式生产环境中,将其替换为通过 IM 服务端 API 生成的正式 IM 账号(accid)和 token

圈组相关集成文档

此文档是否对你有帮助?
有帮助
我要吐槽
  • 使用前准备
  • 实现流程
  • 流程概览
  • 步骤1: 集成 NIM SDK
  • Gradle集成
  • 添加权限
  • 防止代码混淆
  • 步骤2: 初始化 NIM SDK
  • 步骤3: 登录云信 IM 服务端
  • 步骤4: 登录云信圈组服务端
  • 步骤5: 圈组消息收发
  • 后续步骤
  • 圈组相关集成文档