
本文旨在解决prisma client扩展在模块化组织时遇到的类型复杂性问题。通过深入分析prisma `$extends` 方法的类型结构,我们将学习如何利用typescript的 `extract` 和 `parameters` 工具类型,从基础prisma客户端中精确提取出扩展配置的类型定义。这种方法能有效实现扩展逻辑的分离,同时确保完整的类型安全和代码可维护性。
Prisma Client 扩展(Extensions)是Prisma提供的一项强大功能,允许开发者在不修改生成客户端代码的情况下,为Prisma Client添加自定义逻辑、修改查询行为或引入新的模型方法。这对于实现业务逻辑、审计日志、多租户等场景非常有用。
例如,我们可能需要为 Company 模型的 update 操作添加特定逻辑,如当公司状态变为 DECLINED 时,自动锁定关联用户的账户。
import { PrismaClient, CompanyStatus, AccountLockedReason } from '@prisma/client';
const _prismaClient = new PrismaClient(); // 基础 PrismaClient 实例
const prismaClient = _prismaClient.$extends({
query: {
company: {
update: async ({ args, query }) => {
if (args.data?.status === CompanyStatus.DECLINED) {
args.data.user = {
update: {
accountLocked: AccountLockedReason.COMPANY_DECLINED,
},
};
}
return query(args);
},
},
},
});
export type ExtendedPrismaClient = typeof prismaClient;虽然上述代码在单个文件中运行良好,但随着项目规模的扩大和扩展逻辑的增多,将所有扩展集中在一个文件中会导致代码臃肿且难以维护。理想情况下,我们希望将不同模型的扩展逻辑分离到各自的文件中,例如将 company 相关的扩展逻辑放入 companyExtensions.ts。
当尝试将扩展逻辑分离时,最大的挑战在于如何为分离出的对象提供准确的TypeScript类型定义,以确保在外部文件中编写扩展时依然能获得完整的类型提示和检查。
考虑以下分离尝试:
// companyExtensions.ts
// 我们需要为 companyExtensions 提供一个类型定义
export const companyExtensions = {
update: async ({ args, query }) => {
if (args.data?.status === CompanyStatus.DECLINED) {
args.data.user = {
update: {
accountLocked: AccountLockedReason.COMPANY_DECLINED,
},
};
}
return query(args);
},
};
// prismaClient.ts
import { PrismaClient } from '@prisma/client';
import { companyExtensions } from './companyExtensions';
const _prismaClient = new PrismaClient();
const prismaClient = _prismaClient.$extends({
query: {
company: companyExtensions, // 这里需要 companyExtensions 具有正确的类型
},
});直接将 companyExtensions 定义为一个匿名对象会导致其内部的 args 和 query 参数失去类型信息。简单的尝试,如 type CompanyExtensions = Parameters<typeof prismaClient['$extends']>[0],也往往不能奏效,原因在于 prismaClient 已经是扩展过的实例,其 $extends 方法的类型可能更复杂,且我们通常需要的是未扩展的基客户端的扩展参数类型。此外,Parameters<typeof _prismaClient.$extends>[0] 得到的类型可能是一个非常宽泛的联合类型,难以直接用于局部定义。
Prisma 提供了 defineExtension 函数,但它主要用于发布通用的、可分发的客户端扩展,并且通常不包含针对特定模型参数的详细类型信息,这与我们为特定应用场景定义细粒度扩展的需求不完全匹配。
解决这个问题的关键在于利用 TypeScript 的高级工具类型 Parameters 和 Extract,从基础的 _prismaClient 实例中精确地提取出 $extends 方法的配置对象类型。
获取 $extends 方法的参数类型Parameters<typeof _prismaClient.$extends>[0] 会返回 _prismaClient.$extends 方法的第一个参数的类型。这个参数是一个包含 query、model、client 等属性的配置对象,其类型通常是一个复杂的联合类型。
使用 Extract 缩小类型范围Extract<Type, Union> 工具类型用于从 Type 中提取所有可赋值给 Union 的成员。在这里,我们可以利用 $extends 配置对象的一个共同特征——它通常包含一个可选的 name 属性(尽管我们不一定使用它),来帮助 TypeScript 准确识别出我们需要的配置对象结构。
结合以上两点,我们可以定义一个通用的 ExtensionArgs 类型:
// types/prisma-extensions.d.ts 或任何 .ts 文件
import { PrismaClient } from '@prisma/client';
// 假设 _prismaClient 是未扩展的 PrismaClient 实例
// 这里我们使用 typeof new PrismaClient() 来获取基础客户端的类型
// 避免循环依赖,或者从一个已知的基础客户端实例获取类型
type BasePrismaClient = PrismaClient; // 也可以直接使用 PrismaClient
/**
* 提取 Prisma Client $extends 方法的配置参数类型。
* 通过 Extract<{ name?: string }> 来筛选出符合扩展配置对象特征的类型。
* 这有助于从复杂的联合类型中精确地获取所需的类型结构。
*/
export type ExtensionArgs = Extract<
Parameters<typeof BasePrismaClient['$extends']>[0],
{ name?: string }
>;现在,我们可以使用 ExtensionArgs 来定义我们的模块化扩展:
// companyExtensions.ts
import { CompanyStatus, AccountLockedReason } from '@prisma/client';
import { ExtensionArgs } from './types/prisma-extensions'; // 导入我们定义的类型
// 声明 companyExtensions 为 ExtensionArgs 类型的一部分
// 这里我们只关注 query.company 部分,所以可以进一步缩小类型
export const companyExtensions: ExtensionArgs['query']['company'] = {
update: async ({ args, query }) => {
if (args.data?.status === CompanyStatus.DECLINED) {
args.data.user = {
update: {
accountLocked: AccountLockedReason.COMPANY_DECLINED,
},
};
}
return query(args);
},
};// prismaClient.ts
import { PrismaClient } from '@prisma/client';
import { companyExtensions } from './companyExtensions';
const _prismaClient = new PrismaClient(); // 基础 PrismaClient 实例
export const prismaClient = _prismaClient.$extends({
query: {
company: companyExtensions,
},
});
export type ExtendedPrismaClient = typeof prismaClient;通过这种方式,companyExtensions 对象现在拥有了完整的类型信息。在编写 update 方法时,args 和 query 参数将获得 Prisma 提供的精确类型提示,包括 args.data 的结构、args.where 等。
通过上述方法,开发者可以自信地将 Prisma Client 扩展拆分到独立的模块中,同时享受 TypeScript 带来的强大类型检查和开发体验,从而构建出更加健壮和易于管理的应用。
以上就是Prisma Client 扩展类型提取与模块化管理教程的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号