開発全般 2015/11/25

HTML5カンファレンスで貰った新装版リファクタリングを10ヶ月ぶりに読んでみた

プロジェクトで使用しているとあるライブラリの作者さんに「いやーこのライブラリまだ需要あったんすねｗ」と言われてしまったしょっさんです。

さて、今回は2015/01/25に開催されたHTML5カンファレンス内でのプレゼント企画で、１等とも言うべき品を引き当てたにも関わらず10ヶ月間読まなかったクズがお送りする、新装版リファクタリングのポイントを列挙していく記事になります。

↓こんな本

新装版リファクタリング既存のコードを安全に改善する

この本はリファクタリングを扱った数少ない本の一つで、かなりの人気がある本です。（特にJavaプログラマに）

サンプルコードなどJavaで書かれていますが、他言語のプログラマでも十分有用な内容が満載の本になっております。

それでは私が読んでみて気になったポイントを挙げていきます。

新たなバグを混入させない

リファクタリングはコードをより良く再設計・再構築する作業になります。
そのため、元のコードから大きく変化する場合があるのでバグが新しく混入（エンバグ）する可能性が大きくあります。

では、どのようにしてこのエンバグを防ぐことが出来るのでしょうか？
答えは簡単。

「テストを書くこと」

リファクタリング前には必ずインプット・アウトプットはこうあるべき、というテストを書くこと。
（メソッドなどの小さい単位でのユニットテストですね）
そうすることで、「リファクタリング前は動いていたのにリファクタリング後に動かなくなった・・・」という事態は防ぐことができるはずです。
テスト作成に時間がかかっても良いので、リファクタリングを行う前にはテストを書くようにしましょう。

リファクタリングとパフォーマンスはトレードオフではない

しばしばリファクタリングを行ったせいでパフォーマンスが落ちたということを聞くことがあります。
リファクタリングの本懐は、再設計・再構築によってよりコードを見やすく、分かりやすくすることですので、
確かにパフォーマンスを蔑ろにすることがあります。

しかし、パフォーマンスを盾にしてリファクタリングを避ける事は賢明な判断と言えるでしょうか？
答えはNOです。

リファクタリングは「本来の最適な形に戻す」作業とも言えるので、「最適ではない形」の上で行われたパフォーマンス最適化は理に適っていません。
更に、本書にもあるようにパフォーマンスに関わるようなコードは全体のうちの１割程度で、その１割に対してリファクタリングが影響を与える可能性は低いとも考えられます。

ですので、リファクタリングを行う上でパフォーマンス云々と言われた場合は「まずリファクタリングを行い、その上でパフォーマンス向上を目指す」がベストアンサーでしょう。

デザインパターンを学ぼう

リファクタリングが目指すべき形の一つにデザインパターンがあります。
デザインパターンとはGoF（Gang of Four）と言われる４人が、コードの典型的な解決方法をまとめたテンプレート集のようなものです。

ちなみに本書の中で閑話休題として、何故リファクタリングというものが生まれたのかGoFを絡めたお話が載っていますのでこれは是非とも本書を買って読んで頂きたいです。

デザインパターンを用いることでリファクタリングの正解パターンがすいすい分かるようになりますので、デザインパターン本も本書と合わせて読むとGoodです。

↓有名なGoFデザインパターン本
「オブジェクト指向における再利用のためのデザインパターン」

リファクタリングのタイミングは？

リファクタリングをするべきタイミングってなかなか難しいですよね。
「凄くリファクタリングしたいコードを見つけたけど、今はこっちの開発が・・・」といったことがよくあると思います。
そんな時は以下の３つのタイミング指針を参考にしてみてください。

３度目の法則
もしあるコードに対してリファクタリングしたい！と思うことが計３回あれば、３回目の時がリファクタリングタイミングです。
機能追加時
機能追加する時が関連するコードをリファクタリングするタイミングです。
理由は２つあり、１つ目は元のコードの理解のためで、２つ目は機能追加をしやすくするためです。
コードレビュー時
コードレビューの文化が根付いているチームならコードレビュー時もリファクタリングのタイミングになります。
ここでのリファクタリングはどちらかと言えばベテランが新人に対して良いコードを教えるためのものと言った方が良いかもしれません。

コードの不吉な匂い

本書ではコードをリファクタリングした方が良いと判断する基準として、「コードの不吉な匂い」を挙げています。
単純にプログラマの好みによるところではなく、このコードは直したほうが良い！という指針を様々な種類別に書いています。
これを見ながらリファクタリングしていくことで、コードの不吉な匂いに対する嗅覚が磨かれると思います。

コードの不吉な匂いの項についてあえて詳しくは述べませんが、リファクタリングを一度でもやったことがある人にとっては「あるある」が詰まったTipsが多いと思います。