如何在EF Core中为自有类型JSON列添加注释？

当使用EF Core将自有类型映射为JSON列时，直接对导航属性调用HasComment会报错，因为此时Metadata被识别为导航属性而非标量列属性。以下是无需手动编辑迁移文件即可自动生成注释的可行方案：

解决方法 #

方式一：在OwnsOne配置块内添加注释 #

在配置自有类型的JSON映射时，直接针对JSON列对应的属性配置注释：

public class MyEntityConfiguration : IEntityTypeConfiguration<MyEntity>
{
    public void Configure(EntityTypeBuilder<MyEntity> builder)
    {
        builder.OwnsOne(e => e.Metadata, ownedNavigationBuilder =>
        {
            ownedNavigationBuilder.ToJson();
            // 为JSON列添加注释
            ownedNavigationBuilder.Property(nameof(MyEntity.Metadata))
                .HasComment("Comment about this JSON column");
        });
    }
}

方式二：通过类型+属性名定位JSON列 #

如果需要在OwnsOne配置块外设置注释，可以通过指定自有类型和属性名来定位到对应的JSON列属性：

public class MyEntityConfiguration : IEntityTypeConfiguration<MyEntity>
{
    public void Configure(EntityTypeBuilder<MyEntity> builder)
    {
        builder.OwnsOne(e => e.Metadata, ownedNavigationBuilder =>
        {
            ownedNavigationBuilder.ToJson();
        });

        // 明确指向JSON列对应的属性并添加注释
        builder.Property(typeof(MyEntity.SomeMetadata), nameof(MyEntity.Metadata))
            .HasComment("Comment about this JSON column");
    }
}

原理说明 #

使用OwnsOne+ToJson()时，EF Core会将自有类型序列化为父实体的一个JSON列：

• 在CLR层面，Metadata是导航属性
• 在数据库映射层面，它对应一个存储JSON的标量列

上述两种方式都是直接针对数据库层面的标量列配置注释，规避了操作导航属性的限制，执行dotnet ef migrations add时会自动生成包含注释的迁移代码。

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