Yii2中为模型分配UUID及通过数据库函数赋值属性的方法

1. 如何在Yii2中为模型分配UUID？ #

给Yii2模型设置UUID有几种常用思路，根据你的场景选最合适的就行：

方法一：在beforeSave事件里手动生成 #

这是最直观的方式，在模型的beforeSave钩子中生成UUID并赋值，只在插入新记录时生效：

use Ramsey\Uuid\Uuid; // 推荐用Ramsey的UUID库（执行composer require ramsey/uuid安装）

class MyModel extends \yii\db\ActiveRecord
{
    public function beforeSave($insert)
    {
        if (!parent::beforeSave($insert)) {
            return false;
        }
        
        // 仅插入新记录且字段为空时生成UUID
        if ($insert && empty($this->uuid)) {
            // 用Ramsey生成UUIDv4
            $this->uuid = Uuid::uuid4()->toString();
            
            // 如果你的PHP版本>=7.0，也可以用原生函数
            // $this->uuid = uuid_create(UUID_TYPE_RANDOM);
        }
        
        return true;
    }
}

方法二：用AttributeBehavior实现自动赋值 #

如果多个模型都需要UUID，用行为更模块化，便于复用：

use yii\behaviors\AttributeBehavior;
use Ramsey\Uuid\Uuid;

class MyModel extends \yii\db\ActiveRecord
{
    public function behaviors()
    {
        return array_merge(parent::behaviors(), [
            'uuidBehavior' => [
                'class' => AttributeBehavior::class,
                'attributes' => [
                    // 指定插入前触发赋值
                    self::EVENT_BEFORE_INSERT => 'uuid',
                ],
                'value' => fn($event) => Uuid::uuid4()->toString(),
            ],
        ]);
    }
}

方法三：数据库层面设置默认值 #

如果你的数据库支持UUID生成函数（比如MySQL 8+、PostgreSQL），可以直接给字段加默认值，彻底不用在Yii里写代码：

-- MySQL 8+示例
ALTER TABLE my_table MODIFY COLUMN uuid CHAR(36) NOT NULL DEFAULT UUID();

-- PostgreSQL示例（需先安装uuid-ossp扩展）
ALTER TABLE my_table ALTER COLUMN uuid SET DEFAULT uuid_generate_v4();

2. 能否在Yii2中为模型属性分配数据库函数调用？ #

直接写$myModel->myAttribute = 'mysql:UUID()';肯定不行，Yii会把这段字符串原封不动存进数据库，不会解析成SQL函数。正确的做法是用yii\db\Expression类来包裹函数：

正确的赋值方式 #

use yii\db\Expression;

$myModel = new MyModel();
// 用Expression包裹数据库函数，Yii生成SQL时会直接使用这个函数
$myModel->myAttribute = new Expression('UUID()');
$myModel->save();

自动用数据库UUID填充属性 #

如果想在保存时自动触发，结合行为或者beforeSave就行，比如用行为的方式：

use yii\behaviors\AttributeBehavior;
use yii\db\Expression;

class MyModel extends \yii\db\ActiveRecord
{
    public function behaviors()
    {
        return array_merge(parent::behaviors(), [
            'uuidDbBehavior' => [
                'class' => AttributeBehavior::class,
                'attributes' => [
                    self::EVENT_BEFORE_INSERT => 'myAttribute',
                ],
                // 直接调用数据库的UUID函数，不同数据库函数名可能不同
                'value' => new Expression('UUID()'),
            ],
        ]);
    }
}

这样插入时Yii会生成INSERT INTO my_table (myAttribute) VALUES (UUID())的SQL，由数据库负责生成UUID。注意：不同数据库的UUID函数不一样，比如SQL Server用NEWID()，PostgreSQL用uuid_generate_v4()，要对应调整。

内容的提问来源于stack exchange，提问作者Mischa