とっとこ駆け出しエンジニアぶろぐ: デザインパターン Observerパターンをやってみた

GoFのデザインパターンの一つ、振る舞いに関するパターンであるObserverパターンをやってみました。
Observerパターンは、オブジェクト指向のポリモフィズムを利用したパターンになります。
実装はPHPです。

##### 環境構成
* PHP 5.4

<br>
##### Observerパターンとは？
Observerとは、観察者や観測者という意味です。  
Observerパターンは、GoFのデザインパターンの一つで、あるオブジェクトの状態に変化があった場合、
それを観測する人がいてそれに合わせて、別のオブジェクトの状態を変化させるパターンです。

<br>
説明がかなり分かりにくいですね（＾＾；  
AというオブジェクトがあってAの状態(プロパティ)が変化すれば、
それにあわせてBというオブジェクトの振る舞いを変化しなければならない協調動作の関係にあるとき
クラス間の依存度は高くなってしまい再利用性が低くなってしまいます。  
また協調動作するオブジェクトが増えるほど、コードがカオスになっていきます。  
AとA'の状態が変化すればBとB'の振る舞いも変化しなければならない。  
そんな時にObserverパターンを使うことで、再利用性を保ちながら協調動作を行えます。  
Observerパターンは、状態変化に応じた処理を行う場合に有効なパターンです。  
<br>

##### クラス図
Observerパターンをクラス図にするとこんな感じになります。  
<a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjx0exvMcZlFHUGQ5u2huZWPaEc3sJvWsgbFDRz1Bb_jZ1nULCrBays8GeaY4gQd48WsNJt5S3L6B9qPEV1C28E5-ET4vEry5uoKSa80az4J-SOaKumErXpQTVABqZcSrWBk2drZnGByitK/s800/Observer.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjx0exvMcZlFHUGQ5u2huZWPaEc3sJvWsgbFDRz1Bb_jZ1nULCrBays8GeaY4gQd48WsNJt5S3L6B9qPEV1C28E5-ET4vEry5uoKSa80az4J-SOaKumErXpQTVABqZcSrWBk2drZnGByitK/s800/Observer.png" /></a>
<br>
個々の責務について説明します。

#### Subject
Subjectは、観測の対象者で、観測者であるObserverへのインタフェースを定義します。  
Subjectは、状態の変化が起こった場合、Observerに通知(notify)する必要があります。  
観測という言葉からObserverが、状態の変化をキャッチして処理を実行するように思えますが、観測対象からの通知を観測するという解釈です。  
<br>

#### Observer
Observerは、観測者でSubject からの通知(notify)で、処理する(update)インタフェースが定義します。  
Observer自体は、Subjectから処理してくださいと通知を受け処理するインターフェースのみです。  
<br>

#### ConcreteSubject
ConcreteSubjectはSubjectのサブクラスで、Observerが観測したい状態を持ち、Observerに対して通知を行います。  
<br>

#### ConcreteObserver
ConcreteSubjectは、Observerのインターフェースを実装しているクラスで、状態変化の通知を受け具体的な処理(update)を行う。  
<br>
<br>
再利用性を保ちながら協調動作を行うというのは、クラス図を見て分かる通り、
ConcreteSubjectクラスとConcreteObserverクラスの間に直接的な結びつきはありません。  
両クラスをインターフェースによって間接的に結びつけているのが、個々の親クラスであるSubjectクラスとObserverクラスになります。  
このインターフェースが守られている限り、機能拡張・修正がしやすくなります。  
<br>
##### PHPでサンプルを実装してみた
PHPでObserverパターンを使ったサンプルを作ってみました。  
<br>
ー 要件ー  
ECサイトだと仮定して進めます。  
* 会員は商品を購入できる  
* 商品購入時に、購入回数に応じてクーポン割引をする(5回購入で、クーポン割引 販売価格から1割引)  
* 商品購入時に、購入回数に応じて会員グレードがGoldになる(50回購入で、会員グレードがGold)  
* 商品購入時に、会員グレードがGoldなら割引をする

<br>
とまあ、雑な要件でまとめましたが、今回のケースだと商品購入回数が状態の変化で、
変化を受けた通知を受けてクーポン割引したり会員グレードをGoldにしたりします。  
<br>
#### Subject

abstract class Member
{
    private $_observers;
    private $_paymentCount;
    private $_coupon;

public function __construct($paymentCount)
    {
        $this->_observers = [];
        $this->_paymentCount = $paymentCount;
        $this->_coupon = [];
    }

public function addObserver(MemberObserver $observer)
    {
        $this->_observers[get_class($observer)] = $observer;
    }

public function removeObserver(MemberObserver $observer)
    {
        $this->_observers[get_class($observer)] = $observer;
    }

protected function payment($itemId)
    {
        // $itemIdを元に金額をDBから取得したものとする
        $amount = 500;
        $this->incrementPaymentCountByOne();
        $this->notify();
        if ($this->_coupon instanceof Coupon) {
            return $this->_coupon->discount($amount);
        }

return $amount;
    }

protected function notify()
    {
        foreach ($this->_observers as $observer) {
            $observer->update($this);
        }
    }

public function setCoupon(Coupon $coupon)
    {
        $this->_coupon = $coupon;
    }

protected function incrementPaymentCountByOne()
    {
        $this->_paymentCount++;
    }

public function getCameCount()
    {
        return $this->_paymentCount;
    }
}
</script>

Observerの登録(addObserver)/削除(removeObserver)/通知(notify)のインターフェースを持っています。  
商品の購入(payment)で、状態である購入回数($_paymentCount)が変化し
登録している全Observerに通知がいくことになります。  
<br>

#### Observer

interface MemberObserver
{
    public function update(Member $member);
}
</script>

Observerは、通知を受けたら処理(update)するインターフェースのみ。

<br>

#### ConcreteSubject
<script type="syntaxhighlighter" class="brush:php" title="NormalMember.php">
<?php

require_once 'Member.php';

class NormalMember extends Member
{
    public function payment($itemId)
    {
        return parent::payment($itemId);
    }
}
</script>

require_once 'Member.php';

class GoldMember extends Member
{
    public function payment($itemId)
    {
        $amount = parent::payment($itemId);

return $amount - 100;
    }
}
</script>

普通の会員とGoldグレードの会員のクラス。  
ポリモフィズムを利用しています。  
商品購入時に、会員グレードがGoldなら割引をしています。  
<br>

#### ConcreteObserver
<script type="syntaxhighlighter" class="brush:php" title="CouponObserver.php">
<?php

require_once 'MemberObserver.php';
require_once 'Coupon.php';

class CouponObserver implements MemberObserver
{
    public function update(Member $member)
    {
        if (($member->getCameCount() % 5) === 0) {
            $member->setCoupon(new Coupon);
        }
    }
}
</script>

require_once 'MemberObserver.php';

class GradeObserver implements MemberObserver
{
    const GRADE_UP = 50;

public function update(Member $member)
    {
        if ($member->getCameCount() == self::GRADE_UP) {
            // 会員ランクを昇格させる
            echo 'Grade Up';
        }
    }
}
</script>

CouponObserverクラスは、5回購入で、クーポン割引をし、
GradeObserverクラスは、50回購入で、会員グレードをGoldにします。  
<br>

#### クーポン
<script type="syntaxhighlighter" class="brush:php" title="Coupon.php">
<?php

class Coupon
{
    public function discount($amount)
    {
        return (int)ceil($amount * 0.9);
    }
}
</script>

Observerパターンに関係無いですけど、一応クーポンの実装。  
<br>

#### テスト
<script type="syntaxhighlighter" class="brush:php" title="Coupon.php">
<?php

require_once 'NormalMember.php';
require_once 'GoldMember.php';
require_once 'CouponObserver.php';
require_once 'GradeObserver.php';

class ObserverTest extends PHPUnit_Framework_TestCase
{
    /**
     * @test
     */
    public function Observerテスト()
    {
        // クーポン割引かつグレードアップ
        // ゴールド会員割引は次回から
        $paymentCount = 49;
        $normalMember = new NormalMember($paymentCount);
        $normalMember->addObserver(new CouponObserver());
        $normalMember->addObserver(new GradeObserver());

$itemId = 'D1';
        $this->assertSame(450, $normalMember->payment($itemId));

// ゴールド会員割引
        $paymentCount = 133;
        $goldMember = new GoldMember($paymentCount);
        $goldMember->addObserver(new CouponObserver());
        $goldMember->addObserver(new GradeObserver());

$itemId = 'E1';
        $this->assertSame(400, $goldMember->payment($itemId));

// ゴールド会員割引かつクーポン割引
        $paymentCount = 149;
        $goldMember = new GoldMember($paymentCount);
        $goldMember->addObserver(new CouponObserver());
        $goldMember->addObserver(new GradeObserver());

$itemId = 'E1';
        $this->assertSame(350, $goldMember->payment($itemId));
    }
}
</script>

テスト書いたので、一応貼っておく。  
TDDっぽくコード書いていきましたけどもっと良いコードが書けるようになりたい。(テストを書くのが目的でないのでDataProvider使ってないです)  
<br>
俺ならもっとエレガントなコード書けるぜという方はプルリクお待ちしています。  
https://github.com/hamuhamu/ObserverSample  
<br>
##### まとめ
Observerパターンをはじめてやってみましたが、スーパークラスであるSubjectとObserverが、インターフェースを通じて
やり取りするので、サブクラスであるConcreteSubjectとConcreteObserverは、
お互いを認識する必要はないので、機能拡張・修正がしやすいということがわかった。  
<br>
##### 最近読んだ本

とっとこ駆け出しエンジニアぶろぐ

2014年11月18日火曜日

デザインパターン Observerパターンをやってみた

0 件のコメント :

コメントを投稿