CrashReporter.NET 使用指南

CrashReporter.NET 使用指南

项目介绍

CrashReporter.NET 是一个专为经典桌面应用程序设计的库，它允许开发者将基于 .NET Framework 的应用中发生的崩溃报告直接发送到开发者的邮箱。此工具通过捕获异常信息（包括堆栈跟踪、异常类型、消息、源、CLR 版本、操作系统版本以及应用版本），并将这些信息整合成一个报告，附带可选的屏幕截图，利用邮件的形式发送给开发者。此外，项目支持通过 DoctorDump 服务或自定义SMTP服务器来发送报告。

项目快速启动

要开始使用 CrashReporter.NET，首先需要将其添加到你的项目中。以下是在一个经典 .NET Framework 应用程序中集成 CrashReporter.NET 的步骤：

1. 安装包: 你可以通过 NuGet 包管理器安装 CrashReporter.NET.Official。

   Install-Package CrashReporter.NET.Official -Version 1.6.0
   

2. 初始化配置: 在应用程序启动时进行配置，以确保可以捕捉并发送异常报告。对于 Windows Forms 应用，可以在 Program.cs 文件中的 Main() 方法里添加如下代码：

   static class Program
   {
       static void Main()
       {
           // 订阅未处理异常
           Application.ThreadException += HandleThreadException;
           AppDomain.CurrentDomain.UnhandledException += HandleUnhandledException;
   
           // 初始化 CrashReporter
           var reportCrash = new ReportCrash("your_email@example.com")
           {
               Silent = true,
               ShowScreenshotTab = true,
               IncludeScreenshot = false
           };
   
           reportCrash.RetryFailedReports();
           Application.Run(new MainForm());
   
           // 异常处理函数
           static void HandleThreadException(object sender, ThreadExceptionEventArgs ex)
           {
               Program.SendReport(ex.Exception);
           }
   
           static void HandleUnhandledException(object sender, UnhandledExceptionEventArgs ex)
           {
               Program.SendReport((Exception)ex.ExceptionObject);
           }
           static void SendReport(Exception exception)
           {
               reportCrash.DeveloperMessage = "自动报告";
               reportCrash.Send(exception);
           }
       }
   }
   

3. 接收报告: 将 "your_email@example.com" 替换为实际的电子邮件地址，开始接收应用崩溃时的报告。

应用案例和最佳实践

• 个性化错误报告: 根据不同类型的异常提供不同的开发者消息，以便更好地理解发生的具体情况。
• 用户体验优化: 设置 Silent = true 可以在不干扰用户的前提下静默发送报告，提高用户体验。
• 截图策略: 合理配置 IncludeScreenshot 和 ShowScreenshotTab 来决定是否收集和展示用户界面截图，这有助于更直观地了解故障场景。

典型生态项目

虽然CrashReporter.NET是针对独立应用程序的设计，但其核心功能可以被其他框架和生态系统所借鉴或嵌入，如可以通过适配器模式让其兼容 Modern .NET 框架如 .NET Core 或 .NET 5+。尽管当前项目主要针对经典.NET Framework，但理念上类似的服务或组件在微服务架构、跨平台应用中也非常常见，通常需结合特定平台的错误捕获机制进行适配。

---

通过以上步骤和策略，您可以有效地集成并利用 CrashReporter.NET 监控您的 .NET 应用程序的健康状态，及时响应潜在的问题。