Node-Addon-API 中自定义异常属性的实现方法

异常处理基础

在 Node.js 原生扩展开发中，使用 Node-Addon-API 抛出异常到 JavaScript 环境是一个常见需求。通常开发者会使用 Napi::Error 或其子类如 Napi::TypeError 来创建异常对象。

标准异常抛出方式

最基本的异常抛出方式是直接传递错误消息字符串：

Napi::Error::New(env, "发生了一个错误").ThrowAsJavaScriptException();

或者使用特定类型的错误：

Napi::TypeError::New(env, "参数类型错误").ThrowAsJavaScriptException();

自定义异常属性

开发者经常需要在异常对象上附加额外信息，如错误代码、上下文数据等。Node-Addon-API 支持通过 Set() 方法为异常对象添加自定义属性：

Napi::Error err = Napi::TypeError::New(env, "参数验证失败");
err.Set("code", Napi::Number::New(env, 400));  // 添加错误代码
err.Set("details", Napi::String::New(env, "用户名不能为空")); // 添加详情
err.ThrowAsJavaScriptException();

实现原理

当异常从 C++ 传递到 JavaScript 时，Node-Addon-API 会创建一个 JavaScript Error 对象，并将所有通过 Set() 方法设置的属性保留下来。这与 JavaScript 中直接创建 Error 对象并添加属性的行为一致。

注意事项

1. 属性设置时机：必须在调用 ThrowAsJavaScriptException() 之前设置所有自定义属性

2. 性能考虑：频繁创建和抛出带有大量自定义属性的异常可能影响性能

3. 类型支持：可以设置各种类型的属性值，包括数字、字符串、对象等

4. 错误处理一致性：建议团队统一自定义属性的命名规范，如统一使用 errorCode 而非混用 code 和 error_code

实际应用示例

以下是一个更完整的示例，展示了如何在原生模块中实现带有错误代码的验证逻辑：

Napi::Value ValidateUser(const Napi::CallbackInfo& info) {
  Napi::Env env = info.Env();
  
  if (info.Length() < 1) {
    Napi::Error err = Napi::TypeError::New(env, "缺少用户参数");
    err.Set("code", Napi::Number::New(env, 1001));
    err.Set("field", Napi::String::New(env, "user"));
    err.ThrowAsJavaScriptException();
    return env.Null();
  }
  
  // ...其他验证逻辑
  
  return env.Undefined();
}

在 JavaScript 中捕获这个异常时，可以访问所有自定义属性：

try {
  nativeModule.validateUser();
} catch (err) {
  console.log(err.message); // "缺少用户参数"
  console.log(err.code);    // 1001
  console.log(err.field);   // "user"
}

总结

Node-Addon-API 提供了灵活的异常处理机制，允许开发者在 C++ 中创建丰富的错误对象并传递到 JavaScript 环境。通过合理使用自定义属性，可以构建更健壮的错误处理系统，为应用程序提供更详细的错误诊断信息。