SqlSugar更新忽略部分字段的问题

发表于 作者 jikeyshi

在 SqlSugar 中，如果提交更新的实体对象中某些字段为 null（空值），‌默认情况下并不会自动忽略‌，而是会将这些字段更新为数据库中的 NULL。

若希望实现“忽略空值字段不更新”的效果，需要显式配置。以下是具体行为解析和解决方案：

1. 默认行为：空值会被更新

当你使用 db.Updateable(entity).ExecuteCommand() 时，SqlSugar 默认会更新实体中所有非主键的字段。如果某个属性值为 null，生成的 SQL 语句会包含 SET ColumnName = NULL，这会导致数据库中原有的数据被清空。

2. 如何忽略空值（Null）字段

要实现“字段为空则不更新”，有以下两种常用方式：

方式一：全局或单次调用设置 IgnoreAllNullColumns

这是最直接的方法，告诉 SqlSugar 在生成 SQL 时跳过所有值为 null 的属性。

// 忽略所有为 null 的列
db.Updateable(updateObj)
  .IgnoreColumns(ignoreAllNullColumns: true) 
  .ExecuteCommand();

方式二：使用特性标记（静态配置）

如果你希望某个字段在任何更新操作中都默认忽略空值或完全不被更新，可以在实体类上使用 [SugarColumn] 特性。

public class MyEntity
{
    [SugarColumn(IsPrimaryKey = true)]
    public int Id { get; set; }

    // 更新时忽略该列（无论是否有值）
    [SugarColumn(IsOnlyIgnoreUpdate = true)]
    public string CreateTime { get; set; }

    // 或者仅在某些场景下动态忽略，通常推荐用方式一动态控制
    public string Name { get; set; }
}

3. 导航更新（UpdateNav）中的特殊情况

如果你使用的是 UpdateNav 进行级联更新，主表和子表的空值处理需要分别配置：

  • ‌主表‌：UpdateNav 的根配置目前不支持直接的 IgnoreAllNullColumns 开关。如果主表有空值且不想更新，建议：
    1. 先单独使用 Updateable 更新主表（配合 IgnoreColumns(ignoreAllNullColumns: true)）。
    2. 再使用 UpdateNav 更新子表，并通过 IsDisableUpdateRoot = true 禁用主表更新。
  • ‌子表‌：可以在 Include 选项中配置 IgnoreColumns 来忽略子表的特定空值列。
// 示例：拆分更新以完美支持主表忽略空值
// 1. 更新主表，忽略空值
db.Updateable(mainEntity)
  .IgnoreColumns(ignoreAllNullColumns: true)
  .ExecuteCommand();

// 2. 更新子表，禁用主表更新
db.UpdateNav(list)
  .Include(x => x.ChildItems, new UpdateNavOptions() 
  { 
      OneToManyInsertOrUpdate = true 
  })
  .ExecuteCommand();

总结

  • ‌默认行为‌：不忽略，null 值会写入数据库。
  • ‌推荐做法‌：使用 .IgnoreColumns(ignoreAllNullColumns: true) 显式开启忽略空值功能。
  • ‌注意‌：如果你确实需要将某个字段更新为 NULL，则不能使用忽略空值的配置，而应使用 .UpdateColumns(it => it.Field) 白名单模式明确指定该字段。

文章来自百度文心助手，未做验证。