首页
/ 在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集成的推荐实践。

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

项目优选

收起
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