映射到Postgres JSONB列的EF Core实体更新后数据库未同步

问题现象 #

按以下步骤操作后，数据库未更新嵌套对象的属性值：

• 配置EF Core将嵌套POCO对象映射为JSON类型，创建并持久化SomeEntity实体
• 在新的DbContext实例中读取该实体，修改嵌套对象的属性（如someEntity.Customer.Age）
• 调用SaveChanges()后，数据库中对应值无变化，ChangeTracker显示SomeEntity状态为Unchanged
• 仅当重新赋值整个嵌套对象（如someEntity.Customer = new Customer { Age = 新值, ... }）时，数据库才会更新

原因分析 #

EF Core的ChangeTracker默认只追踪顶级实体属性的引用变化。对于JSON映射的嵌套对象这类复杂类型（值对象），只要对象引用未改变，EF Core就无法感知到其内部属性的修改，因此会将实体标记为Unchanged，不会生成更新语句。

解决方案 #

1. 手动标记JSON属性为已修改 #

修改嵌套属性后，显式告知EF Core该JSON属性已发生变化：

var someEntity = dbContext.SomeEntities.FirstOrDefault(e => e.Id == entityId);
if (someEntity != null)
{
    // 修改嵌套属性
    someEntity.Customer.Age = 35;
    // 手动标记JSON属性为已修改
    dbContext.Entry(someEntity).Property(e => e.Customer).IsModified = true;
    dbContext.SaveChanges();
}

2. 使用不可变值对象（推荐） #

将嵌套对象设计为不可变类型，修改属性时返回新实例，让EF Core通过引用变化自动识别更新：

// 不可变的Customer类
public class Customer
{
    public int Age { get; }
    public string Name { get; }

    public Customer(int age, string name)
    {
        Age = age;
        Name = name;
    }

    // 提供修改属性的方法，返回新实例
    public Customer UpdateAge(int newAge) => new Customer(newAge, Name);
}

// 使用方式
var someEntity = dbContext.SomeEntities.FirstOrDefault(e => e.Id == entityId);
if (someEntity != null)
{
    someEntity.Customer = someEntity.Customer.UpdateAge(35);
    dbContext.SaveChanges();
}

3. 自定义ValueComparer实现深度对比（EF Core 5+） #

通过配置自定义ValueComparer，让EF Core对比JSON序列化后的内容来判断嵌套对象是否变化：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<SomeEntity>()
        .Property(e => e.Customer)
        .HasConversion(
            v => JsonSerializer.Serialize(v, null),
            v => JsonSerializer.Deserialize<Customer>(v, null),
            new ValueComparer<Customer>(
                (c1, c2) => JsonSerializer.Serialize(c1, null) == JsonSerializer.Serialize(c2, null),
                c => JsonSerializer.Serialize(c, null).GetHashCode(),
                c => JsonSerializer.Deserialize<Customer>(JsonSerializer.Serialize(c, null), null)
            )
        );
}

配置后，EF Core会自动对比嵌套对象的内容变化，无需手动标记即可触发更新。

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