How to write high-quality PHP code

Written for those newborn calves who are not afraid of tigers, you can read it at will. This chapter is based on PHP Laravel

Preface

People often ask

• How to design a directory better?
• How to distribute the code well?
• How to write a maintainable project?

I also write about "bad" projects. The following is based on the summary of articles and personal development experience of major Internet experts.

Controller

Controller, as the name suggests, is a controller. When you get started with PHP, you know that Controller represents the C layer in MVC. The concept of MVC itself is code separation, which teaches you how to separate businesses. However, as the business continues to develop, the complexity of the code also increases, and the links between functions are intricate. In the end, your MVC becomes As shown in the figure below, relying solely on the MVC design idea can no longer support the growing business.

Now we redefine the tasks and capabilities of the Controller. The controller only controls Http Reqeust requests, which complies with the SOLID single function principle.

Writing business code directly in the Controller will make the code extremely bloated and difficult to maintain and expand

<?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;
		}

	}复制代码

At this time, we should think about how to separate the business code, and we introduce the concept of Service

Service

Service itself is translated as service

• Inject external methods and public methods into Service
• Inject Service into the controller

Like the picture above

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[&#39;username&#39;];            $password = $data[&#39;password&#39;];         
			$password = encrypt ($password);			
			$user = new User();			$user->username = $username;			$user->password = $password;			$result = $user->save();			return $result;
		}

    }复制代码

Until now , we at least completely separate the business from the requests. But it is still unsatisfactory. If all business and CURD are written in Service, it will just transfer the bloat of Controller to Service, and then Service will have no meaning in existence. Therefore, we need to continue to divide the Service and separate the R operations of the database, because the operations of CUD are basically the same, while the R operations become more colorful according to the complexity of the business. So standalone R operation. At this time we refer to the concept of Repository.

Repository

We use Repository auxiliary Model to encapsulate relevant query logic into different repositories to facilitate the maintenance of logic code

• Conforms to the single principle of SOLID
• SOLID-compliant dependency inversion

##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[&#39;user_id&#39;];            $result = User::where(&#39;id&#39;,$userId)->first();			
			return $result;
		}

    }复制代码

After solving the problem of R, someone asked, can it be put together because CUD is relatively unified and simple? The answer is NO, we quote a new noun Action.

Action

This is what I learned after reading @Charlie_Jade’s article

Independent of each operation file, such as CreateUser, DeleteUser, UpdateUser

Conform to the single principle of 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[&#39;user_id&#39;];            $result = User::where(&#39;id&#39;,$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;
		}
	}复制代码

The above code logic is shown in the figure below

##Except template (V) For HTML, JS, etc., some other rules or methods are needed to achieve decoupling of some codes. No code examples are provided below.

Common

is translated as public, commonly used. In some development, you may need some public methods (non-public classes, such as email sending, etc., it is not appropriate to use them), such as query User balance, query whether the user is registered or online, generate order number, etc. Using Common is even simpler. It is more like a public function library

Event

You can choose to use it when you don’t care about the execution results, but the Listen of Event Queues are also provided.

Exception

Don’t use Return to return all your error messages. In many cases, your return may not be your return

Thank you

Thank you all After reading this article, if you have any new ideas, please feel free to discuss them in the comment area.

Recommended tutorial: "php tutorial"

The above is the detailed content of How to write high-quality PHP code. For more information, please follow other related articles on the PHP Chinese website!