实现单聊消息收发 - IM 即时通讯

IM 即时通讯

含 UI 集成

不含 UI 集成

圈组功能

实现单聊消息收发

更新时间： 2023/03/03 11:20:30

网易云信 IM 即时通讯服务提供一整套即时通讯基础能力，助您快速实现多样化的即时通讯场景。

本文主要介绍通过集成 NetEase IM SDK（NIM SDK）并调用 API，快速实现单聊消息收发功能。

群聊消息收发需要先进入群组，后续流程与单聊消息收发相同。
超大群、聊天室和圈组的消息收发，需单独配置。具体实现流程请分别参见超大群消息收发、聊天室消息收发和圈组消息收发。

使用前准备

开发环境满足如下条件：
- Android 4.4 及以上版本。
- v6.9.0 起，改用 AndroidX 支持库，Target API 改为 28，不再支持 support 库。
登录云信控制台完成以下操作。

创建应用并获取 App Key 和 App Secret
1. 在左侧导航栏中找到“应用”，并单击“创建”。

2. 填写应用的基本信息后，单击“创建”。

3. 创建应用后，可以在左侧导航栏中查看该应用，并单击 “App Key 管理”，并获取 App Key 和 App Secret。

注册云信 IM 账号，获取 accid 和 token

注册云信 IM 账号，获取 accid 和 token。accid 和 token 将用于登录云信服务端。
1. 在左侧导航栏中单击指定应用名称，进入该应用的详情页面。
2. 在“功能管理”中单击“账号管理”。

3. 在测试页面，单击“新建账号”，并填写账号（即accid）、昵称（即 name）、密码（即 Token）后，单击“确定”。

实现流程

流程概览

实现单聊消息收发的流程，可分为下图所示的 4 大步骤。

快速实现消息收发.png

步骤 1：集成 SDK

本文主要介绍在 Gradle 中添加远程依赖项的集成方式。手动集成方式请参见 SDK 集成。

Gradle 集成

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

创建 Android 项目成功后，Android Studio 会自动开始同步 gradle, 您需要等同步成功后再进行下一步操作。
在项目根目录下的 “build.gradle” 文件中，配置 repositories（使用 maven）。示例代码如下：
```
allprojects {
    repositories {
        mavenCentral()
    }
}
```

在 “app” 目录下的 “build.gradle” 文件中，配置支持的 SO 库架构。示例代码如下：

android {
defaultConfig {
    ndk {
        //设置支持的SO库架构
        abiFilters "armeabi-v7a", "x86","arm64-v8a","x86_64"
        }
}
}

根据开发者项目的需求，添加对应的依赖。

可在 SDK 更新日志中查看最新的版本。

dependencies {
    implementation fileTree(dir: 'libs', include: '*.jar')
    // 添加依赖
    
    // 基础功能 (必需)
    implementation "com.netease.nimlib:basesdk:${LATEST_VERSION}"
}

添加权限

根据实际应用需求，在 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" />
    <application
        ...>
    <!-- APP Key, 可以在这里设置，也可以在 SDKOptions 中提供。
            如果 SDKOptions 中提供了，则取 SDKOptions 中的值。 -->
        <meta-data
            android:name="com.netease.nim.appKey"
            android:value="key_of_your_app" />
    </application>
</manifest>

更多权限设置，请参见添加权限。

防止代码混淆

代码混淆是指使用简短无意义的名称重命名已存在的类、方法、属性等，增加逆向工程的难度，保障 Android 程序源码的安全性。

为了避免因上述的重命名而导致调用 NIM SDK 异常，请在 proguard-rules.pro 文件中加入以下代码，将 NIM SDK 相关类加入不混淆名单。

-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：初始化 SDK

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

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

在 Application 的 onCreate 中，调用 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 服务器。

若仅需要调试，可使用在云信控制台注册的云信账号进行登录；若处于正式生产环境，请使用通过 IM 服务端 API 生成的正式 IM 账号（accid）和 token。

建议参考IM 登录最佳实践实现 IM 登录以及相应的上层应用逻辑。

调用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：单聊消息收发

本节以用户 A 和用户 B 的消息交互为例，介绍快速实现单聊消息收发的流程。更多消息类型的收发，请参见消息收发。

用户 B 调用observeReceiveMessage方法监听消息接收。示例代码如下：

Observer<List<IMMessage>> incomingMessageObserver =
        new Observer<List<IMMessage>>() {
            @Override
            public void onEvent(List<IMMessage> messages) {
                // 处理新收到的消息，为了上传处理方便，SDK 保证参数 messages 全部来自同一个聊天对象。
            }
        };
    NIMClient.getService(MsgServiceObserve.class)
            .observeReceiveMessage(incomingMessageObserver, true);

用户 A 调用 createTextMessage 方法构建文本消息，然后调用 sendMessage方法向用户 B 发送文本消息。示例代码如下：

//这里主要以发送文本消息为例
    String account = "testAccount";
    SessionTypeEnum sessionType = SessionTypeEnum.P2P; // 以单聊类型为例
    String text = "this is an example";// 创建一个文本消息
    IMMessage textMessage = MessageBuilder.createTextMessage(account, sessionType, text);
    // 发送给对方
    NIMClient.getService(MsgService.class).sendMessage(textMessage, false).setCallback(new RequestCallback<Void>() {
                    @Override
                    public void onSuccess(Void param) {
                    }
                    @Override
                    public void onFailed(int code) {                        
                    }
                    @Override
                    public void onException(Throwable exception) {
                    }
                });

目前 NIM SDK 支持多种消息类型，包括文本消息、图片消息、语音消息、视频消息、文件消息、地理位置消息、提示消息、通知消息以及自定义消息。具体请参见消息收发。

observeReceiveMessage 方法的 Observer 接口根据实际情况触发回调函数，用户 B 收到文本消息。

后续步骤

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

此文档是否对你有帮助？

有帮助

我要吐槽

文档反馈

在线咨询

使用前准备
实现流程
流程概览
步骤 1：集成 SDK
Gradle 集成
添加权限
防止代码混淆
步骤 2：初始化 SDK
步骤 3：登录 IM 服务端
步骤 4：单聊消息收发
后续步骤