[積德篇] 如何少寫PHP "爛"代碼

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

前言

常常會有人問

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

「爛」項目我也沒少寫，如下是參考互聯網各大佬的文章總結及我的開發經驗而來.

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返回，不少時候你的返回未必是你的返回

致謝

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

參考文章

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