在 NodeJS 中重新抛出异常并且不会丢失堆栈跟踪

Re-throwing exception in NodeJS and not losing stack trace

如何在 nodejs/javascript 中重新抛出错误或异常并包含自定义消息。

我有以下代码

var json = JSON.parse(result);

我想在出现任何解析错误时在异常消息中包含 result 内容。像这样。

1.  try {
2.    var json = JSON.parse(result);
3.    expect(json.messages.length).to.be(1);
4.  } catch(ex) {
5.    throw new Error(ex.message + ". " + "JSON response: " + result);
6.  }

这里的问题是我丢失了堆栈跟踪。

有没有类似于java的方法?

throw new Error("JSON response: " + result, ex);

我不知道像 Java 这样的本机方法,而且我还没有找到包装错误的优雅解决方案。

创建 new Error 的问题是您可能会丢失附加到抛出的原始 Error 的元数据,堆栈跟踪和类型通常是丢失的重要项目。

修改现有抛出的错误会更快,但仍然可以修改错误中的数据以使其不存在。在其他地方创建的错误中四处寻找也是不对的。

创建新错误和新堆栈

Error.stack属性是一个纯字符串,可以在抛出之前修改成你喜欢的内容。不过,完全替换错误 stack 属性 会使调试变得非常混乱。

当最初抛出的错误和错误处理程序位于不同的位置或文件中时(这在 promises 中很常见),您可能能够追踪到原始错误的来源,但无法追踪错误实际所在的处理程序被困。为避免这种情况,最好在 stack 中保留对原始错误和新错误的一些引用。如果其中存储了额外的元数据,那么访问完整的原始错误也很有用。

这是一个捕获错误的示例,将其包装在一个新错误中,但添加原始 stack 并存储 error:

try {
  throw new Error('First one')
} catch (error) {
  let e = new Error(`Rethrowing the "${error.message}" error`)
  e.original_error = error
  e.stack = e.stack.split('\n').slice(0,2).join('\n') + '\n' +
            error.stack
  throw e
}

抛出:

/so/42754270/test.js:9
    throw e
    ^

Error: Rethrowing the "First one" error
    at test (/so/42754270/test.js:5:13)
Error: First one
    at test (/so/42754270/test.js:3:11)
    at Object.<anonymous> (/so/42754270/test.js:13:1)
    at Module._compile (module.js:570:32)
    at Object.Module._extensions..js (module.js:579:10)
    at Module.load (module.js:487:32)
    at tryModuleLoad (module.js:446:12)
    at Function.Module._load (module.js:438:3)
    at Module.runMain (module.js:604:10)
    at run (bootstrap_node.js:394:7)
    at startup (bootstrap_node.js:149:9)

所以我们创建了一个新的通用 Error。不幸的是,原始错误的类型在输出中隐藏了,但 error 已作为 .original_error 附加,因此仍然可以访问它。新的 stack 已大部分删除,除了重要的生成行,并附加了原始错误 stack

任何尝试解析堆栈跟踪的工具都可能不适用于此更改或最佳情况,它们会检测到两个错误。

重新抛出 ES2015+ 错误 类

将其变成可重用的 ES2015+ 错误 class:

class RethrownError extends Error {
  constructor(message, error){
    super(message)
    this.name = this.constructor.name
    if (!error) throw new Error('RethrownError requires a message and error')
    this.original_error = error
    this.stack_before_rethrow = this.stack
    const message_lines =  (this.message.match(/\n/g)||[]).length + 1
    this.stack = this.stack.split('\n').slice(0, message_lines+1).join('\n') + '\n' +
                 error.stack
  }
}

throw new RethrownError(`Oh no a "${error.message}" error`, error)

结果

/so/42754270/test2.js:31
    throw new RethrownError(`Oh no a "${error.message}"" error`, error)
    ^

RethrownError: Oh no a "First one" error
    at test (/so/42754270/test2.js:31:11)
Error: First one
    at test (/so/42754270/test2.js:29:11)
    at Object.<anonymous> (/so/42754270/test2.js:35:1)
    at Module._compile (module.js:570:32)
    at Object.Module._extensions..js (module.js:579:10)
    at Module.load (module.js:487:32)
    at tryModuleLoad (module.js:446:12)
    at Function.Module._load (module.js:438:3)
    at Module.runMain (module.js:604:10)
    at run (bootstrap_node.js:394:7)
    at startup (bootstrap_node.js:149:9)

然后你就知道,每当你看到 RethrownError 时,原始错误仍然会出现在 .original_error

此方法并不完美,但它意味着我可以将底层模块中的已知错误重新键入更容易处理的通用类型,通常使用蓝鸟 filtered catch .catch(TypeError, handler)

注意 stack在这里变成可枚举的

修改堆栈时出现相同错误

有时您需要保持原始错误的大部分原样。

在这种情况下,您可以 append/insert 将新信息添加到现有堆栈中。

file = '/home/jim/plumbers'
try {
   JSON.parse('k')
} catch (e) {
   let message = `JSON parse error in ${file}`
   let stack = new Error(message).stack
   e.stack = e.stack + '\nFrom previous ' + stack.split('\n').slice(0,2).join('\n') + '\n'
   throw e
}

哪个returns

/so/42754270/throw_error_replace_stack.js:13
       throw e
       ^

SyntaxError: Unexpected token k in JSON at position 0
    at Object.parse (native)
    at Object.<anonymous> (/so/42754270/throw_error_replace_stack.js:8:13)
    at Module._compile (module.js:570:32)
    at Object.Module._extensions..js (module.js:579:10)
    at Module.load (module.js:487:32)
    at tryModuleLoad (module.js:446:12)
    at Function.Module._load (module.js:438:3)
    at Module.runMain (module.js:604:10)
    at run (bootstrap_node.js:394:7)
    at startup (bootstrap_node.js:149:9)
From previous Error: JSON parse error in "/home/jim/plumbers"
    at Object.<anonymous> (/so/42754270/throw_error_replace_stack.js:11:20)

另请注意,堆栈处理很简单,并假定错误消息是一行。如果您 运行 进入多行错误消息,您可能需要寻找 \n at 来终止消息。

如果您只想更改消息,则只需更改消息即可:

try {
  throw new Error("Original Error");
} catch(err) {
  err.message = "Here is some context -- " + err.message;
  throw err;
}

更新:

如果消息属性是只读的,您可以使用原始错误作为原型创建一个新对象并分配一个新消息:

try {  // line 12
  document.querySelectorAll("div:foo");  // Throws a DOMException (invalid selector)
} catch(err) {
  let message = "Here is some context -- " + err.message;
  let e = Object.create( err, { message: { value: message } } );
  throw e;  // line 17
}

不幸的是,记录的异常消息只是“未捕获的异常”,没有异常附带的消息,因此创建错误并为其提供相同的堆栈可能会有所帮助,因此记录的消息将包括错误信息:

try {  // line 12
  document.querySelectorAll("div:foo");  // Throws a DOMException (invalid selector)
} catch(err) {
  e = new Error( "Here is some context -- " + err.message );
  e.stack = err.stack;
  throw e;  // line 17
}

由于片段输出显示了重新抛出的行号,这确认堆栈已保留:

try {  // line 12
  try {  // line 13
    document.querySelectorAll("div:foo");  // Throws a DOMException (invalid selector)
  } catch(err) {
    console.log( "Stack starts with message: ", err.stack.split("\n")[0] );
    console.log( "Inner catch from:", err.stack.split("\n")[1] );
    e = new Error( "Here is some context -- " + err.message );  // line 18
    console.log( "New error from:", e.stack.split("\n")[1] );
    e.stack = err.stack;
    throw e;  // line 21
  }
} catch(err) {
  console.log( "Outer catch from:", err.stack.split("\n")[1] );
  throw err;  // line 25
}

您也可以继续将错误抛出到您的尝试链中。如果你想修改任何东西,请一路修改:在 b.

中的 throw 语句之前

function a() {
    throw new Error('my message');
}

function b() {
    try {
        a();
    } catch (e) {
        // add / modify properties here
        throw e;
    }
}

function c() {
    try {
        b();
    } catch (e) {
        console.log(e);
        document.getElementById('logger').innerHTML = e.stack;
    }
}
c();
<pre id="logger"></pre>

您可能想看看 Joyent 的 verror module,它提供了一种简单的包装错误的方法:

var originError = new Error('No such file or directory');
var err = new VError(originError, 'Failed to load configuration');
console.error(err.message);

这将打印:

Failed to load configuration: No such file or directory