Unity Plugin 使用指南 | 您所在的位置:网站首页 › 游戏脚本定义 › Unity Plugin 使用指南 |
Bugly Unity Plugin 使用指南
Bugly Unity Plugin 使用指南
接入前准备
概述
通用部分集成步骤
下载并导入Bugly Unity Plugin到Unity项目工程
初始化Bugly
iOS部分集成步骤
修改导出的Xcode工程的编译配置
Android部分集成步骤
修改Android工程的配置文件AndroidManifest.xml
API列表
接入前准备
在接入sdk之前,请务必认真阅读《开发者合规指南》和《Bugly SDK个人信息保护规则》 概述Bugly Unity Plugin是专为Unity平台的移动终端(iOS/Android)游戏APP而开发的崩溃/异常捕获组件,它能够自动捕获C#脚本未处理的异常和原生代码(Objective-C、Java、C/C++等)未处理的异常,并提供实时、多维度的异常问题分析服务。 通用部分集成步骤 下载并导入Bugly Unity Plugin到Unity项目工程 下载最新版本Bugly Unity Plugin,双击.unitypackage文件,导入Plugin的相关文件到您的Unity工程中。下载包目录结构说明 bugly_plugin_*.unitypackage - Bugly Unity Plugin包, 提供C#异常捕获功能及原生SDK接口封装 BuglySDK - Bugly原生SDK, Plugin包依赖的原生SDK BuglyUnitySample - Unity工程示例双击bugly_plugin_*.unitypackage文件,根据平台需求导入文件到Unity工程(如果你正在使用旧版本Plugin包,请务必先删除旧版本相关的文件) bugly_plugin_*.unitypackage目录结构说明 Assets/Plugins/BuglyPlugins - Plugin脚本 Assets/Plugins/BuglyPlugins/Android/libs - Android平台依赖的原生SDK(.jar)及NDK组件(.so) Assets/Bugly.framework - iOS平台依赖的原生SDK静态库注意: 集成Bugly Unity Plugin之后,还需集成对应的 iOS 或 Android 平台的SDK组件(已经在下载包中提供) iOS的SDK组件可以在导出的Xcode工程中集成并修改配置(具体可以参考iOS SDK 使用指南),或者使用XUPorter插件自动集成 Android的SDK组件可以在导出的Android工程中集成并修改配置(具体可以参考Android SDK 使用指南),或直接把组件的内容拷贝到工程Plugins/Android目录下,并修改AndroidManifest.xml的权限声明 初始化Bugly 选择第一个或主场景(Scene),在任意脚本文件(建议选择较早加载的脚本)中调用如下代码进行初始化。 // 开启SDK的日志打印,发布版本请务必关闭 BuglyAgent.ConfigDebugMode (true); // 注册日志回调,替换使用 'Application.RegisterLogCallback(Application.LogCallback)'注册日志回调的方式 // BuglyAgent.RegisterLogCallback (CallbackDelegate.Instance.OnApplicationLogCallbackHandler); #if UNITY_IPHONE || UNITY_IOS BuglyAgent.InitWithAppId ("Your App ID"); #elif UNITY_ANDROID BuglyAgent.InitWithAppId ("Your App ID"); #endif // 如果你确认已在对应的iOS工程或Android工程中初始化SDK,那么在脚本中只需启动C#异常捕获上报功能即可 BuglyAgent.EnableExceptionHandler (); iOS部分集成步骤不发布到iOS平台可略过此部分 修改导出的Xcode工程的编译配置此部分的配置你可以参考iOS SDK 使用指南 切换到Build Phases选项卡,在Link Binary With Libraries栏目下添加如下依赖项: libz.dylib - 用于对上报数据进行压缩 Security.framework - 用于存储keychain SystemConfiguration.framework - 用于读取异常发生时的系统信息 JavaScriptCore.framework - 设置为Optional libc++.dylib - libc++库依赖注意: 1) 如果项目已经添加过这些依赖项,不用重复添加 2) 通过XUPorter集成无需在Xcode中添加配置 至此、Unity项目的iOS工程配置完成。你可以在Unity中触发C#的异常验证崩溃上报功能。 Android部分集成步骤不发布到Android平台可略过此部分 修改Android工程的配置文件AndroidManifest.xml此部分的配置你可以参考Android SDK 使用指南 修改导出的Android工程的AndroidManifest.xml文件中的权限声明,添加如下权限:注意:如果权限声明已经添加,不用重复添加 至此、Unity项目的Android工程配置完成。你可以在Unity项目中触发C#的异常进行测试验证。 API列表BuglyAgent.InitWithAppId(string) 初始化Bugly,传入Bugly网站注册获得的App ID。 启用native code(Obj-C、C/C++、Java)异常、C#异常捕获上报,如果你已经在相应的iOS或Android工程中初始化Bugly,那么你只需调用BuglyAgent.EnableExceptionHandler开启C#异常捕获上报即可。 BuglyAgent.EnableExceptionHandler() 启动C#异常日志捕获上报,默认自动上报级别LogError,那么LogError、LogException的异常日志都会自动捕获上报。 日志级别定义参考LogSeverity : {LogDebug、LogWarning、LogAssert、LogError、LogException} BuglyAgent.RegisterLogCallback(BuglyAgent.LogCallbackDelegate) 注册LogCallbackDelegate回调方法, 处理系统的日志。 如果你的应用需要调用Application.RegisterLogCallback(LogCallback)等注册日志回调,你可以使用此方法进行替换。 BuglyAgent.ConfigAutoReportLogLevel(LogSeverity) 设置自动上报日志信息的级别,默认LogError,则>=LogError的日志都会自动捕获上报。 日志级别的定义有LogDebug、LogWarning、LogAssert、LogError、LogException等 BuglyAgent.ReportException (System.Exception, string) 上报已捕获C#异常,输入参数异常对象,附加描述信息 BuglyAgent.ReportException (string, string, string) 上报自定义错误信息,输入错误名称、错误原因、错误堆栈等信息 BuglyAgent.SetUserId (string) 设置用户标识,如果不设置,默认为Unknown。 在初始化之后调用 BuglyAgent.PrintLog (LogSeverity, string) 调用原生SDK的接口打印日志,打印的日志信息将跟错误信息一起上报 在初始化之后调用 BuglyAgent.ConfigDebugMode (bool) 开启本地调试日志打印,默认关闭 注意:在发布版本中请务必关闭调试日志打印功能 BuglyAgent.ConfigDefault (string, string, string, long) 修改应用默认配置信息:渠道号、版本、用户标识、Android初始化延时等。 在初始化之前调用 渠道号默认值为空, 版本默认值 Android应用默认读取AndroidManifest.xml中的android:versionName iOS应用默认读取Info.plist文件中CFBundleShortVersionString和CFBundleVersion,拼接为CFBundleShortVersionString(CFBundleVersion)格式,例如1.0.1(10)用户标识默认值为Unknown Android初始化延时时间, 默认为0,单位毫秒 BuglyAgent.ConfigAutoQuitApplication (bool) 配置是否在捕获上报C#异常信息后就立即退出应用,避免后续产生更多非预期的C#的异常。 在初始化之前调用 |
CopyRight 2018-2019 实验室设备网 版权所有 |