JSONの特定キーを複数まとめて再帰的に削除する方法

公開ツールJSON特定キー除去器

目次
  1. 複数のキーを一度に、何階層も下まで消したいとき
  2. ツールを使わずに自分で消す方法
  3. 結果が思ったとおりにならないときによくある見落とし
  4. まとめ
  5. よくある質問

ネストしたJSONレスポンスやログデータから、password、token、hash のような複数の機密プロパティを一度に消したいときは、そのキーが最上位にあっても、配列内のオブジェクトのさらに何階層か奥にあっても、漏れなく見つけて削除する必要があります。

JSON特定キー除去器は、カンマ区切りで並べたキー名のリストを受け取り、オブジェクトツリー全体を再帰的に走査しながら、名前が完全に一致するプロパティだけをふるい落とし、それ以外はそのままコピーします。

この記事では、そのマッチングと走査が内部でどんなルールに従って動いているのか、そして結果画面に出た値をどう解釈すればよいのかを、事実ベースで整理します。

まとめ ① カンマで区切ったキー名はそれぞれトリムされたうえで同時にマッチング対象になり、配列内のオブジェクトや深くネストしたオブジェクトまで再帰的にすべて走査します。 ② 大文字小文字を区別しないオプションがオンのときはキー名を小文字に変換して比較し、オフのときは元の文字列と完全に一致した場合だけ削除されます。 ③ マッチングは完全一致のみで、部分文字列は削除されません。JSONの形式が正しくない場合はエラーが出るだけで、出力欄は空になります。

複数のキーを一度に、何階層も下まで消したいとき

APIレスポンスをログに残したり、バグレポートに添付したりするとき、その中には password、secret_token、salt のように、そのまま見せるのはまずいフィールドがいくつも混ざっています。問題は、そうしたフィールドが最上位オブジェクトの1つだけにあるわけではないことです。

ユーザー一覧APIのレスポンスなら、users配列の中に入っているオブジェクトごとに password があり、そのオブジェクトの中にさらに session という下位オブジェクトがあって、そこに secret_token がもう一度入っている、といった具合です。

こうした構造をテキストエディタで目で探して1つずつ消していくと、配列の要素数に応じて消すべき個数がその分だけ増え、1つでも漏らしやすくなります。

やりたいのは「この名前のキーはどこにあっても全部消す」というルールを1つ決めておき、そのルールをオブジェクトツリー全体に一貫して適用することです。

ツールを使わずに自分で消す方法

この作業は、JavaScriptの実行環境(ブラウザの開発者ツールのコンソールやNode.js)さえあれば、数行のコードで自分で行えます。ポイントは JSON.stringify が第2引数に受け取る replacer 関数です。

replacer関数で再帰的に走査する

JSON.stringify(value, replacer, space) で replacer が関数の場合、この関数は最上位の値から始めて、オブジェクトと配列のすべてのプロパティに対して再帰的に呼び出されます。呼び出しのたびに、現在のキー名と値を受け取ります。

undefined を返すと、そのプロパティは結果の文字列から丸ごと外れます。この再帰呼び出しは配列内のオブジェクトにも同じように適用されるので、走査用のコードを別途書かなくても、ネストの深さに関係なく動作します。

消したいキー名をカンマ区切りで書いて配列にし、各項目を trim したうえで replacer の中で比較すればよいだけです。

const raw = JSON.parse(inputText);
const targetKeys = "password, secret_token, salt"
  .split(",")
  .map((k) => k.trim());

const cleaned = JSON.stringify(
  raw,
  (key, value) => (targetKeys.includes(key) ? undefined : value),
  2
);

大文字小文字を区別せずに消す

大文字小文字を区別せずに消したい場合は、比較の前にキー名とリストをすべて小文字に変換してから比較します。

const lowerKeys = targetKeys.map((k) => k.toLowerCase());
const cleaned = JSON.stringify(
  raw,
  (key, value) => (lowerKeys.includes(key.toLowerCase()) ? undefined : value),
  2
);

このコードは、ツールが内部でやっていることとまったく同じです。ただし毎回コンソールを開いてコードを貼り付ける代わりに、入力欄にJSONを貼り付けてキー名だけを変えながらすぐ結果を見たいなら、下のツールを使ってください。

無料ツールで確認してみてください。

JSON特定キー除去器

サーバーへの送信は行わずブラウザ内だけで処理し、複数のキーをカンマ区切りで一度に指定して再帰的に削除します

結果が思ったとおりにならないときによくある見落とし

結果欄を見て「なぜこのキーは消えていないのか」「なぜここまで消えたのか」と疑問に思うときは、たいてい次の4つのどれかが原因です。

状況実際の動作
キー名リストに password だけを書いたのに password_hash、user_password もある完全一致のみなので消えません。部分文字列のマッチングではありません。
カンマの後にスペースを入れる/入れない(password, token と password,token)各キー名は分割後に自動でトリムされるので、スペースの有無は結果に影響しません。
大文字小文字を区別しないチェックボックスがオン(既定値)Password、PASSWORD、password がすべて小文字に変換されて比較されるため、全部消えます。
大文字小文字を区別しないチェックボックスをオフリストに書いた綴りと大文字小文字まで完全に同じキーだけが消え、Password は残ります。

配列と不正なJSONはどう処理されるのか

配列の中にオブジェクトが複数入っている構造も、例外なく処理されます。配列は各要素を改めて再帰関数に渡して走査するので、配列内のオブジェクト1つひとつにある対象キーがすべて削除され、そのオブジェクトの中にさらに別のオブジェクトがあれば、その中まで下りて消します。

入力欄に入れたテキストが有効なJSONでなければ JSON.parse の段階で失敗し、画面にはパースエラーメッセージだけが出て、出力欄は埋まりません。

結果が空なら、キー名よりも先に入力JSONの構文(引用符の抜け、末尾のカンマなど)を確認するのが順序です。

最後に、結果はボタンを押したときにだけ再計算されます。入力欄やキーリストを編集中に出力が自動で変わることはなく、「キー削除」ボタンをもう一度押すと最新の入力に基づいて結果が更新されます。

まとめ

  • キーリストはカンマで区切り、各項目は自動でトリムされて同時にマッチング対象になります。
  • 再帰的な走査は、配列内のオブジェクトや深くネストしたオブジェクトまで例外なく適用されます。
  • 大文字小文字を区別しないオプションのオン/オフによって、Password と password が同じキーとして扱われるかどうかが分かれます。
  • マッチングは完全一致のみなので、部分文字列を含むキーは削除されません。
  • 不正なJSONを入れるとエラーが出るだけで出力は空になり、結果はボタンを押したときにだけ再計算されます。
JSON特定キー除去器

サーバーへの送信は行わずブラウザ内だけで処理し、複数のキーをカンマ区切りで一度に指定して再帰的に削除します

よくある質問

キー名の一部だけが一致しても削除されますか?

削除されません。マッチングはトリムされたキー名との完全一致だけを確認するので、リストに token だけを書いた場合は token というキーだけが削除され、access_token や token_id のように名前の一部だけが同じキーはそのまま残ります。

カンマの後にスペースを入れずに詰めて書いても大丈夫ですか?

大丈夫です。キーリストはカンマで分割したあと各項目の前後の空白を自動的に取り除くので、password,token のように詰めて書いても、password, token のようにスペースを空けて書いても、マッチング結果は同じです。

配列内にある複数のオブジェクトのキーもまとめて削除されますか?

削除されます。配列に出会うと各要素を改めて再帰的に走査するので、配列内のオブジェクト100個すべてに同じ名前のキーがあれば、100個すべてから削除されます。そのオブジェクトの中にさらに別のオブジェクトや配列があっても、下り続けながら処理します。

入力したJSONの形式が正しくないとどうなりますか?

JSON.parse が失敗した時点で処理が止まり、画面にはパースエラーメッセージだけが表示され、出力欄には何も入りません。引用符の抜けや、最後の項目の後ろにある不要なカンマ(trailing comma)といった構文エラーがよくある原因です。

この記事は韓国語の原文をもとに作成しています。 韓国語の原文を読む

関連記事

  1. JSONキーをアルファベット順にソートする方法|配列は変わらないJSONのキーをアルファベット順に並べ替えると何が変わり、何が変わらないのかを実例で解説します。再帰オプションやインデントの反映、構文エラー時の表示も確認できます。
  2. JSオブジェクトをJSONに変換する方法とエラーの原因コンソールからコピーしたJSオブジェクトをJSON.parseに渡すと出るUnexpected tokenエラーの原因を、JSONの文法ルールと比べて解説し、コンソールで変換する手順もまとめました。
  3. JSONスキーマ自動作成の型判定ルールとrequired・anyOfJSONの例を貼り付けるだけでDraft-07スキーマができる仕組みを解説します。文字列・数値・配列の型がどう判定されるのか、requiredとanyOfが何を意味するのか、例1つから作るスキーマの限界まで確認できます。
  4. JSON構文エラー 原因と位置の見つけ方Unexpected tokenなどJSONのエラー位置が何を指すのか、原因になりやすい書き方とあわせて解説。メッセージを読んで原因を絞り込む手順がわかります。
  5. JSON to TypeScript変換 ?と|が付く規則JSONをTypeScriptのinterfaceにするとき、一部の要素にしかないキーに付く?(optional)や、値の型が混ざったときの|(ユニオン)がどの規則で決まるのかを実例で確かめられます。
  6. JSONをYAMLに変換するときの配列とインデントの規則JSONの配列がハイフン(-)のリストに、ネストしたオブジェクトがインデント階層になる規則と、2スペース・4スペースの違い、KubernetesやDocker Composeに貼るときの間違いを整理します。

関連ツール