保守性・管理性が上がるPHPの書き方とは？

2014/08/13 10:50 | カテゴリー PHP | タグ | コメント

昨日、PHPの保守性・管理性が上がるPHPの書き方というブログ記事の話題がTLでありました。

どうも炎上して消されてしまったようですが、魚拓があるようです。
http://megalodon.jp/2014-0812-0928-28/bulkserver.jp/blog/2014/08/07/php-code/

あんまりよくない書き方が書かれていて、PHPを随分書いていない俺も卒倒してしまったので、ちょっと俺なりに書いてみようかなと思った次第。

保守性・管理性とは？

そもそも保守性・管理性とは何かと言えば、読みやすさ、理解しやすさ、思い出しやすさだと思います。先の記事がなんで話題になったのかというと、多分、保守性も管理性も乏しかったからです。「これはこう書けるよ」くらいの記事だったら、コーディングを少し減らせるとかでよかったのかもしれません（それでも話題にはなってたかもしれないけれど）。

こういう話は突き詰めていくと、リファクタリングのし易さだの、ユニットテストがあるかだの、フレームワークだの、CMSだの、そういう話になっていくのかもしれません。それが保守性・管理性を考えた上での先人たちの知恵の結晶だからです。しかし、それは後々の話題だと思います。

みんな、いいコード、綺麗なコードが書きたい

綺麗なコードってなんでしょうか？短くてもわかりにくいコードであれば、いいコードとは言えませんし、わかり易くても長ったらしいメソッドや重複があるコードはいいコードとは言いがたいでしょう。だからこそ、スマートな書き方を知りたいと思うのです。その向上心は素晴らしいと思いますので、大事にしていきましょう。

いいコードとは、何をしているのか、意味が伝わるものです。なので、短ければいいというものではありません。これはどの言語でも同じようなものだと思います。

PHPでの綺麗な書き方を考えてみる

いいコードとは、簡潔であること。意味がわかること。変更に強いことです。
ここで、Personクラスと、Pcクラスの2つのクラスを作ってみようと思います。

まずはPersonクラス。

SyntaxHighlighterについて
Personクラス
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?php
class Person {
    private $name;
    private $age;
    private $gender;
 
    function __construct($name, $age, $gender) {
        $this->name = $name;
        $this->age = $age;
        $this->gender = $gender;
    }
 
    function hello() {
        print "こんにちは、私の名前は{$this->name}です。年齢は{$this->age}歳の{$this->gender}です。\n";
    }
 
    function isMan() {
        return $this->gender === '男';
    }
 
    function isWoman() {
        return $this->gender === '女';
    }
 
    function toJson() {
        return json_encode(get_object_vars($this));
    }
}

次に、Pcクラス。

SyntaxHighlighterについて
Pcクラス
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
<?php
class Pc {
    private $cpu;
    private $memory;
    private $ssd;
 
    function __construct($cpu, $memory, $ssd) {
        $this->cpu = $cpu;
        $this->memory = $memory;
        $this->ssd = $ssd;
    }
 
    function showSpec() {
        print "cpu: {$this->cpu}\n";
        print "memory: {$this->memory}\n";
        print "ssd: {$this->ssd}\n";
    }
 
    function toJson() {
        return json_encode(get_object_vars($this));
    }
}

この2つのクラスは、人間とPCなので全く別の性質のクラスですね。

traitを使ってみよう(PHP5.4以上)

PersonクラスとPcクラスでは、同じ定義のメソッドがありました。toJsonメソッドです。
やってることも全く同じで、インスタンスがもつメンバ変数をjsonに変換するというものです。
よくあるサンプルだと、Animalという抽象クラスを作って、それをPersonクラスで継承、Dogクラスで継承して、共通処理はAnimalクラスで定義しておくというのがありますが、これは動物を継承したクラスだからイメージに合うわけですが、PcクラスでAnimalクラスを継承するのはおかしいですよね？でも、クラスの性質が違っても同じようなメソッドを定義することはよくあります。コピペすればすぐできるじゃん！で済まさず、traitにしてみましょう。

traitとは？

traitとは、実装の一部を共通化するための仕組みです。今回の例でいえば、toJsonメソッドのような共通で使えるメソッドを抽出して、各クラスで簡単に実装させることができます。Rubyではmoduleが同じような機能になります。

では、ToJsonImplトレイトを定義してみます。

SyntaxHighlighterについて
ToJsonImplトレイト
1
2
3
4
5
trait ToJsonImpl {
    function toJson() {
        return json_encode(get_object_vars($this));
    }
}

これを、Personクラスで利用してみましょう。traitを使う場合は、useと書きます。

SyntaxHighlighterについて
Personクラスの一部
01
02
03
04
05
06
07
08
09
10
11
12
13
class Person {
    use ToJsonImpl;
    private $name;
    private $age;
    private $gender;
 
    // 省略
 
//    ToJsonImpleトレイトで定義されたので削除する
//    function toJson() {
//        return json_encode(get_object_vars($this));
//    }
}

次に、Pcクラスでも使ってみます。

SyntaxHighlighterについて
Pcクラスの一部
01
02
03
04
05
06
07
08
09
10
11
12
13
class Pc {
    use ToJsonImpl;
    private $cpu;
    private $memory;
    private $ssd;
 
    // 省略
 
//    ToJsonImpleトレイトで定義されたので削除する
//    function toJson() {
//        return json_encode(get_object_vars($this));
//    }
}

これで、同じようなメソッドを毎回定義しなくてもよくなりました。
同じように、CSVで出力したいんだー！という声があったら、ToCsvImplトレイトを定義すれば、use ToCsvImplと書くだけでPersonでもPcでも、またこれ以降にできた新しいクラスでも使うことができます。便利ですね。

オーバーロードを使ってみよう

次に、__setメソッド, __getメソッドでのオーバーロードを使ってみようと思います。
これは、存在しないメンバ変数にアクセスされた場合の挙動を設定することができます。

Pcクラスでは、CPUとメモリとSSDだけをメンバ変数に持っていましたが、PCってもっと多くのパーツで作られていますよね？グラフィックボードがあったり、CPUファンがあったり、さらに外付けHDDがあったりなど、数え上げると結構な数になります。これらの項目を全て網羅してメンバ変数を作るのは大変です。

SyntaxHighlighterについて
メンバ変数が多すぎるPcクラス
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
class Pc {
    use ToJsonImpl;
    private $cpu;
    private $memory;
    private $ssd;
    private $gpu;
    private $cpu_fan;
    private $display_port1;
    private $display_port2;
    private $display_port3;
    private $display_port4;
    // 書ききれません
 
    // 省略
}

こういうとき、オーバーロードを使います。オーバーロードを使うと非常にシンプルに書く事ができます。

SyntaxHighlighterについて
オーバーロードを使ったPcクラス
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class Pc {
    use ToJsonImpl;
    private $properties = array();
//    もう使わないので後で削除する
//    private $cpu;
//    private $memory;
//    private $ssd;
 
    function __construct($cpu, $memory, $ssd) {
        $this->cpu = $cpu;
        $this->memory = $memory;
        $this->ssd = $ssd;
    }
 
    function __get($name) {
        return $this->properties[$name];
    }
 
    function __set($name, $value) {
        $this->properties[$name] = $value;
    }
 
    function showSpec() {
        print "cpu: {$this->cpu}\n";
        print "memory: {$this->memory}\n";
        print "ssd: {$this->ssd}\n";
    }
}

$this->cpu = $cpu; が呼ばれると、__set($name, $value)が呼ばれます。
$nameには”cpu”が、$valueには$cpuに代入されている値が入っています。
結果、$this->properties[“cpu”] = $cpu;というふうになり、properties配列の中にいくらでも値を保存できるようになりました。

そして、$this->cpuを呼ぶと、今度は__get($name)が呼ばれます。
$nameには”cpu”が入っていますから、return $this->properties[“cpu”];というふうになり、properties配列の好きな要素にアクセスできるようになりました。
数えきれないほどのメンバ変数を作るよりは見た目も綺麗だし、新しい要素が増えても、コードの修正は特にありません。

計画性のないオーバーロードは危険

しかしこのままだと、$this->propertiesはなんでもはいる状態です。

SyntaxHighlighterについて
1
$this->rice = "コシヒカリ";

と書いても、入ってしまいます。Pcにriceというメンバ変数があってはダメでしょう…。
なので、制限を入れようと思います。

SyntaxHighlighterについて
制限を付けたオーバーロード付きPcクラス
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class Pc {
    use ToJsonImpl;
    private static $PROPERTY_NAMES = array('cpu', 'memory', 'ssd');
    private $properties = array();
 
    function __construct($cpu, $memory, $ssd) {
        $this->cpu = $cpu;
        $this->memory = $memory;
        $this->ssd = $ssd;
    }
 
    function __get($name) {
        return $this->properties[$name];
    }
 
    function __set($name, $value) {
        // PROPERTY_NAMESにある項目しか許可しない
        if (in_array($name, self::$PROPERTY_NAMES)) {
            $this->properties[$name] = $value;
        }
    }
 
    function showSpec() {
        print "cpu: {$this->cpu}\n";
        print "memory: {$this->memory}\n";
        print "ssd: {$this->ssd}\n";
    }
}

PROPERTY_NAMESに含まれている項目のみ、許可するようにしてみました。
これで、$this->rice = “コシヒカリ”;と書いても無視されます。
変な要素が入れられそうなら、例外を発生させることも、__setメソッド内でできるので、ケースによってはそういう実装もありだと思います。

こうすることで、保守対象はPROPERTY_NAMESのみになります。楽ですねぇ。

メタプログラミングしてみよう。

さて、あとはPcクラスで気になるのは、showSpecメソッドです。

SyntaxHighlighterについて
showSpecメソッドがベタ書きで辛い
1
2
3
4
5
6
7
8
9
class Pc {
    // 省略
 
    function showSpec() {
        print "cpu: {$this->cpu}\n";
        print "memory: {$this->memory}\n";
        print "ssd: {$this->ssd}\n";
    }
}

Pcクラスのメンバ変数はオーバーロードによっていくつになるかわからなくなりました。PROPERTY_NAMESによって制限は入れているものの、じゃあgpuを追加したら、showSpecメソッドにgpuの項目を出力するprint文を書くか？と言われたら辛いですね。
そこで、メタプログラミングをしてみましょう。

メタプログラミングとは、メタデータを使ったプログラミングです。ここでは、クラスに付随した情報を元に、showSpecメソッドを書き換えてみます。

SyntaxHighlighterについて
メタプログラミングに変更したshowSpecメソッド
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class Pc {
    // 省略
 
    function showSpec() {
        $this->showDetail(get_object_vars($this));
    }
 
    private function showDetail($properties, $depth=0) {
        $printTab = function($depth){
            for($i = 0; $i < $depth; $i++) {
                print "\t";
            }
        };
        foreach($properties as $key => $value) {
            if (is_array($value)) {
                $printTab($depth);
                print "{$key}:\n";
                $this->showDetail($value, ++$depth);
            } else {
                $printTab($depth);
                print "{$key}: {$value}\n";
            }
        }
    }
}

get_object_vars($this)によって、自身のメンバ変数とその値を配列で取得します。
ここがメタプログラミングです。
とはいってもPcクラスのメンバ変数はpropertiesのみになったので、propertiesとその値の配列が返ります。
privateメソッドのshowDetailメソッド内で、再帰的に呼び出しています。
無名関数を使って、タブを出力するものも作ってみました($printTab)。このメソッド内でしか使わない関数は、使い捨ての関数なのでこのように定義すると、他のところで利用されないため、他のプログラムに影響しなくなります。節度を守って使いましょう。

これを使ってみましょう。

SyntaxHighlighterについて
showSpecしてみる
1
2
$pc = new Pc("Celeron", "4GB", "128GB");
$pc->showSpec();

結果は以下のようになります。

properties:
	cpu: Celeron
	memory: 4G
	ssd: 128GB

ここで、Pcクラスにhddというパラメーターを追加したいと思います。hddは複数持つ事があるので、配列とします。

SyntaxHighlighterについて
01
02
03
04
05
06
07
08
09
10
11
12
13
14
class Pc {
    use ToJsonImpl;
 
    // hddを追加
    private static $PROPERTY_NAMES = ['cpu', 'memory', 'ssd', 'hdd'];
    private $properties = array();
 
    function __construct($cpu, $memory, $ssd, $hdd=array()) {
        $this->cpu = $cpu;
        $this->memory = $memory;
        $this->ssd = $ssd;
        $this->hdd = $hdd;
    }
}

では、また同じようにやってみましょう。

SyntaxHighlighterについて
showSpecしてみる
1
2
$pc = new Pc("Celeron", "4GB", "128GB", array("1TB", "1.5TB", "500GB"));
$pc->showSpec();

結果は以下のようになります。

properties:
	cpu: Celeron
	memory: 4G
	ssd: 128GB
	hdd:
		0: 1TB
		1: 1.5TB
		2: 500GB

以上です。
traitやオーバーロード、メタプログラミング、再帰処理は、うまく活用すれば保守性・管理性も上がります。しかし、これらを無理矢理使ってやろうと固執してはいけません。保守しやすいかどうかは、そのコードに関わっている人のレベルにもよります。奇をてらったコーディングはしないようにしましょう。

このエントリーをはてなブックマークに追加

関連する投稿一覧：

  1. CakePHP:【解決】AU携帯でSecurityComponent
  2. CakePHP:Validatorコンポーネント作成
  3. CodeIgniter: hookを使ってbefore_filterやってみる。
  4. CodeIgniter: migrationをしてみる
  5. firebug: consoleがundefinedの場合
カテゴリー PHP | タグ | パーマリンク

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です