Drizzle-ORM 中 BigInt 序列化问题的分析与解决方案
问题背景
在使用 Drizzle-ORM 与 Fastify/NestJS 构建应用时,开发者可能会遇到一个常见的错误:"TypeError: Do not know how to serialize a BigInt"。这个问题通常出现在处理 PostgreSQL 数据库中的 bigserial 或 bigint 类型字段时。
问题根源
这个问题的本质在于 JavaScript 的 JSON.stringify() 方法无法直接序列化 BigInt 类型。当 Drizzle-ORM 从数据库查询返回包含 BigInt 类型的数据,而应用框架(如 Fastify 或 Express)尝试将这些数据序列化为 JSON 响应时,就会抛出上述错误。
Drizzle-ORM 的默认行为
Drizzle-ORM 在处理 bigserial 和 bigint 类型时有一些值得注意的行为差异:
- 对于 bigserial 类型,Drizzle-Kit 默认生成 {mode: 'bigint'} 的配置
- 对于普通 bigint 类型(特别是外键字段),Drizzle-Kit 会默认生成 {mode: 'number'} 的配置,并附带注释说明可以使用 bigint 模式来处理超出 JavaScript 数字限制的情况
解决方案
方案一:修改模式为 number
最直接的解决方案是在定义 bigserial 字段时显式指定 mode 为 number:
id: bigserial('id', {mode: 'number'}).primaryKey().notNull()
这种方案简单有效,但需要注意可能丢失精度的问题,因为 JavaScript 的 number 类型只能安全表示 ±(2^53-1) 范围内的整数。
方案二:自定义序列化逻辑
对于需要处理超大整数的场景,可以保留 bigint 模式,但需要实现自定义的序列化逻辑。常见方法包括:
- 在应用层添加 BigInt 的序列化支持
- 使用中间件转换 BigInt 为字符串
- 在 DTO 转换时处理 BigInt 字段
方案三:统一模式配置
为了保持一致性,建议在项目中统一 bigserial 和 bigint 的模式配置。如果大部分场景不需要处理超大整数,可以全局使用 number 模式;否则,统一使用 bigint 模式并实现相应的序列化支持。
最佳实践建议
- 对于主键 ID 等通常不会达到超大值的字段,优先使用 number 模式
- 在项目早期明确是否需要处理超大整数,统一配置模式
- 在 API 文档中明确说明可能存在的整数精度限制
- 考虑在数据库模型定义中添加注释说明模式选择的原因
总结
Drizzle-ORM 的 BigInt 序列化问题是一个典型的 JavaScript 类型系统与数据库类型系统之间的阻抗匹配问题。通过理解问题本质和 Drizzle-ORM 的行为模式,开发者可以做出合理的架构决策,平衡开发便利性和功能完整性。
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0582- Ddeepseek-harnessDeepSeek Harness: Everything is a Plugin.TypeScript028
paper-ai搜索真实文献并生成引用对应文献的AI论文TSX03
phyaiPhyAI 是一个用于运行 Physical AI 模型(VLA、WAM 等)的高性能框架,支持云端推理服务和端侧部署。Python00
源启盛夏_AtomGit暑期开发者成长计划「源启盛夏」暑期校园开发者成长计划旨在激活校园开源力量,通过积分激励、认证扶持、资源倾斜等形式,引导高校组织和开发者完成「入驻 — 建项目 — 做贡献 — 获认证 — 得资源」的完整闭环。无论你是想带领社团入驻平台的组织者,还是希望用代码贡献证明自己的开发者,都能在这里找到属于你的成长路径。Markdown01
xiaobei专门为 OPC / 中小微企业准备的自媒体获客智能体Markdown02