怎么写一个可维护的项目

朴灿烈づ我的快乐病毒、 2023-10-06 18:16 51阅读 0赞

#### 怎么写一个可维护的项目 ####

*  前言
 *   *  \*\*Service\*\*
     *  \*\*Repository\*\*
     *  \*\*Action\*\*
 *  示例
 *   *  UserController 控制器
     *  UserService 控制器的服务层 service
     *  UserRepository 控制器服务层的查询层 repository
     *  CreateUser 控制器服务层的增删改层的增文件 action
     *  User 模型
     *  预览
     *  Common

## 前言 ##

经常会有人问

– 目录如何设计比较好？  
– 代码如何分布好？  
– 怎么写一个可维护的项目?

“烂”项目我也没少写，以下是参考互联网各大佬的文章总结及个人开发经验而来。

Controller顾名思义是控制器，在入门PHP的时候，就知道Controller代表MVC中的C层，MVC本身的概念就代码分离，教你如何如何将业务分开，但面临着业务的不断发展，代码的复杂度也随之提高，功能与功能之间的链接错综复杂，最后你的MVC就变成了下图,所以仅仅依托MVC的设计思想已经无法支撑不断发展的业务。

现在我们将Controller的任务和能力重新定义，控制器仅仅控制Http Reqeust的请求,这样就符合了SOLID 单一功能原则。

直接将业务代码写在Controller中，会使得代码及其臃肿，不易于维护和扩展。

这时就应该思考如何分离业务代码，我们引入Service的概念

### **Service** ###

Service本身译为服务  
– 将外部方法，公共方法注入到Service  
– 将Service注入到控制器

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70]  
到现在为止，我们至少将业务与请求彻底分开了。但还是不如人意，如果把所有的业务及CURD全部写在Service中，那只不过是将Controller的臃肿转移到了Service,那Service就没有什么存在意义了。

【CURD】

代表创建（Create）、更新（Update）、读取（Retrieve）和删除（Delete）操作。

所以我们需要继续分割Service，将对数据库的R操作独立出来，因为CUD的操作基本是一贯不变的，而R操作根据业务的复杂度则变的多姿多彩。

所以独立R操作，这个时候我们引用Repository的概念。

### **Repository** ###

我们使用Repository辅助Model，将相关的查询逻辑封装到不同的repository中，方便逻辑代码的维护。

– 符合SOLID的单一原则  
– 符合SOLID的依赖反转

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 1]  
解决了R的问题，有人就问了，难道因为CUD比较统一简单就可以放在一起了吗？

答案是NO，我们引用一个新的名词Action。

### **Action** ###

独立每个操作文件，例如CreateUser,DeleteUser,UpdateUser

– 符合SOLID的单一原则  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 2]

## 示例 ##

目录结构  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 3]

### UserController 控制器 ###

<?php
    namespace App\Http\Controllers;
    
    use App\Order;
    use App\Service\UserService;
    use Illuminate\Http\Request;
    
    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();
        }
    
        public function getUserInfo()
        {
        
            return $this->userService->getUserInfo();
        }
    
    }

### UserService 控制器的服务层 service ###

<?php
    namespace App\Service;
    
    use App\Action\CreateUser;
    use App\Exceptions\ApiException;
    use App\Repository\UserRepository;
    
    class UserService{
        
        public $userRepository;
        public $CreateUser;
    
        public function __construct(UserRepository $UserRepository,CreateUser $CreateUser)
        {
        
            $this->userRepository = $UserRepository;
            $this->CreateUser = $CreateUser;
        }
    
        public function getUserInfo()
        {
        
            return $this->userRepository->getUserInfo();
        }
    
        public function register(){
        
            return $this->CreateUser->execute(request()->all());
        }
    
    }

### UserRepository 控制器服务层的查询层 repository ###

<?php
    namespace App\Repository;
    
    use App\User;
    
    class UserRepository
    {
        
        public $models;
    
        public function __construct()
        {
        
            $this->models = new User();
        }
    
        public function getUserInfo()
        {
        
            return $this->models->where('id',request('user_id'))->first();
        }
       
    }

### CreateUser 控制器服务层的增删改层的增文件 action ###

<?php
    
    namespace App\Action;
    
    use App\User;
    
    class CreateUser
    {
        
        public $models;
    
        public function __construct()
        {
        
            $this->models = new User();
        }
        public function execute(array $data)
        {
        
            return $this->models->create($data);
        }
    }

上面只是添加数据的文件，还可以继续创建修改的文件。

以上代码逻辑见下图

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 4]

### User 模型 ###

<?php
    
    namespace App;
    
    use Illuminate\Contracts\Auth\MustVerifyEmail;
    use Illuminate\Database\Eloquent\SoftDeletes;
    use Illuminate\Foundation\Auth\User as Authenticatable;
    use Illuminate\Notifications\Notifiable;
    
    class User extends Authenticatable
    {
        
        use Notifiable;
        // 调用定义的trait类 和 继承效果一样
        use SoftDeletes;
        // 软删除标识字段
        protected $dates = ['deleted_at'];
    
        /**
         * The attributes that are mass assignable.
         *
         * @var array
         */
        protected $fillable = [
            'username', 'email', 'password',
        ];
    
        /**
         * The attributes that should be hidden for arrays.
         *
         * @var array
         */
        protected $hidden = [
            'password', 'remember_token',
        ];
    
        /**
         * The attributes that should be cast to native types.
         *
         * @var array
         */
        protected $casts = [
            'email_verified_at' => 'datetime',
        ];
    }

### 预览 ###

路由

Route::get('getUserInfo', 'UserController@getUserInfo');
    Route::get('register', 'UserController@register');

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 5]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 6]

### Common ###

![在这里插入图片描述][20210706153632348.png]  
译为公共的，常用的，再部分开发中，你可能需要一些公共的方法（并非公共的类，例如邮件发送等，用他并不合适），

比如查询用户余额，查询用户是否注册或者是否在线，生成订单号等。使用Common更要简单。他更像一个公共函数库的样子。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 7]  
Event

不关心执行结果时可以选使用，不过Event的Listen也是提供了队列。

Exception

不要将你的所有错误提示都使用Return返回，很多时候你的返回未必是你的返回。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210706141118805.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20210706141855385.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20210706142202108.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20210706142639383.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20210706153413416.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20210706153036777.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20210706153227691.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy,size_16,color_FFFFFF,t_70
[20210706153632348.png]: https://img-blog.csdnimg.cn/20210706153632348.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20210706153755552.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaWd1YW5nMTAy,size_16,color_FFFFFF,t_70