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閱讀 229,619評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,155評論 3 425
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,635評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,539評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,255評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,646評論 1 326
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,655評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,838評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,399評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,146評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,338評論 1 372
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,893評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,565評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,983評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,257評論 1 292
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,059評論 3 397
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,296評論 2 376

推薦閱讀更多精彩內容