EF Core Npgsql中如何去除PostgreSQL的jsonb字段空值

要实现JSONB字段保存时忽略空值属性，同时保留强类型映射，核心是配置Npgsql使用的JSON序列化规则，让序列化时自动跳过值为null的属性。以下是两种可行的实现方式：

方式一：全局配置所有JSONB字段 #

在WebAPI的ConfigureServices方法中注册DbContext时，通过Npgsql扩展方法全局设置JSON序列化规则：

using Microsoft.EntityFrameworkCore;
using Npgsql.EntityFrameworkCore.PostgreSQL;
using System.Text.Json.Serialization;

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    
    services.AddDbContext<YourDbContext>(options =>
        options.UseNpgsql("你的数据库连接字符串", npgsqlOpts =>
            npgsqlOpts.UseJsonOptions(jsonOpts =>
                // 序列化时忽略所有值为null的属性
                jsonOpts.SerializerOptions.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)));
}

方式二：针对单个实体属性配置 #

如果只需要对特定实体的JSONB字段生效，可在DbContext的OnModelCreating方法中单独配置该属性的转换规则：

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

public class YourDbContext : DbContext
{
    public DbSet<Book> Books { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        var jsonSerializerOptions = new JsonSerializerOptions
        {
            DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
        };

        modelBuilder.Entity<Book>()
            .Property(b => b.PhysicalProperties)
            .HasColumnType("jsonb")
            .HasConversion(
                // 序列化时忽略空值
                obj => JsonSerializer.Serialize(obj, jsonSerializerOptions),
                // 反序列化时正常处理（Npgsql默认也能正确解析）
                json => JsonSerializer.Deserialize<PhysicalProperties>(json, jsonSerializerOptions));
    }

    // 其他DbContext配置...
}

验证效果 #

配置完成后，保存Book实体时，PhysicalProperties中值为null的属性会被自动跳过，最终存入数据库的JSONB内容仅包含有实际值的属性（比如{Pages: 223, HardCover: false}）。读取时Npgsql依然能正确将JSON反序列化为PhysicalProperties强类型对象，空值属性会被赋值为null。

常见问题说明 #

如果之前尝试配置未成功，大概率是配置位置错误：

• 不要在OnConfiguring中直接设置，需通过UseNpgsql链式调用UseJsonOptions
• 确保使用的是System.Text.Json的JsonIgnoreCondition.WhenWritingNull（EF Core 6及以上版本支持）

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