Npgsql.EntityFrameworkCore.PostgreSQL 中 JSONB 列存储 DateTime 类型的注意事项

在使用 Npgsql.EntityFrameworkCore.PostgreSQL 进行开发时，将包含 DateTime 类型的对象存储到 JSONB 列中可能会遇到一个常见问题：当 DateTime 的 Kind 属性为 Unspecified 时，系统会抛出"timestamp with time zone' literal cannot be generated for Unspecified DateTime"的异常。这个问题看似简单，但背后涉及 PostgreSQL 类型系统和 .NET 类型系统的差异，值得开发者深入理解。

问题本质

PostgreSQL 的 JSONB 类型虽然可以存储任意 JSON 数据，但当我们在 Entity Framework Core 中使用 LINQ 查询这些数据时，EF Core 需要将这些 JSON 中的值转换为 PostgreSQL 的原生类型以便进行比较和运算。对于 DateTime 类型，EF Core 默认会将其映射为 PostgreSQL 的 timestamp with time zone 类型，这就要求 DateTime 必须是 UTC 时间（即 Kind 为 Utc）。

技术背景

PostgreSQL 有两种时间戳类型：

1. timestamp with time zone (timestamptz)：存储 UTC 时间
2. timestamp without time zone (timestamp)：存储未指定时区的时间

Npgsql 默认将 .NET 的 DateTime 映射为 timestamptz，这是推荐的做法，因为它能正确处理时区转换。当 DateTime.Kind 为 Unspecified 时，Npgsql 无法确定这是本地时间还是 UTC 时间，因此会拒绝转换以避免潜在的错误。

解决方案

方案一：确保 DateTime 为 UTC 时间

最佳实践是在存储前明确指定 DateTime 的 Kind 为 Utc：

Timestamp = DateTime.SpecifyKind(someDateTime, DateTimeKind.Utc)

或者在创建 DateTime 时直接使用 UtcNow：

Timestamp = DateTime.UtcNow

方案二：配置为 timestamp without time zone

如果确实需要存储未指定时区的时间，可以在 EF Core 模型配置中显式指定：

builder.Entity<Blog>().OwnsOne(
    blob => blob.Post, 
    ownedNavigationBuilder => {
        ownedNavigationBuilder.ToJson();
        ownedNavigationBuilder.Property(p => p.Timestamp)
            .HasColumnType("timestamp without time zone");
    });

但需要注意，这会影响所有涉及该属性的查询和比较操作，可能导致时区相关的问题。

性能考量

当 JSONB 中的 DateTime 值被用于查询条件时，PostgreSQL 需要将其转换为原生时间戳类型才能进行比较。这种转换虽然会带来一定的性能开销，但确保了查询的正确性。对于频繁查询的时间字段，考虑将其提取为单独的列而非存储在 JSONB 中。

最佳实践建议

1. 始终明确时间的时区信息，避免使用 Unspecified
2. 在系统中统一使用 UTC 时间存储和计算
3. 只在显示层进行时区转换
4. 对于复杂的时间处理需求，考虑使用 NodaTime 库替代 DateTime

理解这些底层机制有助于开发者在使用 Npgsql 和 PostgreSQL 时做出更合理的设计决策，避免潜在的时间处理问题。