# 模板介绍

# 概述

  • 代码生成器是目前项目开发中使用非常频繁的工具,极大了解放了人力,避免了每次手动创建文件的繁琐,提高了开发效率,非常受用,这也是为什么很多人对代码生成器爱不释手的原因,那么我们是否可以二次开发代码生成器这套工具,增强他的功能,使得更加方便和高效的为我们所用,当然可以!!
  • 本着约定高于规范的原则,我们决定对代码生成工具进行了自定义开发,在主流Thymeleaf、FreeMarker模板引擎中,最终我们选择了FreeMarker,根据我们所规划分框架特性和规范,我们自定义了自己独特的文件模板,包括:控制器模板模型模板服务层模板数据列表页模板编辑表单页模板JS模板、等等,每个模板文件我们都进行了精心的编写和调优,使得在各场景的使用过程中可以完美的结合实际动态的生成模块文件,下一章节《模板介绍》我们将详细的描述每个模板的具体内容。

# 实现原理

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

/**
 * 生成模型
 * @param $author 作者
 * @param $moduleName 模块名
 * @param $moduleTitle 模块标题
 * @param $tableName 数据表名
 * @author 牧羊人
 * @since 2020/7/15
 */
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 . '/admin/model/';
    if (!is_dir($FILE_PATH)) {
        // 创建目录并赋予权限
        mkdir($FILE_PATH, 0777, true);
    }
    // 文件名
    $filename = $FILE_PATH . "/{$moduleName}.php";
    // 拆解参数
    extract($param);
    // 开启缓冲区
    ob_start();
    // 引入模板文件
    require(APP_PATH . '/admin/view/tpl/model.tpl.php');
    // 获取缓冲区内容
    $out = ob_get_clean();
    // 打开文件
    $f = fopen($filename, 'w');
    // 写入内容
    fwrite($f, "<?php " . $out);
    // 关闭
    fclose($f);
}

/**
 * 生成服务类
 * @param $author 作者
 * @param $moduleName 模块名
 * @param $moduleTitle 模块标题
 * @param $tableName 数据表
 * @since 2020/7/15
 * @author 牧羊人
 */
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 . '/admin/service/';
    if (!is_dir($FILE_PATH)) {
        // 创建目录并赋予权限
        mkdir($FILE_PATH, 0777, true);
    }
    // 文件名
    $filename = $FILE_PATH . "/{$moduleName}Service.php";
    // 拆解参数
    extract($param);
    // 开启缓冲区
    ob_start();
    // 引入模板文件
    require(APP_PATH . '/admin/view/tpl/service.tpl.php');
    // 获取缓冲区内容
    $out = ob_get_clean();
    // 打开文件
    $f = fopen($filename, 'w');
    // 写入内容
    fwrite($f, "<?php " . $out);
    // 关闭
    fclose($f);
}

/**
 * 生成控制器
 * @param $author 作者
 * @param $moduleName 模块名
 * @param $moduleTitle 模块标题
 * @param $tableName 数据表名
 * @since 2020/7/15
 * @author 牧羊人
 */
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 . '/admin/controller/';
    if (!is_dir($FILE_PATH)) {
        // 创建目录并赋予权限
        mkdir($FILE_PATH, 0777, true);
    }
    // 文件名
    $filename = $FILE_PATH . "/{$param['moduleName']}.php";
    // 拆解参数
    extract($param);
    // 开启缓冲区
    ob_start();
    // 引入模板文件
    require(APP_PATH . '/admin/view/tpl/controller.tpl.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 generateIndex($moduleTitle, $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;
            }
        }
    }

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

/**
 * 生成表单编辑页
 * @param $tableName 数据表名
 * @since 2020/7/15
 * @author 牧羊人
 */
public function generateEdit($tableName)
{
    // 获取数据列表
    $columnList = $this->getColumnList(DB_PREFIX . "{$tableName}");
    // 剔除非表单呈现字段
    $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';
            }
            $arrayList[] = $val;
        }
    }
    if (count($arrayList) + count($tempList) + count($rowList) > 5) {
        $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 = [
        'columnList' => $columnList,
    ];
    // 存储目录
    if (strpos($tableName, "_") !== false) {
        $tableName = str_replace('_', null, $tableName);
    }
    $FILE_PATH = APP_PATH . '/admin/view/' . strtolower($tableName);
    if (!is_dir($FILE_PATH)) {
        // 创建目录并赋予权限
        mkdir($FILE_PATH, 0777, true);
    }
    // 文件名
    $filename = $FILE_PATH . "/edit.html";
    // 拆解参数
    extract($param);
    // 开启缓冲区
    ob_start();
    // 引入模板文件
    if ($columnSplit) {
        require(APP_PATH . '/admin/view/tpl/edit2.tpl.php');
    } else {
        require(APP_PATH . '/admin/view/tpl/edit.tpl.php');
    }
    // 获取缓冲区内容
    $out = ob_get_clean();
    // 打开文件
    $f = fopen($filename, 'w');
    // 写入内容
    fwrite($f, $out);
    // 关闭
    fclose($f);
}

/**
 * 生成JS文件
 * @param $author 作者
 * @param $moduleName 模块名
 * @param $moduleTitle 模块标题
 * @param $tableName 数据表名
 * @author 牧羊人
 * @since 2020/7/15
 */
public function generateJs($author, $moduleName, $moduleTitle, $tableName)
{
    // 获取数据列表
    $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;
            }
        }
    }
    // 参数
    $param = [
        'author' => $author,
        'since' => date('Y/m/d', time()),
        'moduleTitle' => $moduleTitle,
        'columnList' => $columnList,
        'columnSplit' => count($columnList) > 11 ? true : false,
    ];
    // 存储目录
    $FILE_PATH = PUBLIC_PATH . '/static/admin/module/';
    if (!is_dir($FILE_PATH)) {
        // 创建目录并赋予权限
        mkdir($FILE_PATH, 0777, true);
    }
    // 文件名
    $filename = $FILE_PATH . "/think_" . strtolower($moduleName) . ".js";
    // 拆解参数
    extract($param);
    // 开启缓冲区
    ob_start();
    // 引入模板文件
    require(APP_PATH . '/admin/view/tpl/js.tpl.php');
    // 获取缓冲区内容
    $out = ob_get_clean();
    // 打开文件
    $f = fopen($filename, 'w');
    // 写入内容
    fwrite($f, $out);
    // 关闭
    fclose($f);
}

/**
 * 获取表字段列表
 * @param $tableName 数据表名
 * @return array
 * @author 牧羊人
 * @since 2020/7/15
 */
public function getColumnList($tableName)
{
    // 获取表列字段信息
    $columnList = Db::query("SELECT COLUMN_NAME,COLUMN_DEFAULT,DATA_TYPE,COLUMN_TYPE,COLUMN_COMMENT FROM information_schema.`COLUMNS` where TABLE_NAME like '{$tableName}'");
    $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);
                    $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;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492