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

问题背景

在使用 Drizzle ORM 构建的 monorepo 项目中，开发者遇到了一个关于类型推断的特殊问题。当在一个共享的数据库包中使用 $inferSelect 和 $inferInsert 生成类型，并在其他包中引用这些类型时，类型会被错误地推断为 any。然而，手动定义的类型却能正常推断。

问题现象

具体表现为：

1. 在共享包中定义的类型：

   export type User = typeof users.$inferSelect  // 在其他包中被推断为 any
   export type Organization = { id: number, name: string, created_at: Date } // 正常推断
   export type UserDetail = User & { organizations: Organization[] } // 只有 Organization[] 部分被正确推断
   

2. 项目结构为 monorepo，包含：

   • 共享包 (packages/shared)
   • Next.js 应用 (apps/web)

根本原因分析

经过深入调查，发现问题根源在于 TypeScript 的构建配置和类型文件处理方式：

1. 构建系统问题：Next.js 的构建系统不支持传统的 TypeScript 项目引用(project references)，导致无法正确解析跨包的类型依赖关系。

2. 类型文件处理：.d.ts 类型声明文件没有被包含在构建输出中，而实际导入的是原始 schema 文件，这导致了类型推断链的中断。

3. Drizzle ORM 的特殊性：$inferSelect 和 $inferInsert 是 Drizzle ORM 特有的类型级操作，它们依赖于完整的类型上下文才能正常工作。

解决方案

解决此问题的关键在于确保类型文件被正确处理和包含：

1. 正确配置构建系统：

   • 确保共享包的 tsconfig.json 中设置了 "declaration": true 以生成类型声明文件
   • 确认 "include" 和 "exclude" 配置正确覆盖所有需要处理的文件

2. 确保类型文件被包含：

   // 在共享包的构建配置中明确包含类型文件
   {
     "include": ["./**/*.ts", "./**/*.d.ts"],
     "exclude": ["node_modules", "dist"]
   }
   

3. Next.js 适配方案：

   • 使用 Next.js 支持的模块解析方式
   • 确保共享包构建后的输出结构符合 Next.js 的预期

最佳实践建议

1. monorepo 类型共享：

   • 对于 Drizzle ORM 生成的类型，建议将其单独导出到一个类型文件中
   • 考虑使用类型重导出来减少依赖链的复杂性

2. 构建流程优化：

   • 在共享包中设置预构建脚本，确保类型文件先被生成
   • 在消费者应用中配置正确的类型查找路径

3. 调试技巧：

   • 使用 tsc --traceResolution 来跟踪类型解析过程
   • 检查构建后的 dist 目录，确认所有必要的类型文件都存在

总结

Drizzle ORM 的类型系统在 monorepo 环境中需要特别注意构建配置和类型文件的处理。通过确保类型文件被正确包含在构建过程中，并适当配置 TypeScript 的模块解析，可以解决跨包类型推断为 any 的问题。这个问题也提醒我们，在使用高级类型特性时，需要更加关注构建系统的细节配置。

对于使用 Drizzle ORM 的开发者来说，理解类型推断的工作原理和构建系统的交互方式，将有助于避免类似问题的发生，并构建出更加健壮的类型系统。