モンスターメソッドを防ぐために

モンスターこの私のかわいいひと〜♪

モンスターメソッドとは
PhpStormのリファクタ機能
モンスター化を防ぐために
既存のモンスターメソッドを小さいメソッドに分ける
1. 理解している2〜5行の範囲を切り出す

モンスターメソッドとは

行数の多いメソッドのことです。

モンスターメソッドを修正したり、新機能を追加したりするには、時間がかかるようになります。

モンスターメソッドを小さいメソッドに切り分けることも、とても難しい作業で、これも時間がかかります。

ところが、リファクタの効果を実感できるのは開発者だけで、上層部は実感できません。また、費用対効果の説明が難しいので、上層部はリファクタのスケジュールをとりたがりません。モンスターメソッドのリファクタの機会はないと思ったほうがいいでしょう。

つまり、モンスターメソッドに追加修正するたびに、開発者は苦労して理解しなければなりません。

そうならないために、日頃からモンスターメソッドにしないように努力するしかありません。

「モンスターメソッド」という言葉を広めたのは、「レガシーコード改善ガイド原著2004」と言われています。

第22章 モンスターメソッドを変更する必要がありますが、テストを書くことができません
レガシーコード改善ガイド原著2004

17年前にモンスターメソッドとの戦い方が体系的にまとめられたのね

だけど、今でもモンスターメソッドを根絶できないんだね

コンパイラやインタープリタが100行以上のメソッドを文法エラーにしてほしいわ

もしそうなったら、1行に全部つめこんじゃおう😜

（100行以上のメソッドに）
メソッド長すぎ！
メソッドの処理内容が多すぎるね。
ヘルパーメソッドに分割して、行数を小さくしよう。
コードチェッカー phpmd

我々は１行２行でもヘルパーメソッドに分ける。
そのドメインの言葉でメソッド名をつけることで、
一種のDSL（ドメイン固有言語）を作っているのだ
実践テスト駆動開発原著2009

（メソッドではなく）クラスは最大50行まで
ThoughtWoksアンソロジー原著2008

100行に及ぶメソッドを再利用できる機会はない
ThoughtWoksアンソロジー原著2008

さまざまな文脈で利用できるのは、3行のメソッド
ThoughtWoksアンソロジー原著2008

リーダブルコード原著2011の10章「無関係の下位問題を抽出する」では、長いメソッドから汎用コードを分離する過程を説明しています。しかし、汎用コードになっていなくてもかまいません。メソッドの行数の上限を100行と決めて、機械的にメソッドを短く維持するだけでも、その価値があります。

また、10.8「やりすぎ」の節は無視してください。やりすぎるくらい、メソッドを小さくしていいと思います。

PhpStormのリファクタ機能

メソッドに分けたい範囲を選択します。
メニュー＞Refactor＞Refactor this...
Extract Method...

メソッド名を入力します。
ローカル変数の値を変更していると、返り値で返すか、参照渡しか、を選びます。特に理由がなければ、返り値を選びます。
Refactorボタンをクリックします。

選択した範囲が、新メソッドの呼び出しに置換されます。
ファイル末尾に新メソッドが追加されます。

モンスター化を防ぐために

モンスターメソッドにコードを追加するとき、２つの方法があります。

まず、新メソッドを作る方法

１つめの方法は、まず新メソッドを追加し、新メソッドに必要なコードを実装します。モンスターメソッドに新メソッドを呼び出すコードを書きます。

新しく追加するコードが、元のモンスターメソッドのコードと比較的独立しているときは、最初から新メソッドに実装します。

元のコード

public function monster()
{
    ...
    ...
}Code language: PHP (php)

新メソッドを作って、コード追加

public function monster()
{
    ...

    ...
}

ptotected function fooFeature($params)
{
    // 追加コード
}
Code language: PHP (php)

元のメソッドに、新メソッド呼び出しを追加

public function monster()
{
    ...

    // 元のメソッドには、新メソッドの呼び出しだけ
    $this->fooFeature($params);

    ...
}

ptotected function fooFeature($params)
{
    // 追加コード
}
Code language: PHP (php)

モンスターメソッドに実装してから、新メソッドに切り出す方法

２つめの方法は、モンスターメソッドに必要なコードを実装します。次に、追加した部分をIDE（PhpStorm）のリファクタ機能を使って、新メソッドに分けます。

新しく追加するコードが、元のモンスターメソッドのローカル変数と密接な関係があるときは、２つめの方法がいいでしょう。

元のコード

public function monster()
{
    ...
    ...
}Code language: PHP (php)

元のメソッドにコード追加

public function monster()
{
    ...

    if (...) {
        // 追加コード
    }

    ...
}Code language: PHP (php)

リファクタ後のコード

public function monster()
{
    ...

    // 元のメソッドには、新メソッドの呼び出しだけ
    $this->fooFeature($params);

    ...
}

ptotected function fooFeature($params)
{
    // 追加コード
}
Code language: PHP (php)