[積德篇] 如何少寫PHP “爛”程式碼

GraceDevelopment發表於2018-07-18
PHP

寫給初生牛犢不怕虎的童鞋們,大佬可隨意摘看
本章基於PHP Laravel

前言

經常會有人問

  • 目錄如何設計比較好？
  • 程式碼如何分佈好？
  • 怎麼寫一個可維護的專案?

“爛”專案我也沒少寫，以下是參考網際網路各大佬的文章總結及個人開發經驗而來.

Controller

clipboard.png

Controller顧名思義是控制器，在入門PHP的時候，就知道Controller代表MVC中的C層，MVC本身的概念就程式碼分離，教你如何如何將業務分開，但面臨著業務的不斷髮展，程式碼的複雜度也隨之提高，功能與功能之間的連結錯綜複雜，最後你的MVC就變成了下圖,所以僅僅依託MVC的設計思想已經無法支撐不斷髮展的業務。

現在我們將Controller的任務和能力重新定義，控制器僅僅控制Http Reqeust的請求,這樣就符合了SOLID 單一功能原則.

clipboard.png

直接將業務程式碼寫在Controller中，會使得程式碼及其臃腫，不易於維護和擴充套件

<?php
	namespace AppHttpController;

	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注入到控制器
clipboard.png

像上圖這樣

UserController

<?php
	namespace AppHttpController;

	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 AppService;

    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的依賴反轉
clipboard.png

UserController

<?php
	namespace AppHttpController;

	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 AppService;

    class UserService{
        public $userRepository;
        
        public function __construct(UserRepository $userRepository){
            $this->userRepository = $userRepository;
        }
        public function getUserInfo()
		{
            return $this->userRepository->getUserInfo($data);
		}

    }

複製程式碼

UserRepository

<?php
	namespace AppRepository;

    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的單一原則
clipboard.png

UserController

<?php
	namespace AppHttpController;

	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 AppService;

    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 AppRepository;

    class UserRepository{
    
        public function getUserInfo($data)
		{
            $userId = $data[`user_id`];
            $result = User::where(`id`,$userId)->first();
			
			return $result;
		}

    }

複製程式碼

CreateUser

<?php

	namespace AppAction;
	
	use AppModelMember;
	
	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;
		}
	}
複製程式碼

以上程式碼邏輯見下圖

clipboard.png

除模版（V）等HTML,JS等，還需要一些其他的規則，或者說是方式去實現一些程式碼的解耦合，以下不再提供程式碼案例。

Common

譯為公共的，常用的，再部分開發中，你可能需要一些公共的方法（並非公共的類，例如郵件傳送等，用他並不合適），比如查詢使用者餘額，查詢使用者是否註冊或者是否線上，生成訂單號等。使用Common更要簡單。他更像一個公共函式庫的樣子

clipboard.png

Event

不關心執行結果時可以選使用，不過Event的Listen也是提供了佇列。

Exception

不要將你的所有錯誤提示都使用Return返回，很多時候你的返回未必是你的返回

致謝

感謝各位同學看完這篇文章，如果你有新的想法歡迎在評論區討論.

參考文章

Laravel 的中大型專案架構:http://oomusou.io/laravel/architecture/#Service
Laravel 程式架構設計思路使用動作類 : https://segmentfault.com/a/1190000015208089
如何使用 Service 模式? : http://oomusou.io/laravel/service/
物件導向設計的SOLID原則 : https://www.cnblogs.com/shanyou/archive/2009/09/21/1570716.html

相關文章