介绍一个专门处理C++异常的类和例子

源码与例子下载

简介： 

CExceptionLogger ，是一个可以免费使用的C++类，用它可以截获未处理异常，如：非法存取、栈溢出、被零除等，并可以将异常具体信息记录到日志文件。这个类源自于MSDN Magazine 2002年3月的一篇专栏文章“Under the Hood: Improved Error Reporting with DBGHELP 5.1”，该文章的作者是 Matt Pietrek。

特性：

在默认情况下， CExceptionLogger 产生一个日志文件，名字为：nameofexe.exception，这里的nameofexe是exe文件的名字。假如以ASCII模式生成 CExceptionLogger ，则日志文件为一ASCII文件；假如以UNICODE模式生成 CExceptionLogger ，那么日志文件为一UNICODE文件。日志文件记录的信息包括：

1. 记录异常发生的日期和时间。
2. 异常代码。
3. 假如发生非法存取，则记录该异常的具体信息。
4. 记录的异常具体信息包括：线性地址、段、偏移量和模块路径。
5. 进程的全路径名。
6. 当前Win32工作目录。
7. 进程的命令行。
8. 进程ID。
9. 发生异常的线程ID。
10. 列举进程中所有的线程（假设ToolHelp32是可获得的），内容包括：
    • 线程ID
    • 优先级和Delta优先级
    • 参考
    • 创建时间
    • Kernel 和 User Time
11. 列举进程中的模块（同样假设ToolHelp32是可获得的），内容包括：
    • 名字和全路径
    • 全程及每个进程的引用计数
    • 模块句柄
    • 大小
    • 模块完全展开后的所有符号
12. 所有x86寄存器。
13. 异常发生的调用堆栈，包括：段、偏移量、模块、函数和行信息。
14. 日志文件记录的内容还包括每一个堆栈帧（stack frame）以及所有模块、所有变量、所有参数；所有基本数据类型，如：voids, chars, shorts, Words, ints, DWORDS, floats, doubles 和 longs。此外日志还记录用户定义的数据类型（UDT）包括结构、联合以及类的信息，再现其成员数据。每种类型都包括名字、地址、类型和值。假如变量是一数组，该数组中的值被完全记录。

版权声明：

• 你可以在任何以二进制形式发布的产品（包括商业的、共享的、自由的或其它的）中包含此源代码
• 在不修改每个模块（*.h、*.cpp）最上方版权细则的前提下，你可以用任何方式修改源代码
• 假如你想要与自己的应用程序一起分发源代码，只答应分发作者最新发布的版本，以便保证源代码的出处是唯一的

使用方法：

• 编译这个类需要安装2002年11月以后发布的平台SDK。使用时既可以将 ExceptHandler.cpp/h 文件直接添加到C++工程中，也可以用DLL输出异常处理函数类，并用LoadLibrary函数在需要时动态加载DLL。
• ExceptHandler的二进制版本在XCPTHLR.DLL中提供。此DLL可以从本文最上方链接处下载。
• 为了在客户机器上运行该代码，必须分发DBGHELP 5.1 动态链接库，这个库可以从2002年11月以后的平台SDK中获得。选择“Install Debugging Tools for Windows”选项安装该DLL。此外，还要注重DBGHELP 动态链接库在最新的 Windows 版本中是受到保护 Windows 系统文件，所以请将 DBGHELP 动态链接库放在与应用程序相同的目录中。
• 为了在release模式中给代码提供符号，必须按照下列步骤修改工程设置：
  1. Project Settings -> Link -> Debug (Category) , 启用“Debug Info” 并选中“Microsoft Format”。
  2.相同的地方，选中“Separate Types”。
  3. 在相同页的“Project Options”编辑框中，添加“/OPT:REF”，这样可以保证从最终的二进制中排除掉未引用的函数。
  
  4. Project Settings -> C++ -> General (Category) Debug Info 组合框 -> 选择“Program Database”
  5. 假如要对无意义的堆栈进行调用，那么需将“Optimizations”设置为“Disable (Debug)”。
• 还要记住与代码一起分发最终生成的pdb文件（或用其它方法使之可以得到）。以便CExceptionLogger能在最终的日志中给出源和行信息。
• 请注重由于所有的符号，即便是很小的应用的符号，各自的异常日志可能超过100K。我的观点是磁盘空间不值钱，而开发人员为查找BUG所花的时间则很宝贵。
• 参考资料： Bugslayer, MSJ, August 1998 by John Robbins, http://www.microsoft.com/msj/defaultframe.ASP?page=/msj/0898/bugslayer0898.htm Under the Hood, MSDN, March 2002 by Matt Pietrek, http://msdn.microsoft.com/msdnmag/issues/02/03/Hood/Hood0203.asp

改进计划：

• 可配置日志文件名。
• 提供对Win64平台的支持。
• 提供对非x86 调用堆栈的支持。
• 假如有任何改进建议，不妨来信告知，以便我将它们加到下下一个版本中。

作者的联系方式：
PJ Naughter
个人网站：http://www.naughter.com