App Center 崩溃 （Unity）

重要

Visual Studio App Center 于 2025 年 3 月 31 日停用，但分析和诊断功能除外，这些功能将继续受支持，直到 2026 年 6 月 30 日。 了解详细信息。

• 安卓
• iOS
• MAUI/Xamarin
• UWP
• WPF/WinForms
• React Native
• macOS
• tvOS
• 团结

App Center 崩溃会在每次应用崩溃时自动生成崩溃日志，并记录到设备存储。 当用户再次启动应用时，SDK 会将崩溃报告发送到 App Center。 收集崩溃适用于 beta 应用和实时应用，即提交到 Google Play 的崩溃。 故障日志包含有助于修复崩溃的重要信息。

如果尚未在应用程序中设置 SDK，请按照 Unity 入门 部分中的说明进行作。

iOS 上的故障日志需要符号化。 若要启用符号，请参阅 App Center 诊断文档，其中介绍了如何为应用提供符号。

重要

适用于 Unity 的崩溃 SDK 不支持 UWP。 本页中的说明仅涵盖 Android 和 iOS。

注释

如果附加了调试器，SDK 不会转发任何崩溃日志。 请确保在应用崩溃时没有附加调试器。

注释

如果已在 Enable CrashReport APIPlayerSettings 中启用，则 SDK 不会收集故障日志。

触发测试崩溃

App Center 的崩溃模块提供了一个 API，用于生成测试崩溃，以方便测试 SDK。 此 API 检查调试配置与发布配置。 因此，只能在调试时使用它，因为它不适用于发布应用。

Crashes.GenerateTestCrash();

注释

此方法仅适用于打开 “开发生成 ”设置。

获取有关以前崩溃的详细信息

App Center 崩溃功能提供两个 API，当应用程序崩溃时为您提供更多信息。

应用在上一个会话中是否收到内存不足的警告？

启动 SDK 后，可以随时检查应用是否在上一会话中收到内存警告：

bool hadLowMemoryWarning = Crashes.HasReceivedMemoryWarningInLastSessionAsync().Result;

注释

此方法不起作用。Awake()。

注释

在某些情况下，内存不足的设备无法发送事件。

应用在上一个会话中是否崩溃？

启动 SDK 后，可以随时检查应用是否在上一次启动中崩溃：

bool didAppCrash = await Crashes.HasCrashedInLastSessionAsync();

如果要在发生崩溃后调整应用的行为或 UI，则调用 HasCrashedInLastSessionAsync 非常有用。 一些开发人员会显示额外的界面向他们的用户致歉，或者希望在发生崩溃后与用户取得联系。

有关上次崩溃的详细信息

如果应用之前崩溃，可以获取有关上次崩溃的详细信息。

ErrorReport crashReport = await Crashes.GetLastSessionCrashReportAsync();

此 API 的最常见使用场景是用户实现其自定义 崩溃委托或侦听器。

自定义 App Center 崩溃功能的使用

App Center 崩溃模块为开发人员提供回调，以便在将崩溃日志发送到 App Center 之前和发送时执行其他操作。

注释

在 App Center 启动 之前 设置回调，可以在 Awake 方法中进行，因为 App Center 在启动后会立即开始处理崩溃。

是否应处理故障？

如果要确定是否需要处理特定的崩溃，请设置以下回调。 例如，你可能希望忽略系统级崩溃，而不发送到 App Center。

Crashes.ShouldProcessErrorReport = (ErrorReport report) =>
{
     // Check the report in here and return true or false depending on the ErrorReport.
    return true;
};

请求用户同意发送故障日志

如果用户隐私对你很重要，你可能希望在将崩溃报告发送到 App Center 之前获取用户确认。 SDK 公开了一个回调接口，指示 App Center 崩溃在发送崩溃报告之前等待用户确认。

如果代码使用此回调，则需负责获取用户的确认。 一个选项是通过以下选项之一的对话框提示： 始终发送、 发送和 不发送。 根据输入，你将告知 App Center 崩溃该怎么做，然后崩溃将被相应地处理。

注释

SDK 不为此显示对话框，应用必须提供自己的 UI 才能请求用户同意。

以下回调演示如何告知 SDK 在发送崩溃之前等待用户确认：

Crashes.ShouldAwaitUserConfirmation = () =>
{
    // Build your own UI to ask for user consent here. SDK doesn't provide one by default.

    // Return true if you built a UI for user consent and are waiting for user input on that custom UI, otherwise false.
    return true;
};

如果回调返回 true，则必须先获取用户权限，然后使用以下 API 向 SDK 发送结果消息。

// Depending on the user's choice, call Crashes.NotifyUserConfirmation() with the right value.
Crashes.NotifyUserConfirmation(UserConfirmation.DontSend);
Crashes.NotifyUserConfirmation(UserConfirmation.Send);
Crashes.NotifyUserConfirmation(UserConfirmation.AlwaysSend);

例如，可以参考 我们的自定义对话示例。

获取有关故障日志的发送状态的信息

有时，你想知道应用崩溃的状态。 常见的用例是显示一个 UI，通知用户应用正在提交崩溃报告。 另一种情况是，你想要调整应用的行为，以确保在重新启动后不久提交崩溃日志。 App Center 崩溃提供了三个不同的回调，你可以发出通知，了解发生的情况：

在 SDK 发送故障日志之前，将调用以下回调

Crashes.SendingErrorReport += (errorReport) =>
{
    // Your code, e.g. to present a custom UI.
};

如果我们在终端发生网络问题或服务中断的情况下重启应用程序，那么在 SendingErrorReport 进程重启后，应用程序将再次被触发。

SDK 成功发送故障日志后，将调用以下回调

Crashes.SentErrorReport += (errorReport) =>
{
    // Your code, e.g. to hide the custom UI.
};

如果 SDK 未能发送故障日志，将调用以下回调

Crashes.FailedToSendErrorReport += (errorReport, exception) =>
{
    // Your code goes here.
};

接收 FailedToSendErrorReport 意味着发生不可恢复的错误，例如 4xx 代码。 例如， 401 表示 appSecret 错误。

如果是网络问题，此回调不会被触发。 在这种情况下，SDK 会不断重试（并在网络连接关闭时暂停重试）。

向崩溃或未经处理的异常报告添加附件

还可以选择将二进制附件和文本附件添加到崩溃或 未经处理的异常 报告。 SDK 会随报表一起发送它们，以便在 App Center 门户中查看它们。 在发送存储报表之前，将立即调用以下回调。 对于崩溃，它会在下一次应用程序启动时发生。 对于未经处理的异常，必须 启用 以发送附件。 请确保附件文件 未 命名 minidump.dmp 为为小型转储文件保留该名称。 下面是如何将文本和图像附加到报表的示例：

Crashes.GetErrorAttachments = (ErrorReport report) =>
{
    // Your code goes here.
    return new ErrorAttachmentLog[]
    {
        ErrorAttachmentLog.AttachmentWithText("Hello world!", "hello.txt"),
        ErrorAttachmentLog.AttachmentWithBinary(Encoding.UTF8.GetBytes("Fake image"), "fake_image.jpeg", "image/jpeg")
    };
};

报告中崩溃与未经处理的异常是通过 IsCrash 属性来区分的。 如果发生崩溃，该属性为 true，否则为 false。

注释

大小限制适用于当前为 7 MB 的附件。 尝试发送更大的附件将触发错误。

注释

GetErrorAttachments 在主线程上调用，并且不会在帧上拆分工作。 为了避免阻止游戏循环，请不要在此回调中执行任何长时间运行的任务。

在运行时启用或禁用 App Center 崩溃功能

可以在运行时启用或禁用 App Center 崩溃功能。 如果禁用它，SDK 不会针对应用执行任何崩溃报告。

Crashes.SetEnabledAsync(false);

若要再次启用 App Center Crashes，请使用相同的 API，但将 true 作为参数传递。

Crashes.SetEnabledAsync(true);

无需等待此调用即可使其他 API 调用（例如 IsEnabledAsync）保持一致。

状态在应用程序启动时保留在设备的存储中。

检查是否启用了 App Center 崩溃功能

您还可以检查 'App Center Crashes' 是否已启用：

bool isEnabled = await Crashes.IsEnabledAsync();

Unity 中处理的异常

App Center 还允许通过 Unity 中被处理的异常来跟踪错误。 为此，请使用 TrackError 以下方法：

try {
    // your code goes here.
} catch (Exception exception) {
    Crashes.TrackError(exception);
}

有关此错误的更多上下文信息，您还可以为其附加属性。 将属性作为字符串字典传递。 此步骤是可选的。

try {
    // your code goes here.
} catch (Exception exception) {
    var properties = new Dictionary<string, string>
    {
        { "Category", "Music" },
        { "Wifi", "On" }
    };
    Crashes.TrackError(exception, properties);
}

还可以选择将二进制附件和文本附件添加到已处理的错误报告。 将附件作为对象数组 ErrorAttachmentLog 传递，如以下示例所示。

try {
    // your code goes here.
} catch (Exception exception) {
    var attachments = new ErrorAttachmentLog[]
    {
        ErrorAttachmentLog.AttachmentWithText("Hello world!", "hello.txt"),
        ErrorAttachmentLog.AttachmentWithBinary(Encoding.UTF8.GetBytes("Fake image"), "fake_image.jpeg", "image/jpeg")
    };
    Crashes.TrackError(exception, attachments: attachments);
}

Unity 中未经处理的异常

报告未经处理的异常

默认情况下，App Center SDK 不会报告应用中引发的未处理的异常，这些异常不会导致严重崩溃。 若要启用此功能，请调用以下方法：

Crashes.ReportUnhandledExceptions(true);

调用此 API 后，App Center 会将所有未经处理的异常记录为 App Center 门户中的问题，类似于前面提到的已处理异常。 若要禁用此功能，请调用与参数传递 false 相同的 API。

Crashes.ReportUnhandledExceptions(false);

注释

App Center SDK 检测到的某些未经处理的异常将在 App Center UI 中显示为错误。 这是因为 Unity 默认捕获未经处理的异常，这意味着应用不会退出，也不会被视为崩溃。

向未经处理的异常报告添加附件

默认情况下，App Center SDK 不会对未经处理的异常启用附件。 若要启用此功能，请将enableAttachmentsCallback方法的布尔参数设置为：ReportUnhandledExceptionstrue

Crashes.ReportUnhandledExceptions(true, true);

然后，可以选择通过实现 GetErrorAttachments 回调将附件添加到未经处理的异常报告。

报告 NDK 崩溃

报告崩溃

若要在 App Center 中接收适当的故障报告，请先按照上面列出的说明确保已设置 App Center 崩溃 SDK。

构建Breakpad库

接下来，必须按照官方 Google Breakpad for Android 自述文件中列出的说明来包括和编译 Google Breakpad。 若要在 Unity 中使用它，请将二进制文件包含在应用中。

注释

默认情况下，App Center SDK 不会捆绑 Google Breakpad。

附加异常处理程序

包含 Google Breakpad 后，附加 NDK 崩溃处理程序：

/* Attach NDK Crash Handler. */
var minidumpDir = Crashes.GetMinidumpDirectoryAsync();
setupNativeCrashesListener(minidumpDir.Result);

...

[DllImport("YourLib")]
private static extern void setupNativeCrashesListener(string path);

setupNativeCrashesListener 方法是一个本机方法，必须用 C/C++ 实现

#include <android/log.h>
#include "google-breakpad/src/client/linux/handler/exception_handler.h"
#include "google-breakpad/src/client/linux/handler/minidump_descriptor.h"

static google_breakpad::ExceptionHandler exception_handler(google_breakpad::MinidumpDescriptor(), NULL, dumpCallback, NULL, true, -1);

/**
 * Registers breakpad as the exception handler for NDK code.
 * @param path minidump directory path returned from Crashes.GetMinidumpDirectoryAsync()
 */
extern "C" void setupNativeCrashesListener(const char *path) {
    google_breakpad::MinidumpDescriptor descriptor(path);
    exception_handler.set_minidump_descriptor(descriptor);
}

用于故障排除的位置 dumpCallback ：

/*
 * Triggered automatically after an attempt to write a minidump file to the breakpad folder.
 */
static bool dumpCallback(const google_breakpad::MinidumpDescriptor &descriptor,
                         void *context,
                         bool succeeded) {

    /* Allow system to log the native stack trace. */
    __android_log_print(ANDROID_LOG_INFO, "YourLogTag",
                        "Wrote breakpad minidump at %s succeeded=%d\n", descriptor.path(),
                        succeeded);
    return false;
}

正确设置这些方法后，应用重启后会自动将小型转储发送到 App Center。 若要进行故障排除，可以使用详细日志来检查重启应用后是否发送了微型转接。

注释

App Center 使用迷你转储附件的保留名称 minidump.dmp 。 请确保为附件提供其他名称，除非它是小型转储文件，以便我们可以正确处理它。

警告

已知 Breakpad 中存在一个 bug，这导致无法在 x86 模拟器上捕获崩溃。

符号

有关崩溃处理的详细信息，请参阅 诊断文档 。