首页
/ Drizzle ORM 类型推断问题分析与解决方案

Drizzle ORM 类型推断问题分析与解决方案

2025-05-06 12:21:06作者:龚格成

问题概述

Drizzle ORM 是一个现代化的 TypeScript ORM 框架,近期在 0.32.0 版本中出现了一个关键的类型推断问题。许多开发者报告称,在使用 $inferInsert 类型推断时,得到的类型为空对象,而 $inferSelect 则将所有字段都标记为必填,这与预期行为不符。

问题表现

开发者在使用 Drizzle ORM 定义表结构后,期望通过 $inferInsert 获取插入操作的类型定义,但实际得到的却是一个空类型。例如:

const users = pgTable('user', {
  id: serial('id').primaryKey(),
  email: text('email').unique(),
  firstName: text('first_name'),
  // 其他字段...
});

type NewUser = typeof users.$inferInsert; // 结果为 {}

同时,$inferSelect 也存在问题,它会将所有字段都标记为必填,即使某些字段在数据库中是可为空的。

根本原因分析

经过深入调查,这个问题与 TypeScript 的 strictNullChecks 配置密切相关。Drizzle ORM 的类型系统依赖于 TypeScript 的严格空值检查机制来正确推断哪些字段是可选的。

在 Drizzle ORM 内部,类型推断逻辑会检查字段是否为生成字段(generated columns)或是否允许为空。当 strictNullChecks 被禁用时,TypeScript 会将 null 视为可以赋值给任何类型,这导致 Drizzle 的类型推断系统无法正确识别可选字段。

解决方案

1. 启用严格空值检查

最直接的解决方案是在 tsconfig.json 中启用 strictNullChecks

{
  "compilerOptions": {
    "strictNullChecks": true
  }
}

这能确保 Drizzle ORM 的类型推断系统正常工作,但可能会要求开发者修复代码中其他与空值相关的问题。

2. 临时类型覆盖

如果无法立即启用严格空值检查,可以手动定义类型:

type NewUser = {
  id?: number;
  email: string;
  firstName?: string | null;
  // 其他字段...
};

3. 类型断言

在插入或更新操作中使用类型断言:

db.insert(users).values(userData as any);

虽然这不是类型安全的解决方案,但可以作为临时措施。

最佳实践建议

  1. 始终启用严格类型检查:这不仅能解决 Drizzle ORM 的问题,还能提高整体代码质量。

  2. 考虑数据库约束:在设计表结构时,明确每个字段的可空性和默认值,这会影响类型推断结果。

  3. 逐步迁移:如果现有代码库无法立即启用严格模式,可以考虑逐步迁移,先修复 Drizzle 相关的类型问题。

技术细节

Drizzle ORM 的类型推断系统核心在于 OptionalKeyOnly 类型,它会检查字段是否为生成字段或是否允许为空。在严格模式下,系统能正确识别这些条件,但在非严格模式下,类型系统无法区分 null 和普通类型。

结论

Drizzle ORM 的类型推断问题本质上是由 TypeScript 配置与 ORM 类型系统的交互方式引起的。启用 strictNullChecks 是最推荐的解决方案,它不仅解决了当前问题,还能帮助开发者编写更健壮的代码。对于暂时无法启用严格模式的团队,可以考虑手动类型定义或类型断言作为过渡方案。

登录后查看全文
热门项目推荐

热门内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8