本文主要介绍如何快速将腾讯云即时通信 IM SDK 集成到您的 Mac 项目中。
开发环境要求
Xcode 9.0+。
OS X 10.10+ 的 Mac 真机。
项目已配置有效的开发者签名。
集成 IM SDK
您可以选择使用 Swift Package Manager 或 CocoaPods 自动加载的方式,或者先下载 SDK 再将其导入到您当前的工程项目中。
Swift Package Manager 自动加载
步骤1:检查开发环境
请使用支持 Swift 5.10 或更新版本的 Xcode,例如 Xcode 16.0。通过 Swift Package Manager 集成的 Mac App 需运行在 macOS 10.13 或更高版本;该工具链和系统版本要求仅适用于 Swift Package Manager 集成方式。
步骤2:添加 SDK 仓库
在 Xcode 中打开您的项目,选择 File > Add Package Dependencies...,在搜索框中输入以下仓库地址:
https://github.com/Tencent-RTC/Chat_SDK_SwiftPM.git
步骤3:选择版本并关联 Target
在 Dependency Rule 中选择 Exact Version,并输入
9.1.7824,然后点击 Add Package。
在产品选择页面勾选 TXIMSDK_Plus_Mac,将其添加到需要使用 IM SDK 的 macOS App Target。

注意:
您可以根据需要选择版本依赖规则:
Exact Version:固定版本,如 9.1.7824。
Up to Next Minor Version:填写 9.1.0,限定使用 9.1.x。
Up to Next Major Version:填写 9.1.0,允许使用 ≥ 9.1.0 且 < 10.0.0 的版本。
Range:自定义范围,包含下限、不包含上限。
同一个 App Target 不要同时通过 Swift Package Manager、CocoaPods 和手动集成重复引入 IM SDK,以免出现重复符号或框架冲突。
步骤4:引用 SDK 并验证集成
在需要使用 SDK 的 Swift 文件中导入
ImSDKForMac_Plus。注意:依赖产品名称是 TXIMSDK_Plus_Mac,代码中的模块名称是 ImSDKForMac_Plus。import ImSDKForMac_Plusfunc verifyIMSDKIntegration() {guard let manager = V2TIMManager.sharedInstance(),let version = manager.getVersion(),!version.isEmpty else {assertionFailure("IM SDK 集成验证失败")return}print("IM SDK 版本:\\(version)")assert(version == "9.1.7824")}
在 App 启动后调用
verifyIMSDKIntegration(),使用 Debug 配置编译并运行。若工程能够成功编译、链接,且控制台输出 IM SDK 版本:9.1.7824、没有触发断言,则说明该版本 SDK 已成功接入。接入其他版本时,请同步修改示例中的预期版本号。CocoaPods 自动加载
注意:
由于 CocoaPods 官方仓库不再接收新版本,后续 IM SDK 新版本将仅通过 Swift Package Manager(SPM)发布,不再通过 CocoaPods 更新。
步骤1:安装 CocoaPods
在终端窗口中输入如下命令(需要提前在 Mac 中安装 Ruby 环境):
sudo gem install cocoapods
步骤2:创建 Podfile 文件
进入项目所在路径输入以下命令行,之后项目路径下会出现一个 Podfile 文件。
pod init
步骤3:编辑 Podfile 文件
如果使用增强版 SDK,请您按照如下方式设置 Podfile 文件:
platform :macos, '10.10'source 'https://github.com/CocoaPods/Specs.git'target 'mac_test' dopod 'TXIMSDK_Plus_Mac'end
如果使用增强版 Pro SDK,请您按照如下方式设置 Podfile 文件:
platform :macos, '10.10'source 'https://github.com/CocoaPods/Specs.git'target 'mac_test' dopod 'TXIMSDK_Plus_Pro_Mac'end
步骤4:更新并安装 SDK
在终端窗口中输入如下命令以更新本地库文件,并安装 TXIMSDK_Plus_Mac:
pod install
或使用以下命令更新本地库版本:
pod update
pod 命令执行完后,会生成集成了 SDK 的 .xcworkspace 后缀的工程文件,双击打开即可。
说明:
如果 pod install 和 pod update 命令执行失败,提示版本不匹配,请先使用 pod repo update 更新本地 cocoapods 库。
手动集成
步骤1:从 Github 获取 SDK 的下载地址:


ImSDKForMac_Plus.framework 为 IM SDK 的核心动态库文件。
包名 | 介绍 | ipa 增量 |
ImSDKForMac_Plus.framework | 即时通信 IM 功能包 | 1.4M |
步骤2:创建工程
创建一个新的工程:


填入工程名:


步骤3:集成 IM SDK
添加依赖库:
首先将 ImSDKForMac_Plus.framework 拖入您的工程中;
其次选中工程的 Target,在 General 面板中的 Frameworks, Libraries, and Embedded Content 中添加依赖库。


如果运行后,提示
image not found 并出现如下图的 crash,此时需要在 General 面板中的 Frameworks, Libraries, and Embedded Content 中将 Embed Without Signing 改成 Embed & Sign。

开启沙盒选项
选中工程的 Target,在 Signing & Capabilities 面板中可以看到 App Sandbox 选项卡,并勾选 Network 放行 Mac App 的网络请求。
注意:
如果不开启沙盒选项,会导致 IMSDK 本地存储的消息、会话、群组等数据失效;
如果不勾选 Network 放行网络请求,会导致 Mac App 无法联网,从而使 IMSDK 建连失败;
Xcode 创建工程时会默认创建 App Sandbox 并开启沙盒,如果您在当前面板中未发现 App Sandbox 选项卡,您可以手动点击 +Capability 按钮手动添加。


引用 IM SDK
项目代码中使用 SDK 有两种方式:
方式一: 在 Xcode > Build Setting > Header Search Paths 设置
ImSDKForMac_Plus.framework/Headers 路径,在项目需要使用 SDK API 的文件里,直接引用头文件"ImSDKForMac_Plus.h"。#import "ImSDKForMac_Plus.h"
方式二:在项目需要使用 SDK API 的文件里,引入具体的头文件
<ImSDKForMac_Plus/ImSDKForMac_Plus.h>。#import <ImSDKForMac_Plus/ImSDKForMac_Plus.h>