[积德篇] 如何少写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