背景:
- 在
Hyperf
框架中使用命令创建模型前,如果数据表存在,就会自动生成property
注释。有property
注释的模型,结合IDE
扩展,就可以实现属性提示功能,开发起来很爽。 - 使用
Laravel
框架开发时,却没有找到相似功能,就很想实现类似注释,于是上头大哥就给我推荐了这个。
实现原理:
- 在 laravel框架中创建一个 Artisan命令行
- 在命令的实现中,通过数据表名来获取结构与字段类型,然后循环字段并根据类型匹配对应的 PHP 语法类型来拼接注释
- 打印拼接好的注释到屏幕以供使用
实现步骤:
- 执行命令
php artisan make:command GeneratModelAnnotation
生成命令类,位置为app/Console/Commands
- 填入
GeneratModelAnnotation.php
文件代码,就完成了新建命令的操作。代码文件在下面↓ - 最后使用格式为
php artisan gma TableName
的命令生成注释代码, TableName 为表名。如果要为表名为admin_users的表生成注释,那就执行php artisan gma admin_users
。结果如下
root@62d044ee2a7e:/var/www/local.fly# php artisan gma admin_users
* @property int $id
* @property string $username
* @property string $password
* @property string $name
* @property string $avatar
* @property string $remember_token
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
文件代码:
GeneratModelAnnotation.php
<?php
namespace App\Console\Commands;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\DB;
/**
* 生成模型property注释
* Class GeneratModelAnnotation
*
* @package App\Console\Commands
*/
class GeneratModelAnnotation extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'GMA {tableName}';
/**
* The console command description.
*
* @var string
*/
protected $description = '生成模型property注释,使得IDE有模型属性提示!';
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return mixed
*/
public function handle()
{
//
$tableName = $this->argument('tableName');
$dbName = config('database');
$columns = DB::select("
SELECT COLUMN_NAME, DATA_TYPE , COLUMN_COMMENT
FROM INFORMATION_SCHEMA.COLUMNS
WHERE table_name = '{$tableName}'
AND table_schema = '{$dbName['connections']['mysql']['database']}'");
$annotation = "";
foreach ($columns as $column) {
$type = 'string';
if (in_array($column->DATA_TYPE, ['int', 'tinyint', 'smallint', 'mediumint', 'bigint'])) {
$type = 'int';
} elseif (in_array($column->DATA_TYPE, ['float', 'double', 'decimal'])) {
$type = 'float';
}
$columnName = $column->COLUMN_NAME;
if (in_array($columnName, ['created_at', 'updated_at', 'deleted_at'])) {
$type = '\\Carbon\\Carbon';
}
$columnComment = $column->COLUMN_COMMENT;
$annotation .= sprintf("\n * @property %s \$%s %s", $type, $columnName, $columnComment);
}
$annotation .= "\n";
echo($annotation);
// file_put_contents('annotation',$annotation);
}
}