模板介绍

用途说明

• 代码生成器是目前项目开发中使用非常频繁的工具，极大了解放了人力，避免了每次手动创建文件的繁琐，提高了开发效率，非常受用，这也是为什么很多人对代码生成器爱不释手的原因，那么我们是否可以二次开发代码生成器这套工具，增强他的功能，使得更加方便和高效的为我们所用，当然可以！！

• 本着约定高于规范的原则，我们决定对代码生成工具进行了自定义开发，根据我们所规划分框架特性和规范，我们自定义了自己独特的文件模板，包括：控制器模板、模型模板、服务层模板、Vue文件模板等等，每个模板文件我们都进行了精心的编写和调优，使得在各场景的使用过程中可以完美的结合实际动态的生成模块文件，下一章节《模板介绍》我们将详细的描述每个模板的具体内容。

实现原理

模板文件只是静态的标签，如果需要生成具体的模块文件就是如何去获得数据，并且调用模板文件进行标签填充、替换，生成相关的模块文件了，制作好模板文件只是我们的第一步，最重要的异步就是如何动态获取数据源并绑定模板标签的匹配最终形成我们自己所需要的模块文件并且让生成好的文件自动放入到指定的目录中去，因此我们专门写了一个模板文件生成类，内容如下：

<?php
// +----------------------------------------------------------------------
// | RXThinkCMF框架 [ RXThinkCMF ]
// +----------------------------------------------------------------------
// | 版权所有 2017~2021 南京RXThinkCMF研发中心
// +----------------------------------------------------------------------
// | 官方网站: http://www.rxthink.cn
// +----------------------------------------------------------------------
// | Author: 牧羊人 <1051386190@qq.com>
// +----------------------------------------------------------------------


namespace App\Services;

use App\Models\MenuModel;
use Illuminate\Support\Facades\DB;

/**
 * 代码生成器-服务类
 * @author 牧羊人
 * @since 2020/11/12
 * Class GenerateService
 * @package App\Services
 */
class GenerateService extends BaseService
{

    /**
     * 获取数据表
     * @return array
     * @since 2020/11/12
     * @author 牧羊人
     */
    public function getList()
    {
        $list = DB::select('SHOW TABLE STATUS');
        $list = json_decode(json_encode($list), true);
        $list = array_map('array_change_key_case', $list);

        return $message = array(
            "msg" => '操作成功',
            "code" => 0,
            "data" => $list,
            "count" => 100,
        );
    }

    /**
     * 一键生成模块文件
     * @return array
     * @since 2020/11/12
     * @author 牧羊人
     */
    public function generate()
    {
        // 参数
        $param = request()->all();
        // 数据表名
        $name = getter($param, "name");
        if (!$name) {
            return message("数据表名称不能为空", false);
        }
        if ($name != DB_PREFIX . 'demo') {
            return message("演示环境禁止操作", false);
        }
        // 数据表名称
        $tableName = str_replace(DB_PREFIX, null, $name);
        // 模型名称
        $moduleName = str_replace(' ', null, ucwords(strtolower(str_replace('_', ' ', $tableName))));
        // 控制器名称
        $controllerName = ucfirst(strtolower(str_replace('_', '', $tableName)));

        // 数据表描述
        $comment = getter($param, "comment");
        if (!$comment) {
            return message("数据表名称不能为空", false);
        }
        // 去除表描述中的`表`
        if (strpos($comment, "表") !== false) {
            $comment = str_replace("表", null, $comment);
            $menuName = $comment;
        }
        // 去除表描述中的`管理`
        if (strpos($comment, "管理") !== false) {
            $comment = str_replace("管理", null, $comment);
        }
        // 作者花名
        $author = "牧羊人";

        // 生成模型
        $this->generateModel($author, $moduleName, $comment, $tableName);
        // 生成服务类
        $this->generateService($author, $moduleName, $comment, $tableName);
        // 生成控制器
        $this->generateController($author, $controllerName, $comment, $tableName);
        // 生成列表文件
        $this->generateVueIndex($comment, $moduleName, $tableName);
        // 生成菜单
        $this->generateMenu(strtolower(str_replace('_', '', $tableName)), $menuName);
        return message("模块生成成功");
    }

    /**
     * 生成模型
     * @param $author 作者
     * @param $moduleName 模块名
     * @param $moduleTitle 模块标题
     * @param $tableName 数据表名
     * @author 牧羊人
     * @since 2020/11/12
     */
    public function generateModel($author, $moduleName, $moduleTitle, $tableName)
    {
        // 判断是否有图片
        $moduleImage = false;
        // 获取数据列表
        $columnList = $this->getColumnList(DB_PREFIX . "{$tableName}");
        if ($columnList) {
            foreach ($columnList as &$val) {
                // 图片字段处理
                if (strpos($val['columnName'], "cover") !== false ||
                    strpos($val['columnName'], "avatar") !== false ||
                    strpos($val['columnName'], "image") !== false ||
                    strpos($val['columnName'], "logo") !== false ||
                    strpos($val['columnName'], "pic") !== false) {
                    $val['columnImage'] = true;
                    $moduleImage = true;
                }
            }
        }
        // 参数
        $param = [
            'author' => $author,
            'since' => date('Y/m/d', time()),
            'moduleName' => $moduleName,
            'moduleTitle' => $moduleTitle,
            'tableName' => $tableName,
            'columnList' => $columnList,
            'moduleImage' => $moduleImage,
        ];
        // 存储目录
        $FILE_PATH = app_path() . '/Models';
        if (!is_dir($FILE_PATH)) {
            // 创建目录并赋予权限
            mkdir($FILE_PATH, 0777, true);
        }
        // 文件名
        $filename = $FILE_PATH . "/{$moduleName}Model.php";
        // 拆解参数
        extract($param);
        // 开启缓冲区
        ob_start();
        // 引入模板文件
        require(resource_path() . '/views/templates/model.blade.php');
        // 获取缓冲区内容
        $out = ob_get_clean();
        // 打开文件
        $f = fopen($filename, 'w');
        // 写入内容
        fwrite($f, "<?php " . $out);
        // 关闭
        fclose($f);
    }

    /**
     * 生成服务类
     * @param $author 作者
     * @param $moduleName 模块名
     * @param $moduleTitle 模块标题
     * @param $tableName 数据表
     * @author 牧羊人
     * @since 2020/11/12
     */
    public function generateService($author, $moduleName, $moduleTitle, $tableName)
    {
        // 判断是否有图片
        $moduleImage = false;
        // 查询条件
        $queryList = [];
        // 获取数据列表
        $columnList = $this->getColumnList(DB_PREFIX . "{$tableName}");
        if ($columnList) {
            foreach ($columnList as &$val) {
                // 图片字段处理
                if (strpos($val['columnName'], "cover") !== false ||
                    strpos($val['columnName'], "avatar") !== false ||
                    strpos($val['columnName'], "image") !== false ||
                    strpos($val['columnName'], "logo") !== false ||
                    strpos($val['columnName'], "pic") !== false) {
                    $val['columnImage'] = true;
                    $moduleImage = true;
                }
                // 下拉筛选
                if (isset($val['columnValue'])) {
                    $queryList[] = $val;
                }
                // 名称
                if ($val['columnName'] == "name") {
                    $queryList[] = $val;
                }
                // 标题
                if ($val['columnName'] == "title") {
                    $queryList[] = $val;
                }
            }
        }

        // 参数
        $param = [
            'author' => $author,
            'since' => date('Y/m/d', time()),
            'moduleName' => $moduleName,
            'moduleTitle' => $moduleTitle,
            'columnList' => $columnList,
            'moduleImage' => $moduleImage,
            'queryList' => $queryList,
        ];
        // 存储目录
        $FILE_PATH = app_path() . '/Services/';
        if (!is_dir($FILE_PATH)) {
            // 创建目录并赋予权限
            mkdir($FILE_PATH, 0777, true);
        }
        // 文件名
        $filename = $FILE_PATH . "/{$moduleName}Service.php";
        // 拆解参数
        extract($param);
        // 开启缓冲区
        ob_start();
        // 引入模板文件
        require(resource_path() . '/views/templates/service.blade.php');
        // 获取缓冲区内容
        $out = ob_get_clean();
        // 打开文件
        $f = fopen($filename, 'w');
        // 写入内容
        fwrite($f, "<?php " . $out);
        // 关闭
        fclose($f);
    }

    /**
     * 生成控制器
     * @param $author 作者
     * @param $moduleName 模块名
     * @param $moduleTitle 模块标题
     * @param $tableName 数据表名
     * @author 牧羊人
     * @since 2020/11/12
     */
    public function generateController($author, $moduleName, $moduleTitle, $tableName)
    {
        // 获取数据列表
        $columnList = $this->getColumnList(DB_PREFIX . "{$tableName}");
        // 参数
        $param = [
            'author' => $author,
            'since' => date('Y/m/d', time()),
            'moduleName' => $moduleName,
            'moduleTitle' => $moduleTitle,
            'columnList' => $columnList,
        ];
        // 存储目录
        $FILE_PATH = app_path() . '\Http\Controllers';
        if (!is_dir($FILE_PATH)) {
            // 创建目录并赋予权限
            mkdir($FILE_PATH, 0777, true);
        }
        // 文件名
        $filename = $FILE_PATH . "/{$param['moduleName']}Controller.php";
        // 拆解参数
        extract($param);
        // 开启缓冲区
        ob_start();
        // 引入模板文件
        require(resource_path() . '/views/templates/controller.blade.php');
        // 获取缓冲区内容
        $out = ob_get_clean();
        // 打开文件
        $f = fopen($filename, 'w');
        // 写入内容
        fwrite($f, "<?php " . $out);
        // 关闭
        fclose($f);
    }

    /**
     * 生成列表文件
     * @param $moduleTitle 模块标题
     * @param $tableName 数据表名
     * @author 牧羊人
     * @since 2020/7/15
     */
    public function generateVueIndex($moduleTitle, $moduleName, $tableName)
    {
        // 获取数据列表
        $columnList = $this->getColumnList(DB_PREFIX . "{$tableName}");
        $queryList = [];
        if ($columnList) {
            foreach ($columnList as $val) {
                // 下拉筛选
                if (isset($val['columnValue'])) {
                    $queryList[] = $val;
                }
                // 名称
                if ($val['columnName'] == "name") {
                    $queryList[] = $val;
                }
                // 标题
                if ($val['columnName'] == "title") {
                    $queryList[] = $val;
                }
            }
        }
        // 获取编辑表单数据源
        // 剔除非表单呈现字段
        $arrayList = [];
        $tempList = [];
        $rowList = [];
        $columnSplit = false;
        if ($columnList) {
            foreach ($columnList as $val) {
                // 记录ID
                if ($val['columnName'] == "id") {
                    continue;
                }
                // 创建人
                if ($val['columnName'] == "create_user") {
                    continue;
                }
                // 创建时间
                if ($val['columnName'] == "create_time") {
                    continue;
                }
                // 更新人
                if ($val['columnName'] == "update_user") {
                    continue;
                }
                // 更新时间
                if ($val['columnName'] == "update_time") {
                    continue;
                }
                // 有效标识
                if ($val['columnName'] == "mark") {
                    continue;
                }
                // 图片字段处理
                if (strpos($val['columnName'], "cover") !== false ||
                    strpos($val['columnName'], "avatar") !== false ||
                    strpos($val['columnName'], "image") !== false ||
                    strpos($val['columnName'], "logo") !== false ||
                    strpos($val['columnName'], "pic") !== false) {
                    $val['columnUpload'] = true;
                    $tempList[] = $val;
                    continue;
                }
                // 多行文本输入框
                if (strpos($val['columnName'], "note") !== false ||
                    strpos($val['columnName'], "content") !== false ||
                    strpos($val['columnName'], "description") !== false ||
                    strpos($val['columnName'], "intro") !== false) {
                    $val['columnRow'] = true;
                    $rowList[] = $val;
                    continue;
                }
                // 由于目前时间字段采用int类型，所以这里根据字段描述模糊确定是否是时间选择
                if (strpos($val['columnComment'], "时间") !== false) {
                    $val['dataType'] = 'datetime';
                } elseif (strpos($val['columnComment'], "日期") !== false) {
                    $val['dataType'] = 'date';
                }

                // 图片字段处理
                if (strpos($val['columnName'], "cover") !== false ||
                    strpos($val['columnName'], "avatar") !== false ||
                    strpos($val['columnName'], "image") !== false ||
                    strpos($val['columnName'], "logo") !== false ||
                    strpos($val['columnName'], "pic") !== false) {
                    $val['columnImage'] = true;
                }
                $arrayList[] = $val;
            }
        }
        if (count($arrayList) + count($tempList) + count($rowList) > 105) {
            $dataList = [];
            // 分两个一组
            $dataList = array_chunk($arrayList, 2);
            // 图片
            if (count($tempList) > 0) {
                array_unshift($dataList, $tempList);
            }
            // 多行文本
            if (count($rowList) > 0) {
                foreach ($rowList as $val) {
                    $dataList[][] = $val;
                }
            }
            $columnList = $dataList;
            $columnSplit = true;
        } else {
            $dataList = $arrayList;
//            // 图片
//            if (count($tempList) > 0) {
//                array_unshift($dataList, $tempList);
//            }
            // 多行文本
            if (count($rowList) > 0) {
                foreach ($rowList as $val) {
                    $dataList[][] = $val;
                }
            }
            $columnList = $dataList;
            $columnSplit = false;
        }

        // 参数
        $param = [
            'moduleName' => $moduleName,
            'moduleName2' => strtolower($moduleName),
            'moduleTitle' => $moduleTitle,
            'queryList' => $queryList,
            'columnList' => $columnList,
        ];
        // 存储目录
        if (strpos($tableName, "_") !== false) {
            $tableName = str_replace('_', null, $tableName);
        }
        $FILE_PATH = ROOT_PATH . '/evui/src/views/system/' . strtolower($tableName);
        if (!is_dir($FILE_PATH)) {
            // 创建目录并赋予权限
            mkdir($FILE_PATH, 0777, true);
        }
        // 文件名
        $filename = $FILE_PATH . "/index.vue";
        // 拆解参数
        extract($param);
        // 开启缓冲区
        ob_start();
        // 引入模板文件
        require(resource_path() . '/views/templates/index.blade.php');
        // 获取缓冲区内容
        $out = ob_get_clean();
        // 打开文件
        $f = fopen($filename, 'w');
        // 写入内容
        fwrite($f, $out);
        // 关闭
        fclose($f);
    }

    /**
     * 生成字段列表
     * @param $tableName 数据表名
     * @return array
     * @author 牧羊人
     * @since 2020/11/12
     */
    public function getColumnList($tableName)
    {
        // 获取表列字段信息
        $columnList = DB::select("SELECT COLUMN_NAME,COLUMN_DEFAULT,DATA_TYPE,COLUMN_TYPE,COLUMN_COMMENT FROM information_schema.`COLUMNS` where TABLE_NAME like '{$tableName}'");
        $columnList = json_decode(json_encode($columnList), true);
        $fields = [];
        if ($columnList) {
            foreach ($columnList as $val) {
                $column = [];
                // 列名称
                $column['columnName'] = $val['COLUMN_NAME'];
                // 列默认值
                $column['columnDefault'] = $val['COLUMN_DEFAULT'];
                // 数据类型
                $column['dataType'] = $val['DATA_TYPE'];
                // 列描述
                if (strpos($val['COLUMN_COMMENT'], '：') !== false) {
                    $item = explode("：", $val['COLUMN_COMMENT']);
                    $column['columnComment'] = $item[0];

                    // 拆解字段描述
                    $param = explode(" ", $item[1]);
                    $columnValue = [];
                    $columnValueList = [];
                    foreach ($param as $vo) {
                        // 键值
                        $key = preg_replace('/[^0-9]/', '', $vo);
                        // 键值内容
                        $value = str_replace($key, null, $vo);
                        $columnValue[] = "{$key}={$value}";
                        $columnValueList[] = $value;
                    }
                    $column['columnValue'] = implode(',', $columnValue);
                    if ($val['COLUMN_NAME'] == "status" || substr($val['COLUMN_NAME'], 0, 3) == "is_") {
                        $column['columnSwitch'] = true;
                        $column['columnSwitchValue'] = implode('|', $columnValueList);
                        if ($val['COLUMN_NAME'] == "status") {
                            $column['columnSwitchName'] = "status";
                        } else {
                            $column['columnSwitchName'] = 'set' . str_replace(' ', null, ucwords(strtolower(str_replace('_', ' ', $val['COLUMN_NAME']))));
                        }
                    } else {
                        $column['columnSwitch'] = false;
                    }
                } else {
                    $column['columnComment'] = $val['COLUMN_COMMENT'];
                }
                $fields[] = $column;
            }
        }
        return $fields;
    }

    /**
     * 生成模块菜单
     * @param $moduleName 模块名称
     * @param $moduleTitle 模块标题
     * @author 牧羊人
     * @since 2020/11/12
     */
    public function generateMenu($moduleName, $moduleTitle)
    {
        // 查询已存在的菜单
        $menuModel = new MenuModel();
        $info = $menuModel->getOne([
            ['permission', '=', "sys:{$moduleName}:view"],
        ]);
        $data = [
            'id' => isset($info['id']) ? intval($info['id']) : 0,
            'title' => $moduleTitle,
            'icon' => 'el-icon-house',
            'path' => "/system/{$moduleName}",
            'component' => "/system/{$moduleName}",
            'pid' => 43,
            'type' => 0,
            'permission' => "sys:{$moduleName}:view",
        ];
        $result = $menuModel->edit($data);
        if ($result) {
            // 去除表描述中的`管理`
            if (strpos($moduleTitle, "管理") !== false) {
                $moduleTitle = str_replace("管理", null, $moduleTitle);
            }
            // 创建节点
            $funcList = [1, 5, 10, 15, 25, 30];
            foreach ($funcList as $val) {
                $item = [];
                if ($val == 1) {
                    // 查询列表
                    $menuModel = new MenuModel();
                    $info = $menuModel->getOne([
                        ['pid', '=', $result],
                        ['title', '=', "查询" . $moduleTitle]
                    ]);
                    $item = [
                        'id' => isset($info['id']) ? intval($info['id']) : 0,
                        'title' => "查询" . $moduleTitle,
                        'permission' => "sys:{$moduleName}:index",
                        'pid' => $result,
                        'type' => 1,
                        'status' => 1,
                        'sort' => $val,
                    ];
                } else if ($val == 5) {
                    // 添加
                    $menuModel = new MenuModel();
                    $info = $menuModel->getOne([
                        ['pid', '=', $result],
                        ['title', '=', "添加" . $moduleTitle]
                    ]);
                    $item = [
                        'id' => isset($info['id']) ? intval($info['id']) : 0,
                        'title' => "添加" . $moduleTitle,
                        'permission' => "sys:{$moduleName}:add",
                        'pid' => $result,
                        'type' => 1,
                        'status' => 1,
                        'sort' => $val,
                    ];
                } else if ($val == 10) {
                    // 修改
                    $menuModel = new MenuModel();
                    $info = $menuModel->getOne([
                        ['pid', '=', $result],
                        ['title', '=', "修改" . $moduleTitle]
                    ]);
                    $item = [
                        'id' => isset($info['id']) ? intval($info['id']) : 0,
                        'title' => "修改" . $moduleTitle,
                        'permission' => "sys:{$moduleName}:edit",
                        'pid' => $result,
                        'type' => 1,
                        'status' => 1,
                        'sort' => $val,
                    ];
                } else if ($val == 15) {
                    // 删除
                    $menuModel = new MenuModel();
                    $info = $menuModel->getOne([
                        ['pid', '=', $result],
                        ['title', '=', "删除" . $moduleTitle]
                    ]);
                    $item = [
                        'id' => isset($info['id']) ? intval($info['id']) : 0,
                        'title' => "删除" . $moduleTitle,
                        'permission' => "sys:{$moduleName}:delete",
                        'pid' => $result,
                        'type' => 1,
                        'status' => 1,
                        'sort' => $val,
                    ];
                } else if ($val == 25) {
                    // 状态
                    $menuModel = new MenuModel();
                    $info = $menuModel->getOne([
                        ['pid', '=', $result],
                        ['title', '=', "设置状态"]
                    ]);
                    $item = [
                        'id' => isset($info['id']) ? intval($info['id']) : 0,
                        'title' => "设置状态",
                        'permission' => "sys:{$moduleName}:status",
                        'pid' => $result,
                        'type' => 1,
                        'status' => 1,
                        'sort' => $val,
                    ];
                }
                $menuModel = new MenuModel();
                $menuModel->edit($item);
            }
        }
    }

}