Thinkphp命令行创建repository和transform层扩展包

前言

由于官方推荐的MVC架构在项目功能比较多的时候会导致controller层非常臃肿，不容易将代码复用，难以维护。所以现在很多程序员都喜欢将controller层拆分为controller、service、repository、model这几层甚至更多层次的目录进行开发，更容易复用代码。

控制器层（Controller）：负责接收参数、验证参数、调用各个模块的服务层（可以用事务包裹，用到其他服务的可以注入多个服务）、返回响应、返回视图等
服务层（Service）：负责具体的业务逻辑实现，将原本控制器的负责流程按模块拆分为一个个小的服务，方便给控制器层组合调用，一般不要跨模块调用服务，服务中可以调用本模块的仓库层方法
仓库层（Repository）：调用模型层封装一些负责的查询，方便服务层调用，一般负责只查询本模块的内容
模型层（Model）：只包含默认的表属性（表名、字段等）和联表关系

这是我开发的一个thinkphp框架命令行创建Repository和Transform Class(即仓库层和转化器，基于controller-service-repository目录架构)的扩展包

github地址：jian1098/tp-repository: thinkphp框架命令行创建Repository和Transform Class(即仓库层和转化器，基于controller-service-repository目录架构) (github.com)

如何使用

1.安装扩展

thinkphp5.*装1.0.1版本

composer require jian1098/tp-repository:1.0.1

thinkphp6以上装2.0.1版本

composer require jian1098/tp-repository:2.0.1

2.注册命令

thinkphp5.*

在application/command.php文件中添加两行

return [
    'Jian1098\TpRepository\Command\Repository',
    'Jian1098\TpRepository\Command\Transform',
    'Jian1098\TpRepository\Command\Model',  //如果是tp5.0框架，需要make:model命令可以增加这一行实现
];

thinkphp6+

在config/console.php文件中添加两行

return [
    // 指令定义
    'commands' => [
        'Jian1098\TpRepository\Command\Repository',
        'Jian1098\TpRepository\Command\Transform',
    ],
];

配置完后，在命令行执行php think命令，可以看到增加了make:repository和make:transform命令

  ...
  make:command      Create a new command class
  make:controller   Create a new resource controller class
  make:event        Create a new event class
  make:listener     Create a new listener class
  make:middleware   Create a new middleware class
  make:model        Create a new model class
  make:repository   Create a new repository class
  make:service      Create a new service class
  make:subscribe    Create a new subscribe class
  make:transform    Create a new transform class
  make:validate     Create a validate class
  ...

3.命令行创建文件

# 创建repository
php think make:repository TestRepository

# 创建transform
php think make:transform TestTransform

执行上面的命令将创建文件application/common/repository/TestRepository.php（tp5）或 app\repository\TestRepository（tp6）

TestRepository代码如下：

<?php

namespace app\repository;

use think\App;
use app\model\Test;
use Jian1098\TpRepository\Repository;

/**
 * Class TestRepository
 */
class TestRepository extends Repository
{
    protected $model;

    public function __construct()
    {
        parent::__construct(new App());
        //绑定模型
        $this->model = new Test();
    }

}

TestTransform代码如下：

<?php

namespace app\transform;

use Jian1098\TpRepository\Command\Transform;

class TestTransform extends Transform
{
    public function transform($items)
    {
        return [
            'id'            => $items['id'],
            'createTime'    => $items['create_time'],
            'updateTime'    => $items['update_time'],
        ];
    }
}

在控制器中调用

<?php
namespace app\controller;

use app\BaseController;
use app\repository\TestRepository;
use app\transform\TestTransform;

class Index extends BaseController
{
    public function test(TestRepository $repository, TestTransform $transform)
    {
        //使用repository查询数据
        $data = $repository->first(1);

        //使用转换器将查询结果处理
        echo json_encode($transform->transform($data), JSON_UNESCAPED_UNICODE);
    }
}