Drizzle ORM 中 JSON 列类型的正确使用方法

在使用 Drizzle ORM 进行 PostgreSQL 数据库操作时，JSON 类型字段的处理是一个常见需求。本文将详细介绍如何正确使用 JSON 列类型，避免常见的类型错误和序列化问题。

JSON 列的类型定义

在 Drizzle ORM 中，默认情况下 JSON 列的类型会被推断为 unknown | null。这是因为 JSON 数据可以包含多种形式的值：字符串、数字、布尔值、数组、对象或 null。为了确保类型安全，Drizzle 采用了最保守的类型推断策略。

import { pgTable, json, text } from "drizzle-orm/pg-core";

export const testTable = pgTable("testTable", {
  id: text("id").primaryKey().notNull(),
  testobject: json('testobject').array()
});

如何指定 JSON 列的具体类型

为了获得更好的类型安全性和开发体验，我们应该显式指定 JSON 列的类型。Drizzle ORM 提供了 $type 方法来定义具体的类型：

interface TestObject {
  name: string;
  value: number;
  isActive: boolean;
}

export const testTable = pgTable("testTable", {
  id: text("id").primaryKey().notNull(),
  testobject: json('testobject').$type<TestObject>().array()
});

通过这种方式，TypeScript 编译器就能正确识别 JSON 列的类型，提供更好的代码提示和类型检查。

JSON 数据的序列化注意事项

在使用 JSON 列时，需要注意以下几点关于数据序列化的问题：

1. 不需要手动调用 JSON.stringify() - Drizzle ORM 会自动处理序列化过程
2. 确保数据可序列化 - 避免包含函数、循环引用或不可序列化的对象
3. 日期对象处理 - 虽然 Date 对象有 toString() 方法，但最好先转换为字符串或时间戳

如果遇到 "Value is not JSON serializable" 错误，建议实现一个数据转换层，确保插入数据库的数据都是可序列化的。

最佳实践

1. 始终为 JSON 列指定类型 - 这能显著提高代码的可维护性
2. 使用接口定义类型 - 而不是直接使用内联类型，便于复用
3. 实现数据验证 - 在应用层验证 JSON 数据的结构
4. 考虑使用 JSONB - 如果需要进行查询操作，JSONB 类型通常性能更好

通过遵循这些实践，可以确保在使用 Drizzle ORM 处理 JSON 数据时既安全又高效。