Dapper如何处理PostgreSQL的JSONB字段 Dapper查询JSONB数据

15次阅读

Dapper 本身不直接解析 PostgreSQL 的 jsonb 字段,但可通过 Npgsql 驱动将其映射为 string、JToken、JsonDocument 或自定义 POCO;读取时依赖 Npgsql 自动转换,写入时必须显式指定 NpgsqlDbType.Jsonb 类型。

Dapper 如何处理 PostgreSQL 的 JSONB 字段 Dapper 查询 JSONB 数据

Dapper 本身不直接解析 PostgreSQL 的 jsonb 字段,但它可以无缝读取为 stringJToken(Newtonsoft.Json)、JsonDocument(System.Text.Json)或自定义 POCO,关键在于正确配置类型映射和使用合适的序列化器。

将 JSONB 映射为 string(最简单方式)

PostgreSQL 的 jsonb 在数据库驱动(如 Npgsql)中默认映射为 string。Dapper 直接接收即可,适合不需要立即解析、仅需透传或延迟解析的场景。

  • 确保 Npgsql 已安装(如 Npgsql 7+),它会自动把 jsonb 列转成 UTF-8 字符串
  • Dapper 查询时,字段可直接映射到 C# 的 string 属性
  • 示例:
    var user = connection.QueryFirstOrDefault<User>("SELECT id, name, metadata FROM users WHERE id = @id", new { id = 123}); // 其中 User.metadata 是 string 类型 

用 Newtonsoft.Json(Json.NET)映射为 JToken 或自定义对象

如果你习惯用 Newtonsoft.Json,推荐映射为 JToken(灵活)或强类型的 POCO(类型安全)。

  • 添加引用:Newtonsoft.JsonDapper.Contrib(可选)
  • 映射为 JToken:Npgsql 支持自动转换 jsonb → JToken,前提是启用 JsonNetTypeHandler(需手动注册)
  • 更常用做法:先读成 string,再用 JToken.Parse()JsonConvert.DeserializeObject<t>()</t>
  • 示例(手动反序列化):
    var row = connection.QuerySingle<dynamic>("SELECT metadata FROM users WHERE id = @id", new { id = 123}); string json = row.metadata; var settings = new JsonSerializerSettings {DateParseHandling = DateParseHandling.None}; var data = JsonConvert.DeserializeObject<UserSettings>(json, settings);

用 System.Text.Json 映射为 JsonDocument 或 record/class

.NET 5+ 推荐使用原生 System.Text.Json,性能更好、无额外依赖。

  • jsonb 列仍作为 string 读出,再用 JsonSerializer.Deserialize<t></t>JsonDocument.Parse()
  • 若需在查询时直接绑定为 JsonElement,可配合 Npgsql 的 JsonElementHandler(需 Npgsql 7.0+ 并启用)
  • 示例(轻量解析):
    var jsonStr = connection.QuerySingle<string>("SELECT metadata FROM users WHERE id = @id", new { id = 123}); using JsonDocument doc = JsonDocument.Parse(jsonStr); JsonElement root = doc.RootElement; string theme = root.GetProperty("ui").GetProperty("theme").GetString(); // 安全导航 

写入 JSONB:参数需显式指定 NpgsqlDbType.Jsonb

插入或更新 jsonb 字段时,Dapper 不会自动推断类型,必须通过 NpgsqlParameter 明确指定 NpgsqlDbType.Jsonb

  • 错误写法:new {metadata = "{"name":"test"}" } → 可能被当作文本存为 text 类型
  • 正确写法(推荐):
    var param = new NpgsqlParameter("@metadata", NpgsqlDbType.Jsonb) {Value = JsonSerializer.Serialize(new { name = "test", active = true}) }; connection.Execute("INSERT INTO users (name, metadata) VALUES (@name, @metadata)",      new {name = "Alice", param});
  • 也可用匿名对象 + DynamicParameters 封装,保持 Dapper 风格

基本上就这些。核心是:读取靠 Npgsql 自动转换,Dapper 负责“搬运”;解析靠你选的 JSON 库;写入必须显式声明 Jsonb 类型。不复杂但容易忽略类型声明这一步。

星耀云
版权声明:本站原创文章,由 星耀云 2025-12-19发表,共计2100字。
转载说明:转载本网站任何内容,请按照转载方式正确书写本站原文地址。本站提供的一切软件、教程和内容信息仅限用于学习和研究目的;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负。本站信息来自网络,版权争议与本站无关。
text=ZqhQzanResources