Puerts项目中异常信息添加列号的优化实践

背景介绍

Puerts是腾讯开源的一个TypeScript/JavaScript与Unity游戏引擎的桥接框架，它允许开发者使用TypeScript/JavaScript来开发Unity游戏。在游戏开发过程中，错误信息的准确性和可读性对于快速定位和解决问题至关重要。

问题描述

在Puerts的早期版本中，错误信息打印逻辑仅包含文件名和行号信息。这在以下两种常见情况下会导致定位困难：

1. 当JavaScript代码被压缩成单行时，仅凭行号无法精确定位错误位置
2. 当使用字节码时，行号信息可能不够精确

技术分析

在JavaScript引擎(如V8)中，错误堆栈信息通常包含以下关键元素：

• 文件名
• 行号(line number)
• 列号(column number)
• 错误信息
• 调用堆栈

原始的错误打印逻辑仅使用了前三项信息，而忽略了列号这一重要定位信息。在压缩代码或字节码场景下，列号能够提供更精确的错误位置指示。

解决方案

Puerts团队通过修改V8Utils.h文件中的错误打印逻辑，增加了列号信息的输出。具体实现包括：

1. 从V8引擎获取完整的错误位置信息，包括行号和列号
2. 格式化错误信息时，将列号与行号一起显示
3. 保持原有堆栈信息的输出逻辑不变

这种改进使得错误信息格式变为：文件名+行号:列号+错误信息+[堆栈]，大大提升了错误定位的精确度。

实现意义

这项改进带来了以下好处：

1. 提高调试效率：在压缩代码场景下，开发者可以快速定位到错误发生的精确位置
2. 增强可读性：完整的行列信息使错误报告更加清晰易懂
3. 保持兼容性：不影响原有错误处理流程，只是增加了更多有用信息

技术细节

在V8引擎中，错误位置信息可以通过v8::Message对象获取。该对象提供了以下相关方法：

• GetLineNumber() 获取行号
• GetStartColumn() 获取起始列号
• GetEndColumn() 获取结束列号

Puerts的修改充分利用了这些API，将列号信息整合到错误输出中，使得错误报告更加完整。

总结

Puerts项目通过为异常信息添加列号这一看似小的改进，实际上显著提升了开发者在特殊场景下的调试体验。这体现了开源项目对开发者体验的持续关注和优化，也展示了如何通过细致的技术改进来解决实际开发中的痛点问题。

对于使用Puerts进行Unity开发的团队来说，这一改进将帮助他们更高效地定位和解决JavaScript/TypeScript代码中的问题，特别是在使用了代码压缩或特殊编译流程的项目中。