json-stable-stringify と json-stable-stringify-without-jsonify は、JavaScript オブジェクトをプロパティの順序に関係なく一貫した(安定した)JSON 文字列に変換するためのライブラリです。これは、ハッシュ生成やキャッシュキー作成など、決定性が求められる処理で重要です。json-stable-stringify はカスタムの JSON シリアライザー(jsonify)を使用し、undefined や関数などの標準 JSON でサポートされない値も処理できます。一方、json-stable-stringify-without-jsonify は標準の JSON.stringify() に依存し、依存関係を最小限に抑える代わりに、JSON セーフなデータのみを扱います。
json-stable-stringify と json-stable-stringify-without-jsonify の比較JavaScript でオブジェクトを JSON 文字列に変換する際、プロパティの順序が実行環境や V8 のバージョンによって変わることがあります。これは、例えばキャッシュキー生成やハッシュ計算など、決定性(deterministic)な出力が必要な場面では重大な問題になります。この課題を解決するために登場したのが、プロパティのソートに基づいて安定した JSON 文字列を生成するライブラリです。
ここでは、json-stable-stringify とその派生である json-stable-stringify-without-jsonify を比較し、どちらを選ぶべきかを技術的に解説します。
両者の最も重要な違いは、内部で使用する JSON シリアライザーにあります。
json-stable-stringifyこのパッケージは、安定したソート機能に加えて、カスタムの JSON シリアライザー(jsonify) を内蔵しています。これにより、標準の JSON.stringify() では処理できない特殊な値(例:undefined、関数、循環参照)にも対応できます。
// json-stable-stringify の基本使用法
const stableStringify = require('json-stable-stringify');
const obj = { b: 2, a: 1 };
console.log(stableStringify(obj)); // '{"a":1,"b":2}'
さらに、jsonify による拡張により、以下のようなケースでも動作します:
const obj = {
func: function() {},
undef: undefined,
normal: 'value'
};
// 標準の JSON.stringify() では func と undef が消える
console.log(JSON.stringify(obj)); // '{"normal":"value"}'
// json-stable-stringify は jsonify を使って null に置き換える
console.log(stableStringify(obj)); // '{"func":null,"normal":"value","undef":null}'
json-stable-stringify-without-jsonifyこのパッケージは、名前が示す通り jsonify に依存しないように設計されています。代わりに、標準の JSON.stringify() をそのまま利用します。つまり、JSON.stringify() が扱えない値(関数、undefined、シンボルなど)は自動的に無視されます。
// json-stable-stringify-without-jsonify の使用法
const stableStringify = require('json-stable-stringify-without-jsonify');
const obj = { b: 2, a: 1 };
console.log(stableStringify(obj)); // '{"a":1,"b":2}'
// 特殊な値を含む場合
const obj2 = {
func: function() {},
undef: undefined,
normal: 'value'
};
console.log(stableStringify(obj2)); // '{"normal":"value"}'
// → jsonify を使わないので、標準 JSON と同じ挙動
json-stable-stringify は jsonify という追加の依存を持ちます。これは、特にフロントエンドやバンドルサイズがシビアな環境(例:モバイル Web アプリ、軽量ライブラリ)では問題になることがあります。
一方、json-stable-stringify-without-jsonify は ゼロ依存であり、純粋に JavaScript の組み込み機能のみで動作します。そのため、以下の点で有利です:
ただし、この利点は「JSON.stringify() の制限を受け入れる」ことを前提としています。
両方のパッケージは、標準の JSON.stringify() と互換性のある API を提供しており、replacer 関数や space(インデント)オプションもサポートしています。
// replacer の使用例(両方で同じ)
const obj = { a: 1, b: 2, secret: 'hidden' };
const replacer = (key, value) => key === 'secret' ? undefined : value;
console.log(stableStringify(obj, { replacer }));
// '{"a":1,"b":2}'
// space の使用例
console.log(stableStringify({ a: 1 }, { space: 2 }));
// '{\n "a": 1\n}'
この点では、機能差はありません。
公式 npm ページおよび GitHub リポジトリを確認したところ、両方のパッケージとも現在非推奨(deprecated)ではありません。ただし、json-stable-stringify-without-jsonify は明確に「json-stable-stringify の依存を減らしたい人向けの代替」として作られており、積極的な開発は行われていない可能性があります。
それでも、コアロジック(プロパティの再帰的ソート)は非常に安定しており、多くのプロジェクトで長年利用されています。
json-stable-stringify を使うべきか?undefined や関数が含まれる可能性があり、それらを null として明示的に残したい場合json-stable-stringify-without-jsonify を使うべきか?JSON.stringify() の挙動に完全に従いたい場合💡 実際の現場では、API レスポンスや設定オブジェクトなど、既に JSON シリアライズ可能なデータを扱うケースがほとんどです。その場合、
jsonifyの機能は不要であり、json-stable-stringify-without-jsonifyの方が適しています。
without-jsonify)// 入力
const config = { timeout: 5000, retries: 3, debug: false };
// json-stable-stringify
require('json-stable-stringify')(config);
// '{"debug":false,"retries":3,"timeout":5000}'
// json-stable-stringify-without-jsonify
require('json-stable-stringify-without-jsonify')(config);
// '{"debug":false,"retries":3,"timeout":5000}'
// → 結果は同一
const obj = { name: 'test', init: () => {}, flag: undefined };
// json-stable-stringify
// → '{"flag":null,"init":null,"name":"test"}'
// json-stable-stringify-without-jsonify
// → '{"name":"test"}'
ここで重要なのは、意図しないデータ消失です。もし flag や init の存在をキー生成に使いたい場合、without-jsonify 版ではその情報が失われ、異なるハッシュが生成されてしまいます。
入力データに undefined / 関数 / シンボル が含まれるか?
json-stable-stringifyバンドルサイズや依存関係を最小化したいか?
json-stable-stringify-without-jsonifyjson-stable-stringify で統一しても問題ない)ほとんどのフロントエンド用途では、データはすでに JSON セーフであるため、json-stable-stringify-without-jsonify がより適切な選択肢です。一方、Node.js の汎用ツールや、動的なオブジェクトを扱うライブラリでは、json-stable-stringify の柔軟性が役立ちます。
最終的には、「データの性質」と「環境の制約」のバランスで判断しましょう。
json-stable-stringify-without-jsonify は、入力データが純粋な JSON セーフ型(文字列、数値、真偽値、null、配列、オブジェクト)のみであることが保証されている場合に最適です。特にフロントエンドや軽量ライブラリで、依存関係をゼロに抑えたい、バンドルサイズを最小化したいという要件があるならこちらを選びましょう。
json-stable-stringify は、オブジェクトに undefined や関数、シンボルなどの標準 JSON でサポートされない値が含まれる場合に適しています。これらの値を null として明示的に残したいユースケースや、サーバーサイドで依存関係の増加を気にしない環境で選ぶとよいでしょう。ただし、バンドルサイズが大きくなる点に注意が必要です。
This is the same as https://github.com/substack/json-stable-stringify but it doesn't depend on libraries without licenses (jsonify).
deterministic version of JSON.stringify() so you can get a consistent hash
from stringified results
You can also pass in a custom comparison function.
var stringify = require('json-stable-stringify');
var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };
console.log(stringify(obj));
output:
{"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8}
var stringify = require('json-stable-stringify')
Return a deterministic stringified string str from the object obj.
If opts is given, you can supply an opts.cmp to have a custom comparison
function for object keys. Your function opts.cmp is called with these
parameters:
opts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue })
For example, to sort on the object key names in reverse order you could write:
var stringify = require('json-stable-stringify');
var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };
var s = stringify(obj, function (a, b) {
return a.key < b.key ? 1 : -1;
});
console.log(s);
which results in the output string:
{"c":8,"b":[{"z":6,"y":5,"x":4},7],"a":3}
Or if you wanted to sort on the object values in reverse order, you could write:
var stringify = require('json-stable-stringify');
var obj = { d: 6, c: 5, b: [{z:3,y:2,x:1},9], a: 10 };
var s = stringify(obj, function (a, b) {
return a.value < b.value ? 1 : -1;
});
console.log(s);
which outputs:
{"d":6,"c":5,"b":[{"z":3,"y":2,"x":1},9],"a":10}
If you specify opts.space, it will indent the output for pretty-printing.
Valid values are strings (e.g. {space: \t}) or a number of spaces
({space: 3}).
For example:
var obj = { b: 1, a: { foo: 'bar', and: [1, 2, 3] } };
var s = stringify(obj, { space: ' ' });
console.log(s);
which outputs:
{
"a": {
"and": [
1,
2,
3
],
"foo": "bar"
},
"b": 1
}
The replacer parameter is a function opts.replacer(key, value) that behaves
the same as the replacer
from the core JSON object.
With npm do:
npm install json-stable-stringify
MIT