BEAR Blog

Because everything is a resource.

Timeアノテーション

| Comments

PHPメンターズのブログで時計オブジェクト(ドメインクロック)を導入してテスト容易性と意図性を高めるという記事が掲載されました。

この記事のように、現在時刻をアプリケーションでどう扱うかをBEAR.SundayのSandboxアプリケーションで見てみます。

@Timeアノテーション

現在時刻文字列を扱いたいクラスにはpublicのtimeプロパティを追加しメソッドにBEAR\Sunday\Annotation\Timeアノテーションを注記(アノテート)します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
use BEAR\Sunday\Annotation\Time;
    /**
     * Current time string
     *
     * @string
     */
    public $time;
    /**
     * @Time
     */
    public function onPut($id, $title, $body)
    {
        $this->time; // 2013-04-03 19:37:40
    }

するとこのメソッドがコールされたタイミングでtimeプロパティに現在時刻が代入されるようになます。メソッド内ではそのプロパティを利用するだけです。

テストコードでは以下のようにpublicプロパティに値を代入します。1 テストは容易に行う事ができます。

1
2
 $user = new User;
 $user->time = "2013-04-03 19:37:40";

DI ? AOP ?

働きとしてはプロパティに依存が代入されるプロパティ・インジェクションなのですが2 、BEAR.SundayではこれをRay.Aopで行っています。メソッドに束縛されたインターセプターが現在時刻をインジェクション(外部から代入)しています。

TimeStamper

BEAR\Package\Module\Database\Dbal\DbalModuleモジュールでDoctrin DBALモジュールを利用するためにDIとAOPの設定を行っていますが、このモジュール内で@Timeとアノテートされたメソッドと現在時刻を代入するインターセプターが束縛されています。

1
2
3
4
5
$this->bindInterceptor(
    $this->matcher->any(), // どのクラスでも
    $this->matcher->annotatedWith('BEAR\Sunday\Annotation\Time'), //@Timeとアノテートされてるメソッドに
    [new TimeStamper] // TimeStamperを束縛
);

TimeStamperは元メソッドのtimeプロパティに現在時刻をセットするだけの単純なインターセプターです。

1
2
3
4
5
6
public function invoke(MethodInvocation $invocation)
{
    $object = $invocation->getThis(); // 元オブジェクト
    $object->time = date("Y-m-d H:i:s", time());  // 現在時刻代入
    return $invocation->proceed(); // 元メソッド実行して返す
}

おわりに

この記事では現在のSandboxアプリケーションで行っている現在時刻文字列を取り扱いましたがこれを\DateTimeにすれば時計オブジェクト(ドメインクロック)を導入してテスト容易性と意図性を高める記事の中のドメインクロックと同じになると思います。

現在時刻を必要とするメソッドに@Timeと注記しその依存を利用する事でテスト容易性(testability)とコードの意図性(intentionality)が実現されています。

また時刻を用意するという関心を1つのメソッドに集約することでフォーマットの一括変更が可能になるのと同時に、その適用を任意に束縛して決定しているのでアプリケーションコンテキストやメソッド・クラス名に応じて変更する柔軟性も確保しています。

  1. セッターメソッドを用意してもいいでしょう []
  2. Ray.Diではプロパティ・インジェクションをサポートしていません []