The Clean Architecture in PHP 读书笔记(九)

Clean Architecture

这是clean architecture的第9篇,也是具体案例的第一篇,本篇开始将会运用之前学到的知识,来构建一个小型的php应用。

本文为系列文章的第九篇,完成的目录请查看Clean Architecture

计费系统

应用的uml简图如下:

uml

应用的核心逻辑是:用户会有多个订单,然后固定周期对账单进行结算。逻辑非常简单,可以让我们更专注于系统的架构上,那就让我们开始系统的构建吧。

应用功能的构建流程

  • 能够新增用户
  • 能够给用户新增订单
  • 当需要给用户出账的时候能够将订单转换为发票(invoices)

构建我们的领域模型

领域模型层只包含简单的php class,此处只有3个Customer,Order,Invoice。我们先来构建我们的项目。

mkdir -p cleanphp-laravel/core/Domain/Entity

在cleanphp-laravel下新建composer.json文件,内容是:

{
  "autoload": {
        "psr-4": {
            "CleanPhp\\Invoicer\\":"core/"
        }
    }
}

运行composer dump-autoload产生vendor目录。

创建Entity

每个entity都会有唯一的标识,于是我们新建一个AbstractEntity,将$id放入里面。

<?php namespace CleanPhp\Invoicer\Domain\Entity;

abstract class AbstractEntity {
    protected $id;

    /**
     * @return mixed
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param mixed $id
     *
     * @return $this
     */
    public function setId( $id )
    {
        $this->id = $id;
        return $this;
    }
}

同时定义Customer,Order,Invoice都继承自该类,具体的可查看https://github.com/zhuanxuhit/php-clean-code

领域服务

领域服务包含了3个主要部分

  • Repository Interface
  • Factories
  • Services

下面分别构建这3部分,先是Repository,对于每个Entity,都会有对应的Entity,而且会有一些公共的操作,于是提取出来,叫做RepositoryInterface,代码如下:

<?php namespace CleanPhp\Invoicer\Domain\Repository;

interface RepositoryInterface {
    public function getById( $id );
    public function getAll();
    public function persist( $entity );
    public function begin();
    public function commit();
}

其余的CustomerRepositoryInterface,OrderRepositoryInterface,InvoiceRepositoryInterface都扩展RepositoryInterface即可,其中OrderRepositoryInterface需要有个新的接口:getUninvoicedOrders来获取未出账单的订单。

再来看Factory的构建,此处invoice的构建依赖于order,于是我们有下面的定义:

public function createFromOrder(Order $order);

至于怎么去实现这个方法,我们采用BDD(Behavior-Driven Development)的方式。

首先通过composer来包含库

$ composer require --dev peridot-php/peridot peridot-php/leo peridot-php/peridot-prophecy-plugin

安装完成后,通过执行

./vendor/bin/peridot

我们应该就能看到peridot本身的所有case执行成功。下一步让我们来构建符合我们要求的case。

在根目录下新建specs/domain/service/invoice-factory.spec.php文件,

describe( "InvoiceFactory", function () {
    describe( "->createFromOrder()", function () {
        it( "should return an order object", function () {
            $order   = new Order();
            $factory = new InvoiceFactory();
            $invoice = $factory->createFromOrder( $order );
            expect( $invoice )->to->be->instanceof( Invoice::class );
        } );
    } );
} );

基于这种方式我们就能通过测试不断去驱动完成我们的createFromOrder方法了,完整的测试case可以在github上查看。

最后我们来构建Invoicing services,同样通过BDD的方式,先写出case,新建specs/domain/service/invoice-factory.spec.php文件,里面的内容是:

describe( 'InvoicingService', function () {
    describe( '->generateInvoices()', function () {
        it( 'should query the repository for uninvoiced Orders');
        it('should return an Invoice for each uninvoiced Order');
    } );
} );

然后根据case再去实现generateInvoices()方法。

完整的例子,我们可以通过下面的命令查看

git clone https://github.com/zhuanxuhit/php-clean-code.git
git checkout 02-domain-services

总结

以上我们就完成了领域模型层和领域服务层的基本设计,到目前为止,我们的目录如下:

在下一讲中我们会引入Laravel,看怎么和具体的框架结合,尽请期待。

这是The Clean Architecture in PHP的第九篇,你的鼓励是我继续写下去的动力,期待我们共同进步。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容