发表新帖

在 Hyperf 框架中，如何定制 gen:model 命令

发布于2年前 · 18 次浏览 · 来自开发框架

李铭昕

2020-12-16

李铭昕

其实我们可以通过重写 `ModelUpdateVisitor`，很简单的处理这件事。

## 创建模型

我们先在原来的情况下，执行 `gen:model`，为了后面高度定制，我们先将 `$timestamps` 设置为 `false`，这样 `created_at` 和 `updated_at` 默认都会转化为 `string`。

以下为生成的模型：

```php
<?php

declare(strict_types=1);
/**
 * This file is part of Hyperf.
 *
 * [[[[[[@link ](/u/22784)](/u/22784)](/u/22784)](/u/22784)](/u/22784)](/u/22784)    https://www.hyperf.io
 * @document https://hyperf.wiki
 * @contact  group@hyperf.io
 * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
 */
namespace App\Model;

/**
 * @property int $id
 * @property int $count
 * @property float $float_num
 * @property string $str
 * @property string $json
 * @property string $created_at
 * @property string $updated_at
 */
class UserExt extends Model
{
    public $timestamps = false;

/**
     * The table associated with the model.
     *
     * [[[[[[[[[@var ](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)string
     */
    protected $table = 'user_ext';

/**
     * The attributes that are mass assignable.
     *
     * [[[[[[[[[@var ](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)array
     */
    protected $fillable = ['id', 'count', 'float_num', 'str', 'json', 'created_at', 'updated_at'];

/**
     * The attributes that should be cast to native types.
     *
     * [[[[[[[[[@var ](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)array
     */
    protected $casts = ['id' => 'integer', 'count' => 'integer', 'float_num' => 'float'];
}

```

我们可以看到，`float_num` 会被 `cast` 强制转化为 `float`。

## 重写 ModelUpdateVisitor

接下来我们重写 `ModelUpdateVisitor`，将以下注释的代码删掉。

```
<?php

use Hyperf\Database\Commands\Ast\ModelUpdateVisitor as Visitor;

class ModelUpdateVisitor extends Visitor
{
    protected function formatDatabaseType(string $type): ?string
    {
        switch ($type) {
            case 'tinyint':
            case 'smallint':
            case 'mediumint':
            case 'int':
            case 'bigint':
                return 'integer';
            // case 'decimal':
            // case 'float':
            // case 'double':
            // case 'real':
            //     return 'float';
            case 'bool':
            case 'boolean':
                return 'boolean';
            default:
                return null;
        }
    }
}

```

然后将其配置到 `dependencies.php` 中：

```php
<?php

然后让我们重新执行 `php bin/hyperf.php gen:model --force-casts`，就可以看到，对应的 `float_num` 已经不会再转化成 `float` 了。

```php
<?php

declare (strict_types=1);
/**
 * This file is part of Hyperf.
 *
 * [[[[[[@link ](/u/22784)](/u/22784)](/u/22784)](/u/22784)](/u/22784)](/u/22784)    https://www.hyperf.io
 * @document https://hyperf.wiki
 * @contact  group@hyperf.io
 * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
 */
namespace App\Model;

/**
 * @property int $id 
 * @property int $count 
 * @property string $float_num 
 * @property string $str 
 * @property string $json 
 * @property string $created_at 
 * @property string $updated_at 
 */
class UserExt extends Model
{
    public $timestamps = false;
    /**
     * The table associated with the model.
     *
     * [[[[[[[[[@var ](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)string
     */
    protected $table = 'user_ext';
    /**
     * The attributes that are mass assignable.
     *
     * [[[[[[[[[@var ](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)array
     */
    protected $fillable = ['id', 'count', 'float_num', 'str', 'json', 'created_at', 'updated_at'];
    /**
     * The attributes that should be cast to native types.
     *
     * [[[[[[[[[@var ](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)](/u/3588)array
     */
    protected $casts = ['id' => 'integer', 'count' => 'integer'];
}
```

当然除此之外，我们也可以通过这种方式，自动处理 `json` 和 `datetime` 格式，修改我们的 `ModelUpdateVisitor`

```php
<?php

use Hyperf\Database\Commands\Ast\ModelUpdateVisitor as Visitor;

class ModelUpdateVisitor extends Visitor
{
    protected function formatDatabaseType(string $type): ?string
    {
        switch ($type) {
            case 'tinyint':
            case 'smallint':
            case 'mediumint':
            case 'int':
            case 'bigint':
                return 'integer';
            case 'timestamp':
            case 'datetime':
                return 'datetime';
            case 'json':
                return 'json';
            case 'bool':
            case 'boolean':
                return 'boolean';
            default:
                return null;
        }
    }
}
```

然后重新执行 `php bin/hyperf.php gen:model --force-casts`，就可以看到结果了。

```php
<?php

/**
 * @property int $id
 * @property int $count
 * @property string $float_num
 * @property string $str
 * @property array $json
 * @property \Carbon\Carbon $created_at
 * @property \Carbon\Carbon $updated_at
 */
class UserExt extends Model
{
    public $timestamps = false;