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

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

2025-07-10 15:53:13作者:宣利权Counsellor

在使用 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),需要特别注意配置顺序

总结

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

登录后查看全文
热门项目推荐

项目优选

收起
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
686
457
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
98
157
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
139
223
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
52
15
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
113
255
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
817
149
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
523
44
continew-admincontinew-admin
🔥Almost最佳后端规范🔥页面现代美观,且专注设计与代码细节的高质量多租户中后台管理系统框架。开箱即用,持续迭代优化,持续提供舒适的开发体验。当前采用技术栈:Spring Boot3(Java17)、Vue3 & Arco Design、TS、Vite5 、Sa-Token、MyBatis Plus、Redisson、FastExcel、CosId、JetCache、JustAuth、Crane4j、Spring Doc、Hutool 等。 AI 编程纪元,从 ContiNew & AI 开始优雅编码,让 AI 也“吃点好的”。
Java
127
29
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
590
44
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
705
97