首页
/ 在T3 Stack项目中优化Prisma Client的类型推断

在T3 Stack项目中优化Prisma Client的类型推断

2025-05-06 03:30:02作者:彭桢灵Jeremy

在基于T3 Stack构建的项目中,Prisma ORM是常用的数据库访问层解决方案。开发者经常会遇到一个典型问题:当使用Prisma Client的$extends方法扩展模型时,TypeScript无法正确推断出自定义方法的类型。

问题背景

在标准的T3 Stack项目设置中,Prisma Client通常被初始化为一个单例模式。常见的实现方式如下:

import { PrismaClient } from '@prisma/client'

const prisma = globalThis.prisma || new PrismaClient()

if (process.env.NODE_ENV !== 'production') {
  globalThis.prisma = prisma
}

export default prisma

这种实现方式虽然简单,但在使用$extends方法扩展Prisma Client时会出现类型推断问题。例如:

const extendedPrisma = prisma.$extends({
  model: {
    user: {
      async findByEmail(email: string) {
        return prisma.user.findUnique({ where: { email } })
      }
    }
  }
})

当尝试使用extendedPrisma.user.findByEmail()时,TypeScript会报错,因为它无法识别这个新添加的方法。

解决方案

Prisma官方文档推荐了一种更完善的类型安全解决方案:

import { PrismaClient } from '@prisma/client'

const prismaClientSingleton = () => {
  return new PrismaClient()
}

declare global {
  var prisma: undefined | ReturnType<typeof prismaClientSingleton>
}

export const prisma = globalThis.prisma ?? prismaClientSingleton()

if (process.env.NODE_ENV !== 'production') globalThis.prisma = prisma

这个解决方案的关键改进在于:

  1. 将Prisma Client的创建封装在一个函数中
  2. 使用ReturnType获取该函数的返回类型
  3. 在全局类型声明中使用这个返回类型

实现原理

这种解决方案之所以有效,是因为:

  1. 函数封装:通过将Prisma Client的创建封装在函数中,我们可以利用TypeScript的类型推断能力
  2. ReturnType工具类型ReturnType能够动态获取函数的返回类型,包括通过$extends添加的任何扩展方法
  3. 全局类型声明:在全局作用域中声明类型,确保在整个应用中类型一致性

实际应用

在实际项目中应用这个解决方案后:

  1. 开发者可以安全地使用$extends方法添加自定义查询
  2. TypeScript能够正确识别所有扩展方法
  3. 保持了单例模式的性能优势
  4. 在开发和生产环境中都能正常工作

最佳实践

对于T3 Stack项目,建议:

  1. src/server/db.ts中实现这个改进后的Prisma Client初始化
  2. 对于复杂的扩展逻辑,可以考虑单独创建扩展文件
  3. 在团队项目中,确保所有成员都使用相同的Prisma Client实例

这种改进不仅解决了类型推断问题,还为项目提供了更好的类型安全性和开发体验,是T3 Stack项目中Prisma集成的推荐实践。

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

热门内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
260
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
854
505
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
254
295
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
331
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
397
370
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
21
5