前言
經常會有人問：
- 目錄如何設計比較好？
- 代碼如何分佈好？
- 怎麼寫一個可維護的項目?
Controller
Controller顧名思義是控制器，在入門PHP的時候，就知道Controller代表MVC中的C層，MVC本身的概念就代碼分離，教你如何如何將業務分開，但面臨着業務的不斷髮展，代碼的複雜度也隨之提高，功能與功能之間的鏈接錯綜複雜，最後你的MVC就變成了下圖,所以僅僅依託MVC的設計思想已經無法支撐不斷髮展的業務。
現在我們將Controller的任務和能力重新定義，控制器僅僅控制Http Reqeust的請求,這樣就符合了SOLID 單一功能原則.
直接將業務代碼寫在Controller中，會使得代碼及其臃腫，不易於維護和擴展
<?php
namespace App\Http\Controller;
class UserController extends Controller{
public function register(Request $request){
$user = new User();
$user->username = $request->input('username');
$user->password = $request->input('password');
$result = $user->save();
return $result;
}
}
這時就應該思考如何分離業務代碼，我們引入Service的概念
Service
Service本身譯爲服務
- 將外部方法，公共方法注入到Service
- 將Service注入到控制器
UserController
<?php
namespace App\Http\Controller;
class UserController extends Controller{
public $request;
protected $userService;
public function __construct(Request $request, UserService $userService)
{
$this->request = $request;
$this->userService = $userService;
}
public function register()
{
//... validation
return $this->userService->register ($this->request->all());
}
}
UserService
<?php
namespace App\Service;
class UserService{
public function register($data)
{
$username = $data['username'];
$password = $data['password'];
$password = encrypt ($password);
$user = new User();
$user->username = $username;
$user->password = $password;
$result = $user->save();
return $result;
}
}
到現在爲止，我們至少將業務與請求徹底分開了。
但還是不如人意，如果把所有的業務及CURD全部寫在Service中，那隻不過是將Controller的臃腫轉移到了Service,那Service就沒有什麼存在意義了。
所以我們需要繼續分割Service，將對數據庫的R操作獨立出來，因爲CUD的操作基本是一貫不變的，而R操作根據業務的複雜度則變的多姿多彩。
所以獨立R操作。這個時候我們引用Repository的概念。
Repository
我們使用Repository輔助Model,將相關的查詢邏輯封裝到不同的repository中，方便邏輯代碼的維護
- 符合SOLID的單一原則
- 符合SOLID的依賴反轉
UserController
<?php
namespace App\Http\Controller;
class UserController extends Controller{
public $request;
protected $userService;
public function __construct(Request $request, UserService $userService)
{
$this->request = $request;
$this->userService = $userService;
}
public function getUserInfo()
{
//... validation
return $this->userService->getUserInfo ($this->request->all());
}
}
UserService
<?php
namespace App\Service;
class UserService{
public $userRepository;
public function __construct(UserRepository $userRepository){
$this->userRepository = $userRepository;
}
public function getUserInfo()
{
return $this->userRepository->getUserInfo($data);
}
}
UserRepository
<?php
namespace App\Repository;
class UserRepository{
public function getUserInfo($data)
{
$userId = $data['user_id'];
$result = User::where('id',$userId)->first();
return $result;
}
}
解決了R的問題，有人就問了，難道因爲CUD比較統一簡單就可以放在一起了嗎？
答案是NO，我們引用一個新的名詞Action。
Action
這是看了@Charlie_Jade的文章才學到的
獨立每個操作文件，例如CreateUser,DeleteUser,UpdateUser
- 符合SOLID的單一原則
UserController
<?php
namespace App\Http\Controller;
class UserController extends Controller{
public $request;
protected $userService;
public function __construct(Request $request, UserService $userService)
{
$this->request = $request;
$this->userService = $userService;
}
public function register(){
//... validation
return $this->userService->register($this->request->all());
}
public function getUserInfo()
{
return $this->userService->getUserInfo ($this->request->all());
}
}
UserService
<?php
namespace App\Service;
class UserService{
public function getUserInfo(UserRepository $userRepository)
{
return $this->userRepository->getUserInfo($data);
}
public function register(){
$result = (new CreateUser())->execute($this->request->all());
return $result;
}
}
UserRepository
<?php
namespace App\Repository;
class UserRepository{
public function getUserInfo($data)
{
$userId = $data['user_id'];
$result = User::where('id',$userId)->first();
return $result;
}
}
CreateUser
<?php
namespace App\Action;
use App\Model\Member;
class CreateUser extends CreateUserWallet
{
public function execute(array $data)
{
$models = new Member();
$models->tel = $data['tel'];
$models->password = $data['password'];
$result = $models->save ();
return $result;
}
}
除模版（V）等HTML,JS等，還需要一些其他的規則，或者說是方式去實現一些代碼的解耦合，以下不再提供代碼案例。
Common
譯爲公共的，常用的，再部分開發中，你可能需要一些公共的方法（並非公共的類，例如郵件發送等，用他並不合適），比如查詢用戶餘額，查詢用戶是否註冊或者是否在線，生成訂單號等。使用Common更要簡單。
他更像一個公共函數庫的樣子。
Event
不關心執行結果時可以選使用，不過Event的Listen也是提供了隊列。
Exception
不要將你的所有錯誤提示都使用Return返回，很多時候你的返回未必是你的返回
