JavaScriptのデバッグ
JavaScriptであるオブジェクトの中身を確認したいとき、多くの人はconsole.logを使うと思います。
フロントエンドで開発するときにはconsole.logを使ってブラウザのコンソールを確認することで
どれだけネストしたオブジェクトもクリックして開くことで中身を確認することができて便利ですよね。
ただしバックエンドAPIを使っている場合は全て解決とはいきませんでした。
ネストされたオブジェクトのconsole.logで Objectが表示される問題
バックエンドでネストしたオブジェクトにconsole.logを使った場合を考えてみます。
const nested = {
nest1: {
nest2: {
nest3: {
nest4: { nest5: "nest" },
},
},
},
};
console.log(nested);
// { nest1: { nest2: { nest3: [Object] } } }
コメントに出力を表示しています。
このようにネストは3階層目までしか表示されず、複雑な構造をしているオブジェクト（リクエストや外部APIのレスポンス等）は中身が全て見えない状況に。
解決方法
今回提示する解決策は3通り
- JSON.stringify を使う方法
- 置換文字列を使う方法
- console.dir を使う方法
JSON.stringify を使う方法
JavaScriptのobjectを文字列に置換するのに使われる関数で、オブジェクトのdeep copyをしたいときに調べるとヒットしますね（経験上あまり使わないほうがよい）
console.log(JSON.stringify(nested));
// {"nest1":{"nest2":{"nest3":{"nest4":{"nest5":"nest"}}}}}
確かにnest5まで表示されていて一見は良さそうです。
しかしキーにダブルクォートがついていたり、文字列のため改行されていないため見づらく見えます。
置換文字列を使う方法
C言語などで使われるフォーマット指定子っぽいものがJavaScriptにもあります。
参考 https://developer.mozilla.org/ja/docs/Web/API/console#%E4%BE%8B
この中で %oを使うことで最下部までコンソールに表示されるようになりました
console.log("%o", nested)
{
nest1: {
nest2: { nest3: { nest4: { nest5: 'nest' } } }
}
}
いい感じにインデントもしてくれていて見やすくなっていますね。
console.dir を使う方法
consoleにはlog以外にもメソッドがあります。その中でdirを使ってみます。
console.dirは引数を2つとり、第一引数は任意のitem、第二引数はoptionを指定します。
optionにはobjectとして { depth: null }を入れましょう。
console.dir(nested, { depth: null });
{
nest1: {
nest2: { nest3: { nest4: { nest5: 'nest' } } }
}
}
こちらも見やすく表示されました。
まとめ
JavaScriptのデバッグは console.log(item) 以外にも使ってみてください！
追記
2023/12/22
@ykhirao さんにstringifyのより見やすい使い方を教えていただきました。
ありがとうございます！
JSON.stringifyに引数を渡す方法
console.log(JSON.stringify(nested, null, 4));
{
"nest1": {
"nest2": {
"nest3": {
"nest4": {
"nest5": "nest"
}
}
}
}
}