导入 SDK

大约 2 分钟

导入 SDK

本文介绍如何将环信即时通讯 IM iOS SDK 集成到 iOS 项目中。

开发环境要求

  • Xcode:推荐最新版本。
  • 安装 iOS 10.0 或更高版本的 iOS 模拟器或 Apple 设备。
  • CocoaPods 1.10.1 或更高版本(使用 CocoaPods 集成时需要)。

导入 SDK

选择以下任一方式将环信即时通讯 IM SDK 导入项目。

提示

  1. Swift Package Manager(SPM)、CocoaPods 和手动集成只需选择一种,避免重复引入 SDK。
  2. SDK 最新版本号请参见 发版说明。

(推荐)方法一:使用 Swift Package Manager 集成

请选用支持 SPM 的 SDK 5.x 发布版本。

  1. 在 Xcode 中打开项目,选择 File > Add Package Dependencies…。
  2. 在搜索框中输入仓库地址:https://github.com/easemob/HyphenateChat_iOSopen in new window。
  3. 在 Dependency Rule 中选择 Exact Version,填入支持 SPM 的发布版本号,例如 5.2.0,然后点击 Add Package。如需使用其他版本,请先确认对应版本标签包含 Package.swift。
  4. 在包产品选择页面,将 HyphenateChat 添加到你的 App Target,然后点击 Add Package。等待 Xcode 完成依赖解析和下载。

SDK 5.2.0 的 SPM 包最低要求为 iOS 10.0。使用其他版本时,请以所选版本 Package.swift 中的系统要求为准,并相应设置 App Target 的最低部署版本。

方法二:使用 CocoaPods 集成(即将废弃)

CocoaPods 集成方式即将废弃,建议优先使用 SPM。

  1. 在 Terminal 中进入项目根目录,运行 pod init。该命令会在项目根目录生成 Podfile。
  2. 打开 Podfile,配置 iOS 部署目标、App Target 和 SDK 依赖:
platform :ios, '10.0'

target 'EMChatQuickstart' do
  pod 'HyphenateChat'
end
  1. 运行 pod install 安装 SDK。安装成功后,Terminal 会显示 Pod installation complete!,项目根目录会生成 .xcworkspace 文件。
  2. 后续开发请使用生成的 .xcworkspace 文件打开项目,而不是 .xcodeproj 文件。

如需更新已安装的 SDK 版本,可运行 pod update HyphenateChat,随后重新使用 .xcworkspace 打开项目。

方法三:手动导入 SDK

  1. 打开 SDK 下载页面open in new window,下载并解压最新版环信即时通讯 IM iOS SDK。
  2. 将 SDK 包内的 HyphenateChat.xcframework 和 aosl.xcframework 拖入 Xcode 项目。
  3. 在 TARGETS > Project Name > General > Frameworks, Libraries, and Embedded Content 中确认两个 xcframework 均已添加,并将其 Embed 设置为 Embed & Sign。

添加完成后,Xcode 会自动链接 SDK 依赖的系统库。

提示

如果项目同时集成了特定版本的 Agora RTC SDK,且 pod install 提示 aosl.xcframework 同名冲突,请参见 快速开始中的集成问题说明。

上次编辑于: