JavaScript、JSON、Node.jsにおけるErrorオブジェクトのJSON文字列化

2024-04-02

JavaScript、JSON、Node.js における Error オブジェクトの JSON 文字列化

答え: 結論から言うと、直接的にはできません。

理由:

JSON.stringify は、JavaScript のオブジェクトを JSON 形式の文字列に変換する関数です。しかし、Error オブジェクトは、循環参照を含む特殊な構造を持っているため、JSON.stringify でそのまま文字列化しようとすると、エラーが発生します。

解決策:

Error オブジェクトを JSON 文字列化するには、以下の方法があります。

必要なプロパティのみを抽出する

Error オブジェクトには、message、name、stack などのプロパティがあります。これらのうち、必要なプロパティのみを抽出して、別のオブジェクトにコピーします。そして、そのオブジェクトを JSON.stringify で文字列化します。

const err = new Error('エラーが発生しました');

const errorData = {
  message: err.message,
  name: err.name,
};

const jsonStr = JSON.stringify(errorData);

console.log(jsonStr); // {"message":"エラーが発生しました","name":"Error"}

カスタムの JSON シリアライザーを使用する

Error オブジェクトを JSON 文字列化する専用のライブラリやモジュールも存在します。これらのライブラリを使用することで、Error オブジェクトを含む複雑なオブジェクトも簡単に JSON 文字列化できます。

補足:

Error オブジェクトを JSON 文字列化する際には、セキュリティ上のリスクに注意する必要があります。特に、stack プロパティには、機密情報が含まれる可能性があるため、公開しないように注意が必要です。
Node.js では、util.inspect モジュールを使用して、Error オブジェクトの詳細な情報を取得することができます。

必要なプロパティのみを抽出する

const err = new Error('エラーが発生しました');

const errorData = {
  message: err.message,
  name: err.name,
};

const jsonStr = JSON.stringify(errorData);

console.log(jsonStr); // {"message":"エラーが発生しました","name":"Error"}

カスタムの JSON シリアライザーを使用する

json-stringify-safe

const stringifySafe = require('json-stringify-safe');

const err = new Error('エラーが発生しました');

const jsonStr = stringifySafe(err);

console.log(jsonStr); // {"message":"エラーが発生しました","name":"Error"}

error-to-json

const errorToJson = require('error-to-json');

const err = new Error('エラーが発生しました');

const jsonStr = errorToJson(err);

console.log(jsonStr); // {"message":"エラーが発生しました","name":"Error","stack":"Error: エラーが発生しました\n    at ..."}

その他の Error オブジェクトを JSON 文字列化する方法は以下の通りです。

const err = new Error('エラーが発生しました');

const jsonStr = JSON.stringify(JSON.parse(JSON.stringify(err)));

console.log(jsonStr); // {"message":"エラーが発生しました","name":"Error"}

Error.prototype.toJSON メソッドを使用する

Error.prototype.toJSON = function() {
  return {
    message: this.message,
    name: this.name,
  };
};

const err = new Error('エラーが発生しました');

const jsonStr = JSON.stringify(err);

console.log(jsonStr); // {"message":"エラーが発生しました","name":"Error"}

function errorToJson(err) {
  const obj = {};

  for (const prop in err) {
    if (Object.prototype.hasOwnProperty.call(err, prop)) {
      obj[prop] = err[prop];
    }
  }

  return JSON.stringify(obj);
}

const err = new Error('エラーが発生しました');

const jsonStr = errorToJson(err);

console.log(jsonStr); // {"message":"エラーが発生しました","name":"Error"}