跑通示例源码

概览

本文介绍如何快速跑通示例源码，体验即时通讯服务。

准备环境

在开始跑通之前，请确保开发环境满足以下要求（以下说明皆以 macOS 开发电脑为例）：

Android Studio 2.1 或以上版本。
Android SDK 28、Android SDK Platform-Tools 28.x.x 或以上版本。
Android 4.1 或以上版本，且支持音视频的 Android 设备或模拟器（推荐使用真机），如果是真机，请开启“允许调试”选项。
Android 设备、macOS 开发电脑已经连接到 Internet。

说明

首次编译示例源码时，如果没有对应的依赖库或者构建工具，Android Studio 会自动下载示例源码，可能需要较长时间，请耐心等待。
建议下载特定的 gradle 及所需的依赖库，请参考 Gradle Services 下载。示例源码中使用的 gradle 相关版本如下：
- gradle：4.6（在 “project/gradle/wrapper/gradle-wrapper.properties” 文件中查看）。
- gradle Android 插件：3.2.1（在 “project/build.gradle” 文件中查看）。

前提条件

已在 ZEGO 控制台创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台自助开通 ZIM 服务（详情请参考控制台文档项目管理 - 即时通讯），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。

注意

2.3.0 及以上版本的 SDK，开始支持 “AppSign 鉴权”，同时仍支持 “Token 鉴权”，若您需要升级鉴权方式，可参考 ZIM 如何从 AppSign 鉴权升级为 Token 鉴权。

获取示例源码

示例源码

点击获得完整代码。

下列结构为 IM 源码文件的子目录结构，下文所涉及的文件路径均为相对于此目录的路径。

Untitled

.
├── app
│   ├── agconnect-services.json
│   ├── build
│   │   ├── generated
│   │   ├── intermediates
│   │   ├── outputs
│   │   └── tmp
│   ├── build.gradle
│   ├── libs
│   │   ├── MiPush_SDK_Client_4_9_1.jar
│   │   ├── VERSION.txt
│   │   ├── ZIM.jar
│   │   ├── arm64-v8a
│   │   ├── armeabi-v7a
│   │   ├── pushOpenClient_v3.0.0.4_484_81c1f83_release.jar
│   │   ├── x86
│   │   ├── x86_64
│   │   └── zpns-release.aar
│   ├── proguard-rules.pro
│   ├── src
│   │   └── main
│   └── zim_example_key.jks
├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradle.properties
├── gradlew
├── gradlew.bat
├── local.properties
└── settings.gradle

Copied!

运行示例源码

在开发电脑中找到 Android Studio 软件图标。

在开发电脑上安装 Android Studio 的方式
打开 Android Studio，单击 “Open an Existing Project”。
在解压后的示例源码文件夹中，选择 “ZIMExampleJava” 文件夹，并单击 “Open” 打开。
请参考下载 SDK，下载最新版本的 SDK 包，解压后将文件拷贝到示例源码的 “app/jniLibs/release/” 目录下。
下载的示例源码中缺少 SDK 初始化所需的 appID 和 appSign，需要修改 “ZIMExample/app/src/main/java/im/zego/zimexample” 目录下的 “KeyCenter.java” 文件。请使用本文前提条件已获取的 AppID 和 AppSign 正确填写（注意：需要在 AppID 后加 L），否则示例源码无法正常运行。

若您的项目已切换为 “Token 鉴权”，请在 ZEGO 控制台上，申请临时 Token 用于调试。
将 Android 设备链接到开发电脑，当该设备成功开启“开发者模式”和“USB 调试”功能后，可以看到 Android Studio 上方的 “Running Devices” 选项框由下图：

变为下图：

即 Android Studio 已成功连接到 Android 设备，可以将示例源码运行到该设备上了。
说明
- 当开发电脑连接 Android 设备后，大部分设备会弹出提示，不同 Android 厂商的提示信息有所不同，可根据情况选择 USB 模式。
- 当 Android 设备连接开发电脑后，需要根据情况在该设备上开启开发者模式和 USB 调试功能（不同厂商的 Android 设备开启方式不同）。具体开启方式开发者可以需要自行搜索引擎搜索，例如：目前存在一台未开启过开发者模式与 USB 调试功能的某设备，可以在搜索引擎搜索“某设备开启开发者模式”，查看具体的开启教程。
单击 “Run” 按钮，编译并运行示例源码。