thinkphp 一个模型对应一个数据表，所以数据表里面字段也是模型的一些属性，但是因为php是动态语言，模型里面的属性并不能直观的看到，出了数据表里面的字段以外的属性，模型其实还包含了通过getXXXAttr方法定义的属性，还有关联关系定义的属性比如hasOne，hasMany等等。虽然thinkphp支持了通过访问数组的形式访问模型的属性，但是还是不直观，另一个是不知道模型属性的字段含义，如果手动维护容易遗漏和出错，所以我基于thinkphp5.1开发了模型属性自动生成器。
仓库地址：https://github.com/xiaobai1993/model_property_helper，支持composer 安装。
功能介绍
- 基于thinkphp的command命令类，提供基本的交互。
- 自动更新模型的属性，同时生成注释。包括数据表字段、获取器定义，关联关系定义。
- 支持在同一个目录下的所有的模型统一更新，也支持单个模型文件更新。
- 根据数据表创建的语句中字段的注释或者php文件中的注释，自动为属性增加注释信息。
源码如下
<?php
/**
* Created by PhpStorm.
* User: guodong
* Date: 2020/4/2
* Time: 下午2:35
*/
namespace app\common\command\code;
use think\console\Command;
use think\console\Input;
use think\console\input\Argument;
use think\console\input\Option;
use think\console\Output;
use think\Loader;
use think\Model;
class ModelProperty extends Command
{
protected static $tabs = " ";
protected function configure()
{
$this->setName('amp')
->addArgument('model', Argument::OPTIONAL, "模型的名字")
->addOption('override', null, Option::VALUE_OPTIONAL, '是否强制覆盖')
->setDescription('模型自动增加属性注释');
}
protected function execute(Input $input, Output $output)
{
$modelPath = $input->getArgument('model');
$path = APP_PATH . $modelPath;
if (is_dir($path)) {
foreach (scandir($path) as $value) {
if ($value == '.' || $value == '..') {
continue;
}
$filePath = $path . "/" . $value;
if (is_file($filePath)) {
try {
$this->parseSingleFile($filePath);
} catch (\Exception $exception) {
echo $exception->getMessage();
}
} else {
continue;//目录嵌套暂时不处理
}
}
} elseif (is_file($path)) {
$this->parseSingleFile($path);
} else {
exception("$path 文件不存在");
}
}
public function parseSingleFile($filePath)
{
$fileContent = file_get_contents($filePath);
if (preg_match('/namespace (.*?);/', $fileContent, $spaceMatch)) {
$spaceName = $spaceMatch[1];
if (preg_match('/class (.*?) extends .*?Model/', $fileContent, $classMatch)) {
$className = $classMatch[1];
$class = $spaceName . "\\" . $className;
if (class_exists($class)) {
$instance = new $class();
if ($instance instanceof Model) {
$comments = [];
$this->parseTableAttr($instance, $comments);
$this->parseClass($instance, $comments);
$classComments = "\n\n/**\n" . implode("\n", $comments) . "\n*/\n\n";
$result = preg_replace('/^([\s\S]*;)([\s\S]*?)(class.*?extends[\s\S]*)$/', "$1$classComments$3", $fileContent);
file_put_contents($filePath, $result);
} else {
exception("$class 不是模型类");
}
} else {
exception("$class 不存在");
}
} else {
exception("未能找到" . basename($filePath) . "类的名字");
}
} else {
exception("未能找到" . basename($filePath) . "类的命名空间");
}
}
/**
* 扫码数据表的属性
* @param Model $model
* @param $comments
* @return string
*/
protected function parseTableAttr(Model $model, &$comments)
{
$tableSql = $model->query("show create table " . $model->getTable())[0]['Create Table'];
preg_match_all("#`(.*?)`(.*?) COMMENT\s*'(.*?)',#", $tableSql, $matches);
$fields = $matches[1];
$cts = $matches[3];
if (preg_match('/COMMENT=\'(.*?)\'$/', $tableSql, $m2)) {
$comments[] = " * " . $m2[1];
}
for ($i = 0; $i < count($matches[0]); $i++) {
$comments[] = " * @property $" . $fields[$i] . self::$tabs . $cts[$i];
}
}
/**
* 获取模型文件的方法
* @param $model
* @param $comments
*/
protected function parseClass(Model $model, &$comments)
{
$classReflect = new \ReflectionClass($model);
$tableFields = $model->getTableFields();
$filePath = $classReflect->getFileName();
if ($filePath) {
$content = file_get_contents($filePath);
} else {
$content = "";
}
$methods = $classReflect->getMethods(\ReflectionMethod::IS_PUBLIC);
foreach ($methods as $method) {
if ($method->isAbstract() || $method->isStatic()) {
continue;
}
$methodName = $method->getName();
//只查询本类文件存在的
if ($content && strpos($content, "function " . $methodName)) {
if (preg_match('/get(.*?)Attr/', $methodName, $match)) { //属性
$propertyName = Loader::parseName($match[1], 0, false);
if (in_array($propertyName, $tableFields)) {
continue;
}
$comments[] = " * @property $" . $propertyName . self::$tabs . $this->getDocTitle($method->getDocComment());
} else {
$startLine = $method->getStartLine();
$endLine = $method->getEndLine();
$methodContent = $this->readFile($filePath, $startLine, $endLine);
if (preg_match('/return.*?->(.*?)\([,]?(.*?)::class,/', $methodContent, $match)) {
$relation = $match[1];
$relationModel = $match[2];
$propertyName = Loader::parseName($methodName, 0, false);
if ($relation == 'hasMany' || $relation == 'belongsToMany') {
$comments[] = " * @property ". $relationModel . "[]" . " $" . $propertyName . self::$tabs . $this->getDocTitle($method->getDocComment());
} else {
$comments[] = " * @property " .$relationModel . " $" . $propertyName . self::$tabs . $this->getDocTitle($method->getDocComment());
}
}
}
} else {
continue;
}
}
}
/**
* 读文件
* @param $file_name
* @param $start
* @param $end
* @return string
*/
protected function readFile($file_name, $start, $end)
{
$limit = $end - $start;
$f = new \SplFileObject($file_name, 'r');
$f->seek($start);
$ret = "";
for ($i = 0; $i < $limit; $i++) {
$ret .= $f->current();
$f->next();
}
return $ret;
}
/**
* 获取类或者方法注释的标题，第一行
* @param $docComment
* @return string
*/
protected function getDocTitle($docComment)
{
if ($docComment !== false) {
$docCommentArr = explode("\n", $docComment);
$comment = trim($docCommentArr[1]);
return trim(substr($comment, strpos($comment, '*') + 1));
}
return '';
}
}
案例测试
# 整个目录的模型都更新了
php think amp dbase/model/
随便拿几个看看
image.png
image.png
可以发现生成了较为完善的注释信息，对于关联信息也根据关联关系指定是对象还是对象数组。
