Laravel 的中大型專案架構

只有 MVC 是不夠的，我們需要更完整的專案架構

初學者學習 Laravel 時分兩種，一種是乖乖的將程式填入 MVC 架構內，導致 controller 與 model 異常的肥大，日後一樣很難維護；一種是常常不知道程式該寫在哪一個 class 內而猶豫不決，畢竟傳統 PHP 都是一個頁面一個檔案。本文整理出最適合 Laravel 的中大型專案架構，兼具容易維護、容易擴充與容易重複使用的特點，並且容易測試。

Version

Laravel 5.1.24

Controller 過於肥大

受RoR的影響，初學者常認為 MVC 架構就是 model, view, controller :

  • Model 就是資料庫。
  • Controller 負責與 HTTP 溝通，調用 model 與 view。
  • View 就是 HTML。

假如依照這個定義，以下這些需求該寫在哪裡呢？

  1. 發送 Email，使用外部 API。
  2. 使用 PHP 寫的邏輯。
  3. 依需求將顯示格式作轉換。
  4. 依需求是否顯示某些資料。
  5. 依需求顯示不同資料。

其中 1, 2 屬於商業邏輯，而 3, 4, 5 屬於顯示邏輯，若依照一般人對 MVC 的定義，model 是資料庫，而 view 又是 HTML，以上這些需求都不能寫在 model 與 view，只能勉強寫在 controller。

因此初學者開始將大量程式寫在 controller，造成 controller 的肥大難以維護。

Model 過於肥大

既然邏輯寫在 controller 不方便維護，那我將邏輯都寫在 model 就好了？

當你將邏輯從 controller 搬到 model 後，雖然 controller 變瘦了，但卻肥了 model，model 從原本代表資料庫，現在變成還要負擔商業邏輯與顯示邏輯，結果更慘。

Model 代表資料庫嗎？把它想成是 Eloquent class就好，資料庫邏輯應該寫在 repository 裡，這也是為什麼 Laravel 5 已經沒有 models目錄，Eloquent class 僅僅是放在 app 根目錄下而已。

中大型專案架構

那我們該怎麼寫呢？別將我們的思維侷限在 MVC 內 :

  1. Model : 僅當成 Eloquent class。
  2. Repository : 輔助 model，處理資料庫邏輯，然後注入到 service。
  3. Service : 輔助 controller，處理商業邏輯，然後注入到 controller。
  4. Controller : 接收 HTTP request，調用其他 service。
  5. Presenter : 處理顯示邏輯，然後注入到 view。
  6. View : 使用 blade 將資料 binding 到 HTML。

其中藍色為原本的 MVC，而紫色為本文要介紹的的重點 : Repository 模式，Service 模式與 Presenter 模式。

箭頭表示物件依賴注入的方向。1 1關於依賴注入，詳細請參考深入探討依賴注入

我們可以發現 MVC 架構還在，由於 SOLID 的單一職責原則與依賴反轉原則 :

  1. 我們將資料庫邏輯從 model 分離出來，由 repository 輔助 model，將 model 依賴注入進 repository。
  2. 我們將商業邏輯從 controller 分離出來，由 service 輔助 controller，將 service 依賴注入進 controller。
  3. 我們將顯示邏輯從 view 分離出來，由 presenter 輔助 view，將 presenter 依賴注入進 view。

建立目錄

在 app 目錄下建立 Repositories，Services 與 Presenters 目錄。

別害怕建立目錄！！

別害怕在 Laravel 預設目錄以外建立的其他目錄，根據 SOLID 的單一職責原則，class 功能越多，責任也越多，因此越違反單一職責原則，所以你應該將你的程式分割成更小的部分，每個部分都有它專屬的功能，而不是一個 class 功能包山包海，也就是所謂的萬能類別，所以整個專案不應該只有 MVC 三個部分，放手根據你的需求建立適當的目錄，並將適當的 class 放到該目錄下，只要我們的 class 有 namespace 幫我們分類即可。

Repository

由於篇幅的關係，將 repository 獨立成專文討論，請參考如何使用 Repository 模式?

Service

由於篇幅的關係，將 service 獨立成專文討論，請參考如何使用 Service 模式?

Presenter

由於篇幅的關係，將 presenter 獨立成專文討論，請參考如何使用 Presenter 模式?

單元測試

由於現在 model、view、controller 的相依物件都已經拆開，也都使用依賴注入，因此每個部分都可以單獨的做單元測試，如要測試 service，就將 repository 加以 mock，也可以將其他 service 加以 mock。

Presenter 也可以單獨跑單元測試，將其他 service 加以 mock，不一定要跑驗收測試才能測顯示邏輯。

Conclusion

  • 本文談到的架構只是開始，你可以依照實際需求增加更多的目錄與 class，當你發現你的 MVC 違反 SOLID 原則時，就大膽的將 class 從 MVC 拆開重構，然後依照以下手法 :

    1. 建立新的 class 或 interface。
    2. 將相依物件依賴注入到 class。
    3. 在 class 內處理他的職責。
    4. 將 class 或 interface 注入到 controller 或 view。

  • 最後搭配單元測試，測試重構後的架構是否與原來的需求結果相同。

2015-12-19
▲