Laravel程序架構(gòu)設(shè)計(jì)思路之使用動(dòng)作類
前言
當(dāng)我們談?wù)摰綉?yīng)用程序的架構(gòu)的時(shí)候,經(jīng)常會(huì)問(wèn)到一個(gè)經(jīng)典的問(wèn)題,那就是“這段代碼應(yīng)該放在哪里比較好”。 因?yàn)?Laravel 是一個(gè)相當(dāng)靈活的框架,所以要回答這個(gè)問(wèn)題其實(shí)沒(méi)那么容易。我應(yīng)該把我的業(yè)務(wù)邏輯寫(xiě)在 Model 層,還是 Controller 層,或者是其他地方?
當(dāng)你的應(yīng)用程序僅有一個(gè)接入點(diǎn),把業(yè)務(wù)邏輯寫(xiě)在 Controller 層是可以的。但是現(xiàn)在更普遍的的情形是,有很多接入點(diǎn)去調(diào)用相同的功能模塊。
比如說(shuō),太多數(shù)的應(yīng)用程序都有用戶注冊(cè)的功能,它的流程是調(diào)用一個(gè)控制器然后返回一個(gè)注冊(cè)成功或者失敗的視圖。假如這個(gè)應(yīng)用程序還有移動(dòng)端,那就很可能要提供一套針對(duì)移動(dòng)端用戶注冊(cè)的 API ,因?yàn)樗枰祷氐臄?shù)據(jù)格式是 JSON 。而且利用 Laravel 的 artisan 命令來(lái)創(chuàng)建用戶也很常見(jiàn),尤其是在項(xiàng)目前期的開(kāi)發(fā)階段。

上面這兩段代碼可能看起來(lái)沒(méi)有什么問(wèn)題的,但是,隨著業(yè)務(wù)邏輯的增加,就會(huì)顯得代碼很冗余。舉個(gè)例子,如果你需要新用戶注冊(cè)完之后,增加給用戶發(fā)送郵件通知的功能,你必須要再上面兩個(gè)控制器中都添加發(fā)送郵件的代碼。但是如果要保持代碼的簡(jiǎn)潔優(yōu)雅,我們可以把這些業(yè)務(wù)邏輯寫(xiě)到其他地方。
對(duì)于“把業(yè)務(wù)邏輯代碼寫(xiě)到哪里”的這個(gè)問(wèn)題,你去任何論壇都可以得到一個(gè)普遍的答案,那就是 “使用一個(gè) service 層,然后在 controller 層調(diào)用這個(gè)服務(wù)類”。是的,沒(méi)錯(cuò),問(wèn)題是我們應(yīng)該怎么設(shè)計(jì) service 類?是創(chuàng)建一個(gè) UserService 類來(lái)實(shí)現(xiàn)所有跟用戶用戶有關(guān)的業(yè)務(wù)邏輯,然后把這個(gè)類注入到需要用到的 Controller 層?或者是還有其他方案?
避免神類的坑
首先,可以嘗試為一個(gè)特定的模型創(chuàng)建一個(gè)單一類,其中包含所有的代碼。例如:
看起來(lái)很完美:我們可以任何控制器中申明或者使用 create/delete 方法,并且得到我們想要的結(jié)果。但是,這種實(shí)現(xiàn)有什么問(wèn)題呢? 那就是我們?cè)诮鉀Q問(wèn)題的過(guò)程通常很少使用單一的模型 。
比如說(shuō),當(dāng)我們給一個(gè)用戶創(chuàng)建了賬號(hào)的時(shí)候,也要同時(shí)給用戶單獨(dú)創(chuàng)建一個(gè) blog 。如果按照當(dāng)前的方式去實(shí)現(xiàn)這個(gè)流程,我們就必須創(chuàng)建一個(gè) BlogService 類,然后將其依賴注入到 UserService 類。

顯而易見(jiàn),隨著應(yīng)用程序的業(yè)務(wù)的增長(zhǎng),將會(huì)有幾十到上百個(gè) service 類,其中的一些 service 類需要依賴 5 到 6 個(gè)其他 service 類,最終的結(jié)果就是,出現(xiàn)代碼的冗余跟混亂的局面,而這個(gè)局面是我們想不惜一切代價(jià)去避免的。
介紹單動(dòng)作類
那么,如果不是用一個(gè)單一的服務(wù)類加上幾個(gè)方法,我們決定把它分成幾個(gè)類?下面是我最近每一個(gè)項(xiàng)目都采用的方法,結(jié)果很不錯(cuò),推薦給大家。
首先,讓我們拋棄過(guò)于籠統(tǒng)和模糊的服務(wù)術(shù)語(yǔ),來(lái)了解一下我們的新動(dòng)作類,并定義它們是什么以及它們可以做什么。
- 一個(gè)動(dòng)作類,應(yīng)該有一個(gè)能夠說(shuō)明其功能的名字,比如:CreateOrder, ConfirmCheckout, DeleteProduct, AddProductToCart等。
- 它應(yīng)該有且只有一個(gè)公共方法,作為 API 。理想的情況下,應(yīng)該是相同的方法名,像 handle() 或者 execute() 。如果需要對(duì)我們的動(dòng)作類實(shí)現(xiàn)某種適配器模式,這是非常方便的。
- 它必須對(duì)請(qǐng)求和響應(yīng)不可知。它不處理請(qǐng)求,也不發(fā)送響應(yīng)。這樣的職責(zé)應(yīng)該由控制器來(lái)承擔(dān)。
- 它可以依賴其它的動(dòng)作類。
- 如果有任何事情阻止它執(zhí)行和/或返回期望的值,那么它必須通過(guò)拋出一個(gè) Exception 來(lái)強(qiáng)制執(zhí)行相關(guān)的業(yè)務(wù)邏輯,并且讓調(diào)用者(或者 Laravel 的 ExceptionHandler )來(lái)承擔(dān)如何呈現(xiàn)/響應(yīng)異常的責(zé)任。
創(chuàng)建我們的 CreateUser 動(dòng)作類
現(xiàn)在,讓我們看看前面的例子,并用一個(gè)單動(dòng)作類來(lái)重構(gòu)它,我們將命名為 CreateUser 。

你或許想知道當(dāng)郵箱地址已經(jīng)被占用時(shí),該方法為什么會(huì)拋出了異常。 這難道不是請(qǐng)求驗(yàn)證來(lái)保證的嗎?當(dāng)然可以。然而,在動(dòng)作類內(nèi)部來(lái)執(zhí)行業(yè)務(wù)邏輯不是更好嗎?這樣使得邏輯變得易于理解和調(diào)試。
讓我們看看使用我們動(dòng)作類之后的控制器代碼,如下:

現(xiàn)在,無(wú)論我們做什么修改,用戶注冊(cè)過(guò)程都會(huì)由 API 和 Web 版本處理,優(yōu)雅整潔。
動(dòng)作類的嵌套
假如,我們需要一個(gè)動(dòng)作類將 1000 個(gè)用戶導(dǎo)入我們的應(yīng)用中。我們可以寫(xiě)一個(gè)動(dòng)作類,并且繼續(xù)使用上文的 CreateUser 類:

非常整潔,不是嗎?我們可以通過(guò)將其嵌入在 Collection::map() 方法中來(lái)重用 CreateUser 代碼,然后返回所有新建用戶的集合。當(dāng)郵件被占用的時(shí)候,我們可以通過(guò)返回 Null Object 或者在 Log 文件中記錄一下,你應(yīng)該已經(jīng)想到了。
動(dòng)作類的裝飾
現(xiàn)在,假設(shè)我們想在日志中記錄每一個(gè)新注冊(cè)的用戶。我們可以將代碼寫(xiě)在動(dòng)作類內(nèi)部,也可以使用裝飾者模式。

然后,我們可以使用 Laravel 的 IoC 容器將 LogCreateUser 類綁定到 CreateUser 類,所有每當(dāng)我們需要一個(gè)后者的實(shí)例時(shí),前者都會(huì)注入進(jìn)來(lái):

AppServiceProvider.php
這使得使用配置或環(huán)境變量來(lái)控制日志記錄功能的激活或停用更為方便:

AppServiceProvider.php
總結(jié)
使用這個(gè)方法似乎會(huì)需要很多的類。當(dāng)然,用戶注冊(cè)僅僅是一個(gè)簡(jiǎn)單的例子,旨在保證代碼的簡(jiǎn)短清晰。一旦項(xiàng)目的復(fù)雜度開(kāi)始增長(zhǎng),動(dòng)作類的真正的價(jià)值就越來(lái)越明顯,因?yàn)槟闱逦闹来a所在及其界定。
使用單動(dòng)作類的好處:
- 小巧而單一的邏輯域能夠防止代碼重復(fù)并提高代碼的可重用性,保持穩(wěn)定。
- 易于針對(duì)各種場(chǎng)景進(jìn)行獨(dú)立測(cè)試。
- 富有意義的命名在大型項(xiàng)目中更容易閱讀。
- 易于裝飾。
- 整個(gè)項(xiàng)目的一致性:防止代碼分布在 Controllers、Models 等。
當(dāng)然,這個(gè)方法是基于我過(guò)去幾年使用 Laravel 的一些經(jīng)驗(yàn)和我在一些項(xiàng)目中的實(shí)踐。這對(duì)我真的很有用,現(xiàn)在我甚至在一些中小型項(xiàng)目中使用。
如果你有不同的方法,我非常期待讀一讀。
總結(jié)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問(wèn)大家可以留言交流,謝謝大家對(duì)腳本之家的支持。
相關(guān)文章
Codeigniter實(shí)現(xiàn)多文件上傳并創(chuàng)建多個(gè)縮略圖
這篇文章主要介紹了Codeigniter實(shí)現(xiàn)多文件上傳并創(chuàng)建多個(gè)縮略圖,需要的朋友可以參考下2014-06-06
php實(shí)現(xiàn)QQ小程序發(fā)送模板消息功能
QQ小程序群里有伙伴要發(fā)送模板消息的代碼,所以今天給大家分享QQ小程序模板消息發(fā)布,絕對(duì)一步一步帶著大家走,每個(gè)細(xì)節(jié)都講到,感興趣的朋友跟隨小編一起看看吧2019-09-09
PHP?Composer自動(dòng)加載使用實(shí)戰(zhàn)
這篇文章主要為大家介紹了PHP?Composer自動(dòng)加載使用實(shí)戰(zhàn)示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-09-09
yii2-GridView在開(kāi)發(fā)中常用的功能及技巧總結(jié)
本篇文章主要介紹了yii2-GridView在開(kāi)發(fā)中常用的功能及技巧總結(jié),數(shù)據(jù)網(wǎng)格或者說(shuō) GridView 小部件是Yii中最強(qiáng)大的部件之一。有興趣的可以了解一下。2017-01-01
PHP實(shí)現(xiàn)163郵箱自動(dòng)發(fā)送郵件
163郵箱實(shí)用性非常高。那么基于php如何實(shí)現(xiàn)163郵箱自動(dòng)發(fā)送郵件功能呢,下面腳本之家小編給大家分享具體實(shí)現(xiàn)代碼2016-03-03
PHP模板引擎Smarty之配置文件在模板變量中的使用方法示例
這篇文章主要介紹了PHP模板引擎Smarty之配置文件在模板變量中的使用方法,結(jié)合實(shí)例形式分析了配置文件變量的具體使用步驟與相關(guān)技巧,需要的朋友可以參考下2016-04-04
PHP實(shí)現(xiàn)用戶異地登錄提醒功能的方法【基于thinkPHP框架】
這篇文章主要介紹了PHP實(shí)現(xiàn)用戶異地登錄提醒功能的方法,基于thinkPHP框架結(jié)合用戶session實(shí)現(xiàn)異地登陸的判定功能,非常具有實(shí)用價(jià)值,需要的朋友可以參考下2018-03-03

