跳到主要内容

导入 SDK

利用 Android Studio 中的 Gradle 构建系统，您可以轻松地将融云即时通讯界面库（IMKit）作为依赖项添加到您的构建中。

融云支持使用 Gradle 添加远程依赖项、导入本地库模块（Module）和导入源码三种方式，将 IMKit SDK 导入到您的应用工程中。

环境要求​

  • （SDK ≧ 5.6.3）使用 Android 5.0（API 21）或更高版本
  • （SDK < 5.6.3）使用 Android 4.4（API 19）或更高版本

检查版本​

在导入 SDK 前，您可以前往融云官网 SDK 下载页面确认当前最新版本号。

Gradle​

使用 Gradle，添加融云即时通讯界面库（IMKit）为远程依赖项。Android Studio 的配置在 Gradle 插件 7.0 以下版本、7.0 版本、和 7.1 及以上版本有所不同。请根据您当前的 Gradle 插件版本进行配置。本文以使用 Gradle 插件 7.0 以下版本为例。

由于 Jcenter 于2021年 5 月 4 日 停止提供远程仓库服务，远程仓库统一由 JCenter 迁移到新的融云私有仓库。

不再支持该地址集成：https://dl.bintray.com/rongcloud/maven。

  1. 声明融云的 Maven 代码库，以使用 Gradle 插件 7.0 以下版本为例。打开根目录下的 build.gradle（Project 视图下）：

    allprojects {
        repositories {
            ...
            //融云 maven 仓库地址
            maven {url "https://maven.rongcloud.cn/repository/maven-releases/"}
        }
    }

  2. 在应用的 build.gradle 中，添加融云即时通讯界面库（IMKit）为远程依赖项。

    dependencies {
        ...
    	//此处以集成 IMKit 库为例，您可以按需集成插件
        api 'cn.rongcloud.sdk:im_kit:x.y.z'
    }
    提示

    各个 SDK 的最新版本号可能不相同，还可能是 x.y.z.h，可前往 融云官网 SDK 下载页面 或 融云的 Maven 代码库 查询。

Android 本地库模块 (Module)​

在导入 SDK 前，您需要前往融云官网 SDK 下载页面，将 即时通讯界面库 IMKit 下载到本地。

  1. 在 Android Studio 中打开工程后，依次点击 File > New > Import Module，找到下载的 Module 组件并导入。

  2. 如果导入的内容中包含有插件的 aar 包，请移至 app/libs 目录下。

  3. 打开根目录下的 settings.gradle（Project 视图下），添加 IMLib 本地库模块。

    include ':IMKit'
    include ':IMLib'
    ...

  4. 在应用的 build.gradle 中，添加 IMLib 为本地库模块依赖项。

    dependencies {
        ...
        api project(':IMLib')
        ...
    }

  5. (可选) 以 Android 本地库模块导入 SDK 时默认不带 Javadoc。建议自行从融云的 Maven 代码库下载 Javadoc 并导入，以便于在 Android Studio 中即时查看。

    如需指导，请参见以下知识库链接：

    https://help.rongcloud.cn/t/topic/727

源代码方式​

在导入 SDK 前，请先下载融云开源工程（GitHub · Gitee）到本地。

融云开源工程地址中 imkit 文件夹下的代码即为 IMKit SDK 的源码。

  1. 拷贝 imkit 模块到您的工程。

  2. 打开根目录下的 settings.gradle（Project 视图下），添加 IMKit 本地库模块。

    include ':imkit'

  3. 声明融云的 Maven 代码库，以使用 Gradle 插件 7.0 以下版本为例。打开根目录下的 build.gradle（Project 视图下）：

    allprojects {
        repositories {
            ...
            //融云 maven 仓库地址
            maven {url "https://maven.rongcloud.cn/repository/maven-releases/"}
        }
    }

  4. 在应用的 build.gradle 中，添加融云即时通讯界面库（IMKit）为依赖项。

    api project(':imkit')

  5. (可选) 以源代码导入 SDK 时默认不带 Javadoc。建议自行从融云的 Maven 代码库下载 Javadoc 并导入，以便于在 Android Studio 中即时查看。

    如需指导，请参见以下知识库链接：

    https://help.rongcloud.cn/t/topic/727

最后于 更新