💭

【30日目】『リーダブルコード』を意識してJavaScriptをリファクタリングしてみた

に公開

技術ブログ30日目。
本日は、JavaScriptの読みやすさを追求します。

〇課題 高機能な通知モーダルの初期化処理
UIコンポーネントの初期化関数ですが、引数が多すぎ、さらに true や 300 といった値が何を意味するのか、呼び出し側から全く読み取れません。 特定の引数だけを指定したい場合でも、順番を守るために undefined を並べる必要があり、非常に保守性が低い「負債」のような状態です。

〇修正前コード(動くけれど読みにくいコード)

// 課題コード
function showModal(title, content, type, width, height, isAutoClose, duration, showOverlay, onClose) {
  console.log(`${title}(${type})を表示します`);
  console.log(`内容: ${content}`);
  
  if (isAutoClose) {
    setTimeout(() => {
      console.log(`${duration}ms後に自動で閉じました`);
      if (onClose) onClose();
    }, duration);
  }
}

// 実行例(何を指定しているのかさっぱり分からない)
showModal(
  "保存完了", 
  "データをサーバーに保存しました", 
  "success", 
  600, 
  400, 
  true, 
  3000, 
  true, 
  () => console.log("モーダル終了")
);

// 特定の引数(isAutoCloseなど)だけ変えたい場合、地獄のundefined祭りが始まる
showModal("エラー", "再試行してください", "error", undefined, undefined, false, undefined, true);


〇リファクタリングの指針
名著『リーダブルコード』の以下の原則を意識しました。
引数オブジェクトの導入:
関連する項目を1つのオブジェクトにまとめ、「名前付き引数」スタイルへ変換。

「謎の真偽値(Boolean Trap)」の排除:
true / false に名前(キー)を付け、推測を不要にする。

デフォルト設定の集約:
分割代入を活用し、オプション設定の初期値を1箇所で安全に管理。

〇修正後コード

/**
 * 高機能な通知モーダルを表示する
 * @param {Object} options - 設定オブジェクト
 */
function showModal({
  title,
  content,
  type = "info",           // デフォルト値の設定
  width = 500,
  height = 300,
  isAutoClose = false,
  duration = 3000,
  showOverlay = true,
  onClose = () => {}       // 空の関数をデフォルトに
} = {}) {                  // 引数自体が省略された場合のエラー防止
  
  console.log(`${title}(${type})を表示します`);
  console.log(`サイズ: ${width}x${height}, オーバーレイ: ${showOverlay}`);
  console.log(`内容: ${content}`);
  
  if (isAutoClose) {
    setTimeout(() => {
      console.log(`${duration}ms後に自動で閉じました`);
      onClose();
    }, duration);
  }
}

// 実行例:呼び出し側で「どの値が何を指すか」が一目瞭然になる
showModal({
  title: "保存完了",
  content: "データをサーバーに保存しました",
  type: "success",
  isAutoClose: true,
  onClose: () => console.log("モーダル終了")
});

// 特定の引数だけ変えたい場合も、順番を気にせず必要なものだけ書けばOK
showModal({
  title: "エラー",
  content: "再試行してください",
  type: "error",
  showOverlay: false
});

〇主な修正ポイント
「名前付き引数」パターンの導入
JavaScriptの「オブジェクト分割代入」を使い、擬似的に名前付き引数を実現しました。isAutoClose: true のようにラベル付きで値を渡せるため、「コードを読むだけで意味がわかる」状態になります。

「謎の真偽値(Boolean Trap)」の解消 元のコードで判別不能だった true や false に意味のあるキー名を持たせました。読み手の推測を排除し、バグの混入を防ぎます。

順番の依存関係(Position Offset)の排除
引数の順番を気にする必要がなくなりました。7番目の引数だけを変えたい時も、必要な項目だけをピックアップして指定できるため、DX(開発者体験)が劇的に向上します。

デフォルト値の集約と安全策
{ ... } = {} という記法により、未指定時の挙動を1箇所に集約。引数なしで実行された際のランタイムエラーも構造的に防止しています。

〇参照先
▼公式ドキュメント
https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Operators/Destructuring#unpacking_fields_from_objects_passed_as_a_function_parameter

https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Operators/Object_initializer#property_definitions

▼書籍
リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック

以上

Discussion