# リファクタリングとは

ソフトウェアの外部に対する動作を変更せずに内部の構造を整理し、理解と変更を容易にする改修です。機能は増加しませんが、以後の機能追加や修正の手間を削減します。

## リファクタリングとは

リファクタリングは、利用者に対する動作を維持したまま内部の構造を改修し、理解と変更の費用を削減することです[^fowler-definition]。
利用者が操作する画面や計算の結果など、外部から確認できる動作は変化しません。

たとえば請求書の発行の処理で、消費税の計算が5か所に複製されているとします。
税率や端数の処理の変更では5か所の修正が必要になります。
1か所でも修正が欠落すれば計算の誤りになります。
この計算を1か所に集約する改修がリファクタリングで、改修の前後で発行される請求書の金額は同一です。
以後、共通の計算処理の変更は1か所に集約されます。

![改修の前は消費税の計算が5か所、改修の後は1か所で、どちらも請求書の金額は同じであることを示す比較](https://media.marketing.kdotdev-tunnel.org/glossary-refactoring-151b310e63e8684ce05479166d3290d996f95b7924cd3792cd4a4bbf7418a2be.png)

上位の語はリストラクチャリングです。
リストラクチャリングは、外部に対する動作を保持するかに関係なく、内部の構成要素の配置や分割を変更する作業全般を指します。
リファクタリングはそのうち、外部に対する動作を保持する小規模な変更を反復し、変更ごとにテストで動作を確認する方法です[^fowler-malapropism]。
変更を小規模に分割して変更ごとにテストするため、不具合の原因となった変更を特定しやすく、システムが動作しない状態も短時間で解消できます[^fowler-malapropism]。

![リストラクチャリングの中に、小規模に変更し、テストで動作を確認し、反復するリファクタリングがあることを示す図](https://media.marketing.kdotdev-tunnel.org/glossary-refactoring-8ad981b626dff852063da758acec6114cec59c09a310bc9018e4368a0dc5687a.png)

## なぜ必要か

ソフトウェアは機能の追加と修正の回数が増加するほど、内部の構造が当初の設計から乖離しやすくなります。
同じ処理の複製、意味の不明な名前、1つの変更が多数の箇所に波及する構造が増加すると、機能追加の期間が長期化し、修正のたびに別の箇所で不具合が発生しやすくなります。
この状態は技術的負債と呼ばれ、リファクタリングはその返済の主要な手段です。

要件は開発の途中で変化し、作業の中で構造の改善点が判明することもあります。
要件や運用の理解が変化し、既存の構造が次の変更の手間を増大させているなら、その箇所をリファクタリングの対象にします。

![複製・不明な名前・変更の波及が、機能追加の長期化と別の箇所の不具合の両方の原因になることを示す図](https://media.marketing.kdotdev-tunnel.org/glossary-refactoring-3a5e12770f1fea3cc1ce75226e66cfd9e5fd4072f7826f65d74733203454b303.png)

## 効果

内部の構造を整理することで、次の効果を目標にします。

- 変更の多い箇所の機能追加と修正が迅速になる
- 1つの修正が別の箇所に不具合を発生させる事態が減少する
- 担当の交代や新規の開発者の参加のときに、コードを把握する期間が短縮する

![消費税の計算の例で、修正する実装は5か所から1か所になり、利用する箇所の確認は整理の後も必要であることを示す表](https://media.marketing.kdotdev-tunnel.org/glossary-refactoring-02a435efee62ea57f4f9226aba00f882e65c9845eff310b22fde6dcc0c6f69c5.png)

## コストとリスク

- 改修の工数: 構造の整理と動作の確認に工数がかかり、その間に開発できる新機能の量は減少する
- 確認と調整の工数: 改修の前後で同じ入力から同じ結果になることを自動テストで確認できない箇所では、先にそのテストを整備する工数がかかる。同じコードを並行して変更する作業では、変更のマージで競合が発生することがあり、その調整も必要になる[^fowler-opportunistic]
- 際限のない改修: 1か所を整理すると、周辺のコードの不明瞭さや重複という次の改善点が判明し、終了の時期が不明確になることがある[^fowler-opportunistic]。範囲と期限を規定せずに開始すると、機能の開発が長期間停滞する
- 効果の説明: 利用者の画面には変化がないため、効果は変更や影響の調査に要する工数、不具合の件数で説明する

![リファクタリングに必要な工数である改修や確認と調整、管理するリスクである際限のない改修や効果を示しにくいことを2群で示す図](https://media.marketing.kdotdev-tunnel.org/glossary-refactoring-fb7f1a1969394a8107601aad8455be0d2ba2d1648dd615df974e2c645211fef4.png)

## リファクタリングの時間の確保

リファクタリングの多くは、機能の追加や不具合の修正の作業の一部として実施します[^fowler-opportunistic]。
機能の追加の前に、追加しやすい形に既存の構造を整理し、作業の完了の前に重複を整理します。
この工数は通常の見積もりに含めます。
事業側が確認すべき点は、見積もりからリファクタリングの分を削除しないことです。

今後必要な変更で削減できる手間が、改修とテストにかかる工数を上回る場合は、独立した期間と予算で大規模に改修します。
変更ごとに調査と確認に余分な工数がかかり、同規模の機能追加で見積もる工数が以前より増加している箇所が候補です。
決済、料金計算、在庫の引き当てのように、誤りの影響が重大な箇所は優先度が高くなります。

今後の変更がほとんどない箇所は、構造の乱雑さだけを理由に整理しません[^fowler-opportunistic]。
残りの利用期間に予想される変更の手間より改修の費用が上回る場合も、優先しません。

![作業中の整理の可否と、削減工数と改修工数の比較で、見積もりに含めた整理、独立の予算での改修、独立改修の見送りの3つに分岐する判断の流れ](https://media.marketing.kdotdev-tunnel.org/glossary-refactoring-242d0c543c121260389f8acba25323653c7bb71d84c9da0f20ed4fee2a8d6a7e.png)

## よくある誤解

### リファクタリングは機能の追加や不具合の修正を含む

リファクタリングは動作を変更しない改修です。
同じ作業の中で機能も追加するなら、それは機能の開発です。
リファクタリングと機能追加の変更を区別して記録すると、不具合が発生したときに、動作の変更を伴う変更から先に調査するなど、調査の優先順位を設定しやすくなります。

### 内部の大規模な改修はすべてリファクタリングである

内部の大規模な改修を、すべてリファクタリングとは呼びません[^fowler-malapropism]。
違いは作業の規模ではなく、動作を保持する小規模な変更と確認を反復しているかです。
大規模な改修の提案がリファクタリングと呼ばれていれば、どの単位で動作を確認し、どの単位で本番に反映するかを確認します。

### 熟練した開発者が記述したコードにリファクタリングは不要である

要件の変化と運用で得た知見に応じて、構造の最適な形は変化します。
たとえば請求書の例で、当初は1か所だった消費税の計算に、取引先ごとの端数の処理が追加されると、計算の分岐が複数の箇所に分散することがあります。
この場合は最初の設計の質と関係なく、分散した計算の集約など、次の変更を容易にする改修を検討します。

[^fowler-definition]: [Definition Of Refactoring](https://martinfowler.com/bliki/DefinitionOfRefactoring.html)（Martin Fowler、2004年9月）
[^fowler-malapropism]: [Refactoring Malapropism](https://martinfowler.com/bliki/RefactoringMalapropism.html)（Martin Fowler、2004年1月）
[^fowler-opportunistic]: [Opportunistic Refactoring](https://martinfowler.com/bliki/OpportunisticRefactoring.html)（Martin Fowler、2011年11月）
