AdonisJS 5/Lucid模型设置可选字段为null的最佳实践

DevOps 小满

2026-10-8

AdonisJS Lucid 可选字段清空的最佳实现

你当前使用的string | null类型标注 + 显式赋值null的写法，就是AdonisJS Lucid框架设计的标准合规实现，并非临时妥协方案。

底层逻辑说明

Lucid在执行更新操作时，默认会忽略值为undefined的字段，不会将其纳入生成的UPDATE语句中，这就是你赋值undefined后数据库字段没有变化的原因。框架对两个值做了明确的语义区分：

undefined表示你不想修改该字段，多用于部分更新场景，避免意外覆盖未操作的字段
null表示你明确要将该字段设置为数据库的NULL值，和你迁移文件中未加notNullable()约束的字段特性完全匹配

可选自定义方案

如果你确实有业务需求，希望赋值undefined时自动转成NULL存入数据库，可以通过两种方式实现，注意要规避非预期的误更新问题：

使用@column装饰器的prepare配置，在字段入库前做转换：

export default class User extends BaseModel {
  @column({
    // 入库前自动将undefined转为null，不影响正常字符串和null值的逻辑
    prepare: (val: string | undefined | null) => val ?? null
  })
  public phone?: string | null
}

使用beforeSave钩子，配合$dirty属性判断，仅处理被显式修改为undefined的字段：

import { beforeSave } from '@adonisjs/lucid/orm'

export default class User extends BaseModel {
  @column()
  public phone?: string | null

  @beforeSave()
  public static async handleNullableFields(user: User) {
    // 只有当phone字段被显式修改为undefined时才转换为null，避免部分更新时误清空
    if ('phone' in user.$dirty && user.$dirty.phone === undefined) {
      user.phone = null
    }
  }
}