Npgsql.EntityFrameworkCore.PostgreSQL 中 JSON 列映射的正确使用方式

在使用 Npgsql.EntityFrameworkCore.PostgreSQL 8.0.0 版本时，许多开发者会遇到将集合类型映射为 JSON 列的需求。本文将详细介绍如何正确配置实体关系，避免常见的配置错误。

问题背景

在 PostgreSQL 数据库中，JSON 类型列是一种非常实用的功能，它允许我们存储结构化数据而无需创建额外的表。在 Entity Framework Core 中，我们可以通过特定的配置将 .NET 对象的集合直接映射为数据库中的 JSON 列。

常见错误配置

开发者经常尝试使用以下方式配置 JSON 列：

builder.OwnsOne(p => p.PhoneNumbers, config => 
{
    config.ToJson("phone_numbers");
});

这种配置会导致数据库列中只存储了列表的容量信息（如 {"Capacity": 4}），而不是实际的列表内容。

正确配置方法

正确的做法是使用 OwnsMany 而非 OwnsOne：

builder.OwnsMany(p => p.PhoneNumbers, config => 
{
    config.ToJson("phone_numbers");
});

关键区别

1. OwnsOne 用于映射单个复杂类型对象到 JSON 列
2. OwnsMany 用于映射集合类型到 JSON 列

完整示例代码

以下是一个完整的正确配置示例：

public class Patient
{
    public int Id { get; set; }
    public string Name { get; set; } = string.Empty;
    public List<PhoneNumber> PhoneNumbers { get; set; } = new();
}

public class PhoneNumber
{
    public string Number { get; set; } = string.Empty;
    public string Name { get; set; } = string.Empty;
}

public class PatientConfiguration : IEntityTypeConfiguration<Patient>
{
    public void Configure(EntityTypeBuilder<Patient> builder)
    {
        builder.ToTable("patients");
        builder.HasKey(p => p.Id);
        builder.Property(p => p.Name).HasColumnName("name");
        
        // 正确使用 OwnsMany 映射集合到 JSON 列
        builder.OwnsMany(p => p.PhoneNumbers, config => 
        {
            config.ToJson("phone_numbers");
        });
    }
}

注意事项

1. 在 Npgsql 8.0.0 及以上版本中，不再需要使用 EnableDynamicJson() 或 UseJsonNet()
2. 确保不要同时使用 [ColumnType("jsonb")] 和 .ToJson()，前者已被弃用
3. 如果使用蛇形命名约定（SnakeCase），需要特别注意配置顺序

总结

正确理解 OwnsOne 和 OwnsMany 的区别是成功映射 JSON 列的关键。对于集合类型的属性，必须使用 OwnsMany 才能正确序列化整个集合内容到 JSON 列中。这种配置方式既保持了代码的简洁性，又充分利用了 PostgreSQL 强大的 JSON 功能。