如何在 GORM 中为字段设置 PostgreSQL 函数作为默认值

如何在 GORM 中为字段设置 PostgreSQL 函数作为默认值

GORM 支持通过 sql:"DEFAULT:func_name" 标签直接调用 PostgreSQL 内置或自定义函数（如 current_timestamp、gen_random_uuid()）作为字段默认值，无需手动迁移或触发器。

想在 GORM 里让 PostgreSQL 函数自动为字段填充默认值？这事儿其实比想象中简单。核心就在于用好结构体标签里的那个 sql 选项。GORM 的处理方式很直接：它会把你写在 DEFAULT:xxx 后面的内容，原封不动地放到生成的 CREATE TABLE 语句的 DEFAULT 子句里。换句话说，只要你的 PostgreSQL 数据库认这个函数——无论是内置的 now() 还是你事先写好的自定义函数——它就能在插入数据时自动生效。

✅ 正确用法示例

来看一个具体的模型定义，一切都清晰了：

type User struct {
    ID        int       `gorm:"primaryKey" sql:"DEFAULT:nextval('user_id_seq')"`
    CreatedAt time.Time `sql:"DEFAULT:current_timestamp"`
    UpdatedAt time.Time `sql:"DEFAULT:now()"`
    UUID      string    `sql:"DEFAULT:gen_random_uuid()"`
}

⚠️ 注意：使用 gen_random_uuid() 函数前，需要确保在 PostgreSQL 中已启用 pgcrypto 扩展：

CREATE EXTENSION IF NOT EXISTS "pgcrypto";

语法要点说明

• sql:"DEFAULT:func()"：这是调用函数的标准写法。有些函数名本身是关键字（如 current_timestamp），不加括号也能用，但显式地加上括号（如 current_timestamp()）会让意图更明确。
• sql:"DEFAULT:'literal'"：如果你想设置的是一个固定的字符串字面量，记得用单引号包裹。这种情况下，数据库不会把它当函数执行。
• 需要注意，目前不支持在标签内进行带参数的函数调用（比如 myfunction(123)）。但如果函数本身无参数，或者所有参数都有默认值，那么直接写函数名是没问题的。
• 最后，也是最重要的一点：确保你调用的函数在目标数据库中存在，并且当前连接数据库的用户有执行它的权限。

常见误区

几个容易踩坑的地方，提前避开能省下不少调试时间：

• 大小写敏感：标签里的 DEFAULT 必须大写。写成小写的 default 是无效的。
• 格式要紧凑：整个标签值里不要包含空格或换行。像 sql:"DEFAULT:myfunction() " 后面多一个空格，都可能导致问题。
• 注意迁移的局限性：GORM 的 AutoMigrate 只会在首次创建字段时应用这个默认值。如果表已经存在，你想为已有字段新增或修改默认值，就必须手动执行 ALTER COLUMN ... SET DEFAULT ... 这样的 SQL 语句了。

✅ 最佳实践建议

1. 优先使用数据库原生默认值：这比在应用层代码里赋值更可靠，尤其是在处理并发写入或批量插入的场景时，能有效保证数据一致性。
2. 配合 NOT NULL 约束：给字段设置默认值的同时，最好加上 NOT NULL 约束，这样可以彻底避免意外的 NULL 值写入。语法上可以合并在一个标签里：

   CreatedAt time.Time `sql:"DEFAULT:current_timestamp;NOT NULL"`

3. 自定义函数要预部署：如果你用的是自己写的函数，务必在运行 AutoMigrate 创建表之前，确保这个函数已经在目标数据库里创建并测试通过了。
4. 别忘了测试验证：完成定义后，实际插入一条记录，故意省略设置了函数默认值的字段，然后检查数据库里生成的值是否符合预期。这是验证配置是否生效的最直接方法。

总的来说，只要规范地使用 sql:"DEFAULT:your_function" 这个标签，就能轻松地将 PostgreSQL 强大的函数能力，无缝集成到你的 GORM 模型定义中，让数据库帮你自动处理好这些默认逻辑。