Day 89:リファクタリング
Day 89では、アプリの動作を変えずに、コードを読みやすく、直しやすい形へ整えます。この作業を「リファクタリング」といいます。学習管理アプリを例に、関数分割、ファイル分割、変数名の改善、重複コードの削減を順番に進めます。
リファクタリングは、機能を追加する作業ではありません。見た目や動作を保ちながら、コードの構造を整理します。整理した結果、表示や保存の動きが変わってしまわないよう、変更の前後で動作を確認することが大切です。
リファクタリングを始める前に
まず、アプリが現在どのように動いているかを確認します。コードを直す前に動作を記録しておくと、整理した後に意図しない変更がないか比べられます。
- 記録を追加できるか確認します。
- 一覧、検索、フィルター、並べ替えが動くか確認します。
- 編集と削除ができるか確認します。
- ページを再読み込みしても記録や設定が残るか確認します。
- 空入力や不正な値に、適切な案内が表示されるか確認します。
この確認を、リファクタリング後にも同じように行います。これが、動作を保ったまま整理できたかを判断する基準になります。
ステップ1:関数を役割ごとに分ける
ひとつの関数に、入力確認、保存、画面表示、メッセージ表示などが集まっていると、内容を理解しにくくなります。まずは関数が「何を担当するか」を考え、役割が異なる処理を分けます。
たとえば、フォーム送信時の処理は、次のような流れにできます。
- フォームの値を取得します。
- 入力値を確認します。
- 記録を作成または更新します。
- 保存します。
- 一覧とメッセージを更新します。
すでにある処理を、読みやすい名前の関数に分ける例です。
// フォームの入力値をひとつのオブジェクトにまとめて返す
function getFormValues() {
return {
title: titleInput.value,
minutes: minutesInput.value,
date: dateInput.value,
note: noteInput.value
};
}
// 入力値を確認し、問題があればエラーメッセージを返す
function getValidationMessage(values) {
if (values.title.trim() === "") {
return "学習内容を入力してください。";
}
const minutes = Number(values.minutes);
if (!Number.isInteger(minutes) || minutes <= 0) {
return "学習時間には1以上の整数を入力してください。";
}
if (values.date === "") {
return "学習日を入力してください。";
}
// 問題がなければ空文字を返す
return "";
}
// フォーム送信時の大まかな流れを管理する
function handleStudyFormSubmit(event) {
// フォーム送信によるページ再読み込みを防ぐ
event.preventDefault();
const formValues = getFormValues();
const validationMessage = getValidationMessage(formValues);
if (validationMessage !== "") {
statusMessage.textContent = validationMessage;
return;
}
// 既存の追加・編集処理に入力値を渡す
saveOrUpdateStudyRecord(formValues);
}JavaScriptイベントリスナーから呼び出すと、フォーム処理の流れが見やすくなります。
// フォーム送信時に、専用の処理関数を呼び出す
studyForm.addEventListener("submit", handleStudyFormSubmit);JavaScript関数を細かく分けること自体が目的ではありません。処理のまとまりに意味があり、名前から役割が想像できるかを基準にします。短い処理を何でも関数にすると、かえって全体の流れを追いにくくなることがあります。
ステップ2:変数名を見直す
変数名は、値の役割が分かる名前にします。特に、data、item、xのように意味の範囲が広い名前は、何の値なのか分かりにくくなりがちです。
- `d`より`studyRecords`のほうが、学習記録の配列だと分かります。
- `r`より`record`のほうが、1件分の記録だと分かります。
- `q`より`searchKeyword`のほうが、検索欄の値だと分かります。
- `x`より`visibleRecords`のほうが、画面に表示する記録だと分かります。
// 読みにくい例
const d = getData();
const x = d.filter(function (r) {
return r.title.includes(q);
});
// 役割が分かる名前にした例
const studyRecords = getStudyRecords();
const visibleRecords = studyRecords.filter(function (record) {
return record.title.includes(searchKeyword);
});JavaScript名前は長ければよいわけではありません。何度も繰り返す言葉をすべて詰め込むと、かえって読みづらくなることもあります。「その名前だけで用途を想像できるか」を目安にしましょう。
ステップ3:重複コードを見つけて共通化する
同じ処理を何か所にも書いていると、仕様変更のたびにすべてを修正しなければならず、修正漏れが起きやすくなります。たとえば、記録を変更したあとに「保存して一覧を更新する」処理が複数あるなら、共通関数にまとめられます。
// 記録を保存し、成功した場合だけ配列と画面を更新する
function saveAndRenderRecords(nextRecords) {
try {
// 保存データはJSON文字列に変換する
localStorage.setItem(
STORAGE_KEY,
JSON.stringify(nextRecords)
);
// 保存が成功したら、アプリの配列を更新する
studyRecords = nextRecords;
// 最新の記録から一覧や合計を表示し直す
renderStudyRecords();
return true;
} catch (error) {
// 保存失敗の詳細は開発者向けに記録する
console.error("学習記録を保存できませんでした。", error);
// 利用者には次の行動が分かる案内を表示する
statusMessage.textContent =
"記録を保存できませんでした。時間をおいて再度お試しください。";
return false;
}
}JavaScript追加、編集、削除でこの処理を使えば、保存と一覧更新の流れを一か所で管理できます。
// 新しい記録を先頭に追加する
function addStudyRecord(newRecord) {
const nextRecords = [newRecord, ...studyRecords];
return saveAndRenderRecords(nextRecords);
}
// IDが一致する記録だけを更新する
function updateStudyRecord(recordId, updatedValues) {
const nextRecords = studyRecords.map(function (record) {
if (record.id !== recordId) {
return record;
}
return {
...record,
...updatedValues
};
});
return saveAndRenderRecords(nextRecords);
}
// IDが一致する記録を一覧から取り除く
function removeStudyRecord(recordId) {
const nextRecords = studyRecords.filter(function (record) {
return record.id !== recordId;
});
return saveAndRenderRecords(nextRecords);
}JavaScript共通化する前には、処理の目的や条件が本当に同じかを確認します。似た見た目でも、異なるルールを持つ処理を無理にまとめると、関数が複雑になることがあります。
ステップ4:ファイルを役割ごとに分ける
コードが1つのファイルに集まり、探しにくくなってきたら、処理の役割に合わせてファイルを分けます。最初から細かく分ける必要はありません。まずは「画面操作」「データ処理」「保存処理」のように、大きな役割から分割します。
study-record-app/
├── index.html
├── styles.css
└── js/
├── app.js # 起動処理とイベントの登録
├── storage.js # localStorageの読み込み・保存
├── records.js # 記録の追加・更新・削除・検索
└── ui.js # 一覧やメッセージの画面表示
ファイルを分ける場合は、ES Modulesを使えます。HTML側では、type="module"を指定します。
<!-- ES Modules形式のJavaScriptを読み込む -->
<script type="module" src="./js/app.js"></script>
storage.jsでは、保存処理を外部から使えるようにexportします。
// js/storage.js
const STORAGE_KEY = "studyRecords";
// 保存済みの記録を読み込む
export function loadStudyRecords() {
try {
const savedText = localStorage.getItem(STORAGE_KEY);
// データがなければ空の配列を返す
if (savedText === null) {
return [];
}
const records = JSON.parse(savedText);
// 配列以外の値は読み込み対象にしない
return Array.isArray(records) ? records : [];
} catch (error) {
console.error("学習記録を読み込めませんでした。", error);
return [];
}
}
// 記録の配列を保存する
export function saveStudyRecords(records) {
localStorage.setItem(STORAGE_KEY, JSON.stringify(records));
}JavaScriptapp.jsでは、必要な関数をimportして使います。
// js/app.js
import {
loadStudyRecords,
saveStudyRecords
} from "./storage.js";
// 保存処理を呼び出し、アプリのデータを用意する
let studyRecords = loadStudyRecords();
// ここから画面要素の取得やイベント登録を行う
console.log(`読み込んだ記録は${studyRecords.length}件です。`);JavaScriptブラウザーでES Modulesを使う場合、環境によってはHTMLを直接開くのではなく、ローカル開発サーバーから表示する必要があります。ファイル分割後に読み込みエラーが出たら、importのパス、ファイル名、大文字・小文字、実行環境を確認しましょう。
ステップ5:処理のまとまりと依存関係を確認する
ファイルを分けたあとも、何でも自由に相互参照させるのではなく、役割を意識します。
- `storage.js`は、ブラウザーへの保存と読み込みを担当します。
- `records.js`は、記録の検索や追加などのデータ処理を担当します。
- `ui.js`は、HTML要素への表示を担当します。
- `app.js`は、画面イベントを受け取り、必要な処理をつなぎます。
たとえば、保存処理のファイルから画面のボタンを直接操作し始めると、保存と画面表示の役割が混ざってしまいます。ファイルを分ける目的は、コードを必要以上に散らすことではなく、変更する場所を見つけやすくすることです。
ステップ6:動作を変えずに少しずつ整理する
一度に多くの変更をすると、どの変更が原因で不具合が起きたのか分かりにくくなります。小さな単位で整理し、その都度動作を確認します。
- まず変数名だけを変更し、アプリが動くか確認します。
- 次に重複処理を共通関数にまとめ、追加・編集・削除を確認します。
- そのあと必要ならファイルを分け、読み込みと画面表示を確認します。
- 最後に、入力エラーや検索、保存などのテストをもう一度行います。
「名前を変える」「関数を分ける」「保存場所を変える」など、変更の種類を一度に混ぜないことが、初心者にとって原因を追いやすくするコツです。
リファクタリング後の確認項目
整理の後は、少なくとも次の操作を確認します。
- 記録を追加し、一覧と合計時間に反映されますか。
- 記録を編集し、更新後の値が保存されますか。
- 記録を削除し、一覧と合計時間が更新されますか。
- ページを再読み込みしても、記録が読み込まれますか。
- 検索、フィルター、並べ替えはこれまでどおり動きますか。
- 空入力や不正なデータに対して、案内が表示されますか。
- ブラウザーのコンソールに新しいエラーが出ていませんか。
特に、イベントリスナーを登録するコードをファイル移動したときは、同じイベントを複数回登録していないか確認します。二重に登録すると、ボタンを1回押したのに処理が2回実行されることがあります。
よくある注意点
- リファクタリングと機能追加を同時に進めると、動作が変わった原因を特定しにくくなります。
- ファイルを分けすぎると、処理の流れを追うために多くのファイルを行き来することになります。
- 同じ名前の変数や関数を複数ファイルで宣言しないようにします。
- `import`のパスとファイル名は正確に指定します。
- コメントは、コードをそのまま言い換えるより、理由や注意点を説明するために残します。
リファクタリング記録テンプレート
作業前後の変化を記録しておくと、何を整理したか振り返りやすくなります。
変更前に確認した動作:
-
-
改善した箇所:
- 関数分割:
- ファイル分割:
- 変数名:
- 重複コード:
変更後に確認した動作:
-
-
気づいた不具合や次に直すこと:
-
Day 89のゴール
- ひとつの関数が多くの役割を抱えないように整理できます。
- 変数名や関数名から役割が想像できるようにできます。
- 同じ処理を共通関数にまとめられます。
- 必要に応じてファイルを役割ごとに分割できます。
- 整理の前後で同じ操作を試し、動作が変わっていないか確認できます。
まとめ
Day 89では、機能を変えずにコードを読みやすくするリファクタリングを学びました。関数は役割ごとに分け、変数名は用途が分かるものにし、同じ処理は必要に応じて共通化します。コード量やファイル数を増やすこと自体を目標にせず、修正する場所を見つけやすくすることが大切です。
一度にすべてを直そうとせず、小さく変更してその都度動作を確認しましょう。追加・表示・編集・削除、検索、保存、エラー表示を変更前後で確かめれば、アプリの使い勝手を保ちながらコードを整えられます。
