即时通讯
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • Web
  • 小程序
  • Flutter
  • uni-app
  • React Native
  • 产品简介
  • 下载
  • 快速开始
    • 跑通示例源码
    • 实现基本消息收发
  • 用户相关
  • 房间相关
  • 群组相关
  • 消息相关
  • 呼叫邀请
  • 会话管理
  • 离线推送
  • 常见错误码
  • 服务端 API
  • 客户端 API
  • 常见问题
示例源码
本地下载

跑通示例源码

1 概览

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

2 准备环境

在运行示例源码前,请确保开发环境满足以下要求:

  • Xcode 7.0 或以上版本。
  • iOS 9.0 或以上版本且支持音视频的 iOS 设备或模拟器(推荐使用真机)。
  • iOS 设备已经连接到 Internet。

3 前提条件

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

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

4 示例源码目录结构

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

├── CommonTools
│   ├── GHConsole
│   ├── HUD
│   ├── KeyboardToolBar
│   ├── TokenGenerator
│   └── ZEGOPopMenuView
├── Podfile
├── Podfile.lock
├── Pods
│   ├── Headers
│   ├── Local\ Podspecs
│   ├── MJRefresh
│   ├── Manifest.lock
│   ├── Pods.xcodeproj
│   └── Target\ Support\ Files
├── ZIMExampleDemo
│   ├── AppDelegate.h
│   ├── AppDelegate.mm
│   ├── Assets.xcassets
│   ├── Base.lproj
│   ├── ConversationList
│   ├── Group
│   ├── GroupList
│   ├── Info.plist
│   ├── Login
│   ├── Peer
│   ├── Room
│   ├── ZIMExampleDemo.entitlements
│   ├── ZIMManager
│   └── main.m
├── ZIMExampleDemo.xcodeproj
│   ├── project.pbxproj
│   ├── project.xcworkspace
│   └── xcuserdata
├── ZIMExampleDemo.xcworkspace
│   ├── contents.xcworkspacedata
│   ├── xcshareddata
│   └── xcuserdata
└── libs
    └── ZIM.xcframework

5 运行示例源码

  1. 打开 “AppStore”,搜索 “Xcode” 并下载安装。

  2. 使用 Xcode 打开 “ZIMExampleDemo.xcworkspace” 文件。

    1. 打开 Xcode,选择左上角的菜单 “File > Open...”。

    2. 在解压后的示例源码文件夹中,找到 “ZIMExampleDemo.xcworkspace” 文件打开。

  3. 请参考 下载 SDK,下载最新版本的 SDK 包,解压后,将文件拷贝到示例源码的 “ZIMExampleLegacy/libs/IOS” 目录下,替换掉旧的 SDK 包。

  4. 登录 Apple 开发者账号。

    1. 打开 Xcode,选择左上角的菜单 “Xcode > Preferences...”。

      /Pics/ZIM/iOS/xcode_preferences.png

    2. 单击 “Accounts” 选项卡,单击左下角的 “+”,选择添加 “Apple ID”,单击 “Continue”。

    3. 输入 Apple ID 和 Password 登录。

  5. 修改 Bundle Identifier 和开发者证书。

    1. 打开 Xcode,单击左侧的 “ZIMExampleDemo” 项目。

      /Pics/ZIM/iOS/xcode_select_project_new.png

    2. 打开 TARGETS 选项,单击 “Signing & Capabilities” 选项卡,修改项目的 Bundle Identifier,选择自己的开发者证书。

      /Pics/ZIM/iOS/team_signing_new.png

  6. 下载的示例源码中缺少 SDK 初始化所需的 AppID 和 AppSign,需要修改 “ZIMManager” 文件夹下的 “KeyCenter.m” 文件,请使用本文 3 前提条件 已获取的 AppID 和 AppSign 正确填写,否则示例源码无法正常运行。

    + (unsigned int)appID {
        return 1333333333; // Please enter your AppID
    }
    + (NSString *)AppSign {
        return @"AppSign"; // Please enter your AppSign
    }
  7. 将 iOS 设备连接到开发电脑,并在 Xcode 选择该设备。

    /Pics/ZIM/iOS/xcode_select_device.png

  8. 单击 Xcode 左上角的 “Build” 按钮编译和运行示例源码。

    /Pics/ZIM/iOS/build_and_run.png