文档中心

本文介绍如何快速集成环信即时通讯 IM Android SDK 实现单聊。

实现原理

下图展示在客户端发送和接收一对一文本消息的工作流程。

前提条件

• Android Studio 3.0 或以上版本；
• Android SDK API 等级 21 或以上；
• Android 5.0 或以上版本的设备；
• 有效的环信即时通讯 IM 开发者账号和 App key，见 环信即时通讯云控制台 (opens new window)。

准备开发环境

本节介绍如何创建项目，将环信即时通讯 IM Android SDK 集成到你的项目中，并添加相应的设备权限。

1. 创建 Android 项目

参考以下步骤创建一个 Android 项目。

1. 打开 Android Studio，点击 Start a new Android Studio project。
2. 在 Select a Project Template 界面，选择 Phone and Tablet > Empty Activity，然后点击 Next。
3. 在 Configure Your Project 界面，依次填入以下内容：
   • Name：你的 Android 项目名称，如 HelloWorld。
   • Package name：你的项目包的名称，如 com.hyphenate.helloworld。
   • Save location：项目的存储路径。
   • Language：项目的编程语言，如 Java。
   • Minimum API level：项目的最低 API 等级。

然后点击 Finish。根据屏幕提示，安装所需插件。

上述步骤使用 Android Studio 3.6.2 示例。你也可以直接参考 Android Studio 官网文档 创建首个应用 (opens new window)。

2. 集成 SDK

选择如下任意一种方式将环信即时通讯 IM SDK 集成到你的项目中。

方法一：使用 mavenCentral 自动集成

该方法仅适用于 v3.8.2 或以上版本。

1. 在项目的 build.gradle 中添加 mavenCentral()仓库。

buildscript {
    repositories {
        ...
        mavenCentral()
    }
    ...
}

allprojects {
    repositories {
        ...
        mavenCentral()
    }
}

1. 在 module 的 build.gradle 中添加如下依赖：

...
dependencies {
    ...
    // x.y.z 请填写具体版本号，如：3.9.4。
    // 可通过 SDK 发版说明获得最新版本号。
    implementation 'io.hyphenate:hyphenate-chat:x.x.x'
}

获取最新SDK的版本号：SDK 更新日志

implementation 'io.hyphenate:hyphenate-sdk:3.7.5' // 完整版本，包含音视频功能

implementation 'io.hyphenate:hyphenate-sdk-lite:3.7.5' // 精简版，只包含IM功能

方法二：手动复制 SDK 文件

打开 SDK 下载页面，获取最新版的环信即时通讯 IM Android SDK，然后解压。

将 SDK 包内 libs 路径下的如下文件，拷贝到你的项目路径下：

如果对生成的 apk 大小比较敏感，我们建议使用 jar 方式，并且手工拷贝 so，而不是使用 Aar，因为 Aar 方式会把各个平台的 so 文件都包含在其中。采用 jar 方式，可以仅保留一个 ARCH 目录，建议仅保留 armeabi-v7a，这样虽然在对应平台执行的速度会降低，但是能有效减小 apk 的大小。

3. 添加项目权限

根据场景需要，在 /app/src/main/AndroidManifest.xml 文件中添加如下行，获取相应的设备权限：

关于 App Key 对应的 value 获取，在 环信即时通讯 IM 管理后台 (opens new window)创建应用后，申请 App Key 并进行相关配置。

4. 防止代码混淆

在 app/proguard-rules.pro 文件中添加如下行，防止混淆 SDK 的代码：

-keep class com.hyphenate.** {*;} -dontwarn  com.hyphenate.** 

实现单聊

本节介绍如何实现单聊。

1. SDK 初始化

在主进程中进行初始化：

EMOptions options = new EMOptions(); options.setAppKey("Your appkey"); ......// 其他 EMOptions 配置。 

EMClient.getInstance().init(context, options); 

2. 创建账号

可以使用如下代码创建账户：

// 注册失败会抛出 HyphenateException。 // 同步方法，会阻塞当前线程。 

EMClient.getInstance().createAccount(mAccount, mPassword); 

3. 登录账号

使用如下代码实现用户登录：

EMClient.getInstance().login(mAccount, mPassword, new EMCallBack() { // 登录成功回调 @Override

 public void onSuccess() { } // 登录失败回调，包含错误信息 

@Override public void onError(final int code, final String error) { } @Override public void onProgress(int i, String s) { } }); 

4. 发送一条单聊消息

// `content` 为要发送的文本内容，`toChatUsername` 为对方的账号。 EMMessage message =

 EMMessage.createTxtSendMessage(content, toChatUsername); // 发送消息 EMClient.getInstance().chatManager().

sendMessage(message);