在T3 Stack项目中优化Prisma Client的类型推断
2025-05-06 17:55:35作者:彭桢灵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
这个解决方案的关键改进在于:
- 将Prisma Client的创建封装在一个函数中
- 使用
ReturnType获取该函数的返回类型 - 在全局类型声明中使用这个返回类型
实现原理
这种解决方案之所以有效,是因为:
- 函数封装:通过将Prisma Client的创建封装在函数中,我们可以利用TypeScript的类型推断能力
- ReturnType工具类型:
ReturnType能够动态获取函数的返回类型,包括通过$extends添加的任何扩展方法 - 全局类型声明:在全局作用域中声明类型,确保在整个应用中类型一致性
实际应用
在实际项目中应用这个解决方案后:
- 开发者可以安全地使用
$extends方法添加自定义查询 - TypeScript能够正确识别所有扩展方法
- 保持了单例模式的性能优势
- 在开发和生产环境中都能正常工作
最佳实践
对于T3 Stack项目,建议:
- 在
src/server/db.ts中实现这个改进后的Prisma Client初始化 - 对于复杂的扩展逻辑,可以考虑单独创建扩展文件
- 在团队项目中,确保所有成员都使用相同的Prisma Client实例
这种改进不仅解决了类型推断问题,还为项目提供了更好的类型安全性和开发体验,是T3 Stack项目中Prisma集成的推荐实践。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C086
baihu-dataset异构数据集“白虎”正式开源——首批开放10w+条真实机器人动作数据,构建具身智能标准化训练基座。00
mindquantumMindQuantum is a general software library supporting the development of applications for quantum computation.Python057
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0136
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
470
3.48 K
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
65
19
暂无简介
Dart
718
172
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
212
85
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.27 K
696
无需学习 Kubernetes 的容器平台,在 Kubernetes 上构建、部署、组装和管理应用,无需 K8s 专业知识,全流程图形化管理
Go
15
1
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
1