Instabug iOS SDK
Instabug 是一款面向移动应用的内置反馈和错误报告工具。通过简单的摇晃,您的用户或公测测试人员可以 报告错误 或发送内置反馈,SDK 将捕获您的用户设备的快照,包括所有控制台日志、服务器端网络请求 和错误复现步骤,将这些详细信息组织在一个整齐的仪表盘中,帮助您更快地调试和修复错误。
Instabug 还提供了一款 可靠的崩溃报告器,它可以自动捕获运行环境的详细报告、不同线程的状态、复现崩溃的步骤 和网络请求日志。所有数据都自动捕获,无需记录片段,并且您始终可以通过 内置聊天功能 与用户回复,他们会收到应用内的消息。
更多信息,请访问 Instabug.com。
安装
CocoaPods
要使用 CocoaPods 将 Instabug 集成到您的 Xcode 项目中,请在您的 Podfile 中添加它:
pod 'Instabug'
然后,运行以下命令:
$ pod install
Carthage
使用 Carthage 在您的 Xcode 项目中集成 Instabug,将其添加到您的 Cartfile
binary "https://raw.githubusercontent.com/Instabug/Instabug-iOS/master/Instabug.json"
然后,运行以下命令:
$ carthage update
然后将 Instabug.framework 拖入您的 Xcode 项目中。
手动方式
-
解压缩文件然后将其中的 Instabug.framework 拖拽到项目“通用”标签下的“嵌入式二进制文件”部分,确保勾选了“如果需要则复制项”复选框
-
在项目的“构建阶段”下创建一个新的“运行脚本阶段”,并添加以下代码片段
bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Instabug.framework/strip-frameworks.sh"
- 在 Xcode 11.x 中您可能会遇到以下错误
dyld: Library not loaded: @rpath/Instabug.framework/Instabug
Reason: image not found
如果是这种情况,请按照以下步骤操作
-
在“构建阶段”下,点击加号图标添加新的阶段,并选择“新的复制文件阶段”
-
将新创建的复制文件阶段拖至“编译源文件阶段”之上
-
在新的复制文件阶段中,从目标下拉菜单中选择“框架”
-
子路径保持为空。默认情况下仅在安装时复制
-
在表格下方点击加号,然后选择
Instabug.framework
-
确保勾选(勾中)“复制时签名”
-
进行一次清理构建
使用方法
-
在您的应用代理中导入 Instabug 框架头文件
// Swift import Instabug
// Objective-C #import <Instabug/Instabug.h>
-
将以下代码添加到应用代理的 application:didFinishLaunchingWithOptions: 方法中。
// Swift Instabug.start(withToken: <#app token#>, invocationEvents: .shake)
// Objective-C [Instabug startWithToken:<#app token#> invocationEvents:IBGInvocationEventShake];
确保是将
app_token
替换为您的应用令牌。可以在这里找到。
说明
Instabug 需要访问麦克风和照片库,以便用户能够添加音频和视频附件。从 iOS 10 开始,如果应用未为这两个权限提供使用说明,则会因提交到 App Store 被拒绝。
为了确保您的应用不被拒绝,您需要将以下两个键添加到应用的 info.plist 文件中,并在其中添加文本说明为何需要这些权限
NSMicrophoneUsageDescription
NSPhotoLibraryUsageDescription
如果你的应用还尚未访问麦克风或照片库,我们建议使用以下用法描述:
- "
<app name>
需要访问麦克风以便能够附加语音笔记。 " - "
<app name>
需要访问您的照片库以便您能够附加图片。 "
访问麦克风/照片库的权限提示信息不会出现,除非用户在运行 Instabug 时尝试附加语音笔记/图片。
更多
您还可以查看我们关于 SDK 的API 参考,以获取更多详细信息。