PHP設計パターンシリーズ -- 仕様パターン

1. モード定義

仕様モードは、組み合わせモードの拡張と考えることができます。プロジェクト内の特定の条件によってビジネス ロジックが決定される場合がありますが、これらの条件を抽出して特定の関係 (AND、OR、NOT) で組み合わせることで、ビジネス ロジックを柔軟にカスタマイズできます。さらに、クエリやフィルタリングなどのアプリケーションでは、論理的な判断文を使用する代わりに、複数の条件を事前に定義し、それらの条件の組み合わせを使用してクエリやフィルタリングを処理することにより、実装ロジック全体を簡素化できます。

ここでの各条件は仕様であり、複数の仕様/条件が直列に接続されて、特定の論理関係を持つ組み合わせ仕様を形成します。

2. UML クラス図

3. サンプルコード

item.php

<?phpnamespace DesignPatterns\Behavioral\Specification;class Item{    protected $price;    /**     * An item must have a price     *     * @param int $price     */    public function __construct($price)    {        $this->price = $price;    }    /**     * Get the items price     *     * @return int     */    public function getPrice()    {        return $this->price;    }}

SpecificInterface.php

<?phpnamespace DesignPatterns\Behavioral\Specification;/** * 规格接口 */interface SpecificationInterface{    /**     * 判断对象是否满足规格     *     * @param Item $item     *     * @return bool     */    public function isSatisfiedBy(Item $item);    /**     * 创建一个逻辑与规格（AND）     *     * @param SpecificationInterface $spec     */    public function plus(SpecificationInterface $spec);    /**     * 创建一个逻辑或规格（OR）     *     * @param SpecificationInterface $spec     */    public function either(SpecificationInterface $spec);    /**     * 创建一个逻辑非规格（NOT）     */    public function not();}

AbstractSpecific.php

<?phpnamespace DesignPatterns\Behavioral\Specification;/** * 规格抽象类 */abstract class AbstractSpecification implements SpecificationInterface{    /**     * 检查给定Item是否满足所有规则     *     * @param Item $item     *     * @return bool     */    abstract public function isSatisfiedBy(Item $item);    /**     * 创建一个新的逻辑与规格（AND）     *     * @param SpecificationInterface $spec     *     * @return SpecificationInterface     */    public function plus(SpecificationInterface $spec)    {        return new Plus($this, $spec);    }    /**     * 创建一个新的逻辑或组合规格（OR）     *     * @param SpecificationInterface $spec     *     * @return SpecificationInterface     */    public function either(SpecificationInterface $spec)    {        return new Either($this, $spec);    }    /**     * 创建一个新的逻辑非规格（NOT）     *     * @return SpecificationInterface     */    public function not()    {        return new Not($this);    }}

Plus.php

<?phpnamespace DesignPatterns\Behavioral\Specification;/** * 逻辑与规格（AND） */class Plus extends AbstractSpecification{    protected $left;    protected $right;    /**     * 在构造函数中传入两种规格     *     * @param SpecificationInterface $left     * @param SpecificationInterface $right     */    public function __construct(SpecificationInterface $left, SpecificationInterface $right)    {        $this->left = $left;        $this->right = $right;    }    /**     * 返回两种规格的逻辑与评估     *     * @param Item $item     *     * @return bool     */    public function isSatisfiedBy(Item $item)    {        return $this->left->isSatisfiedBy($item) && $this->right->isSatisfiedBy($item);    }}

Each.php

<?phpnamespace DesignPatterns\Behavioral\Specification;/** * 逻辑或规格 */class Either extends AbstractSpecification{    protected $left;    protected $right;    /**     * 两种规格的组合     *     * @param SpecificationInterface $left     * @param SpecificationInterface $right     */    public function __construct(SpecificationInterface $left, SpecificationInterface $right)    {        $this->left = $left;        $this->right = $right;    }    /**     * 返回两种规格的逻辑或评估     *     * @param Item $item     *     * @return bool     */    public function isSatisfiedBy(Item $item)    {        return $this->left->isSatisfiedBy($item) || $this->right->isSatisfiedBy($item);    }}

Not.php

<?phpnamespace DesignPatterns\Behavioral\Specification;/** * 逻辑非规格 */class Not extends AbstractSpecification{    protected $spec;    /**     * 在构造函数中传入指定规格     *     * @param SpecificationInterface $spec     */    public function __construct(SpecificationInterface $spec)    {        $this->spec = $spec;    }    /**     * 返回规格的相反结果     *     * @param Item $item     *     * @return bool     */    public function isSatisfiedBy(Item $item)    {        return !$this->spec->isSatisfiedBy($item);    }}

PriceSpecific.php

<?phpnamespace DesignPatterns\Behavioral\Specification;/** * 判断给定Item的价格是否介于最小值和最大值之间的规格 */class PriceSpecification extends AbstractSpecification{    protected $maxPrice;    protected $minPrice;    /**     * 设置最大值     *     * @param int $maxPrice     */    public function setMaxPrice($maxPrice)    {        $this->maxPrice = $maxPrice;    }    /**     * 设置最小值     *     * @param int $minPrice     */    public function setMinPrice($minPrice)    {        $this->minPrice = $minPrice;    }    /**     * 判断给定Item的定价是否在最小值和最大值之间     *     * @param Item $item     *     * @return bool     */    public function isSatisfiedBy(Item $item)    {        if (!empty($this->maxPrice) && $item->getPrice() > $this->maxPrice) {            return false;        }        if (!empty($this->minPrice) && $item->getPrice() < $this->minPrice) {            return false;        }        return true;    }}

4. テストコード

テスト/仕様Test.php

<?phpnamespace DesignPatterns\Behavioral\Specification\Tests;use DesignPatterns\Behavioral\Specification\PriceSpecification;use DesignPatterns\Behavioral\Specification\Item;/** * SpecificationTest 用于测试规格模式 */class SpecificationTest extends \PHPUnit_Framework_TestCase{    public function testSimpleSpecification()    {        $item = new Item(100);        $spec = new PriceSpecification();        $this->assertTrue($spec->isSatisfiedBy($item));        $spec->setMaxPrice(50);        $this->assertFalse($spec->isSatisfiedBy($item));        $spec->setMaxPrice(150);        $this->assertTrue($spec->isSatisfiedBy($item));        $spec->setMinPrice(101);        $this->assertFalse($spec->isSatisfiedBy($item));        $spec->setMinPrice(100);        $this->assertTrue($spec->isSatisfiedBy($item));    }    public function testNotSpecification()    {        $item = new Item(100);        $spec = new PriceSpecification();        $not = $spec->not();        $this->assertFalse($not->isSatisfiedBy($item));        $spec->setMaxPrice(50);        $this->assertTrue($not->isSatisfiedBy($item));        $spec->setMaxPrice(150);        $this->assertFalse($not->isSatisfiedBy($item));        $spec->setMinPrice(101);        $this->assertTrue($not->isSatisfiedBy($item));        $spec->setMinPrice(100);        $this->assertFalse($not->isSatisfiedBy($item));    }    public function testPlusSpecification()    {        $spec1 = new PriceSpecification();        $spec2 = new PriceSpecification();        $plus = $spec1->plus($spec2);        $item = new Item(100);        $this->assertTrue($plus->isSatisfiedBy($item));        $spec1->setMaxPrice(150);        $spec2->setMinPrice(50);        $this->assertTrue($plus->isSatisfiedBy($item));        $spec1->setMaxPrice(150);        $spec2->setMinPrice(101);        $this->assertFalse($plus->isSatisfiedBy($item));        $spec1->setMaxPrice(99);        $spec2->setMinPrice(50);        $this->assertFalse($plus->isSatisfiedBy($item));    }    public function testEitherSpecification()    {        $spec1 = new PriceSpecification();        $spec2 = new PriceSpecification();        $either = $spec1->either($spec2);        $item = new Item(100);        $this->assertTrue($either->isSatisfiedBy($item));        $spec1->setMaxPrice(150);        $spec2->setMaxPrice(150);        $this->assertTrue($either->isSatisfiedBy($item));        $spec1->setMaxPrice(150);        $spec2->setMaxPrice(0);        $this->assertTrue($either->isSatisfiedBy($item));        $spec1->setMaxPrice(0);        $spec2->setMaxPrice(150);        $this->assertTrue($either->isSatisfiedBy($item));        $spec1->setMaxPrice(99);        $spec2->setMaxPrice(99);        $this->assertFalse($either->isSatisfiedBy($item));    }}