使用EF Core 8+Cosmos DB保存JsonElement时返回Undefined问题

核心原因 #

你遇到的问题本质是JsonElement的设计特性与EF Core+Cosmos DB的序列化逻辑不兼容：

• JsonElement是依赖原始JsonDocument的轻量级DOM元素，本身仅存储ValueKind标识和对原始文档的引用，不包含完整JSON数据。
• 从你提供的存储结果可见，保存时仅写入了ValueKind:3（对应String类型），未存储实际JSON值；跨请求读取时，没有原始JsonDocument支撑，JsonElement就会变成ValueKind = Undefined。

解决方案 #

方案1：改用JsonNode类型（推荐） #

EF Core 8原生支持System.Text.Json.JsonNode，它是独立可序列化的JSON DOM类型，不依赖原始文档，能直接被Cosmos DB正确存储和读取。修改实体类：

public class Data
{
    public Guid Id { get; set; }
    public string Description { get; set; } = string.Empty;

    public Dictionary<string, JsonNode?> Data { get; set; } = [];
}

无需额外配置，替换后即可正常保存和读取完整JSON数据。

方案2：用string存储JSON字符串 #

如果需保留JsonElement的业务使用方式，可通过手动序列化将数据转为string存储：

using System.Text.Json;
using System.ComponentModel.DataAnnotations.Schema;

public class Data
{
    public Guid Id { get; set; }
    public string Description { get; set; } = string.Empty;

    // 映射到Cosmos DB的存储字段
    public Dictionary<string, string> DataJson { get; set; } = [];

    // 业务逻辑使用的属性，手动处理序列化/反序列化
    [NotMapped]
    public Dictionary<string, JsonElement> Data
    {
        get => DataJson.ToDictionary(
            kv => kv.Key, 
            kv => JsonSerializer.Deserialize<JsonElement>(kv.Value)
        );
        set => DataJson = value.ToDictionary(
            kv => kv.Key, 
            kv => JsonSerializer.Serialize(kv.Value)
        );
    }
}

[NotMapped]标记让EF Core忽略业务属性，仅处理存储用的DataJson字段。

方案3：配置EF Core自定义转换器 #

若坚持使用JsonElement，可通过自定义转换器让EF Core正确处理序列化逻辑：
在你的DbContext中添加配置：

using System.Text.Json;
using Microsoft.EntityFrameworkCore;

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Data>()
        .Property(d => d.Data)
        .HasConversion(
            // 保存时序列化为JSON字符串
            dict => JsonSerializer.Serialize(dict, JsonSerializerOptions.Default),
            // 读取时反序列化为字典
            json => JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(json, JsonSerializerOptions.Default)
        );
}

该配置会将整个字典序列化为JSON字符串存储，读取时重建完整的Dictionary<string, JsonElement>。

内容的提问来源于stack exchange，提问作者Helder Lourenço