理解 Prisma Client result 扩展的同步特性
prisma client 的 result 扩展提供了一种在模型结果中添加计算字段的便捷方式。例如，你可以基于 name 和 age 字段计算出一个 nameandage 字段。然而，需要注意的是，result 扩展中的 compute 函数是同步执行的。这意味着它不能直接 await 任何异步操作。
考虑以下场景，我们希望在计算字段中调用一个异步函数 getdata() 来获取额外信息：
async function getdata(): Promise<string> {
return "external data here!";
}
import { PrismaClient } from "@prisma/client";
const prisma = new PrismaClient().$extends({
result: {
user: {
nameAndAge: {
needs: {
name: true,
age: true,
},
compute(user) {
// 尝试直接拼接异步函数的返回值
return `${user.name} (${user.age}y)` + getdata();
},
},
},
},
});
async function main() {
const user = await prisma.user.findFirst();
console.log(user?.nameAndAge);
}
main();执行上述代码，你可能会得到类似 Sonia Lomo (25y)[object Promise] 的输出，这表明 getdata() 返回的是一个 Promise 对象，而不是其解析后的值。即使尝试将 compute 函数声明为 async 并 await getdata()：
async compute(user) {
return `${user.name} (${user.age}y)` + await getdata();
},结果仍然会是 Promise { <pending> }。这是因为 Prisma Client 官方设计 result 扩展的目的是以最小的开销添加同步计算的字段，并且出于性能考虑，这些字段是在访问时而不是在检索时计算的。
解决方案一：返回一个异步函数
由于 compute 函数本身不能是异步的，但它可以返回一个异步函数。这种方法允许你将异步逻辑封装在一个函数中，并在需要时显式地调用并 await 它。
async function getdata(): Promise<string> {
return "external data here!";
}
import { PrismaClient } from "@prisma/client";
const prisma = new PrismaClient().$extends({
result: {
user: {
// 定义一个返回异步函数的字段
getNameAndAge: {
needs: { name: true, age: true },
compute(user) {
// compute 函数返回一个 async 函数
return async () => (`${user.name} (${user.age}y) ${await getdata()}`);
},
},
},
},
});
async function main() {
const users = await prisma.user.findMany();
if (users.length > 0) {
// 当需要获取计算字段的值时，显式调用并 await 这个异步函数
const joeNameAndAge = await users[0].getNameAndAge();
console.log(joeNameAndAge); // 输出: Sonia Lomo (25y) external data here!
}
}
main();优点：
- 保持了 result 扩展的初衷，即在模型上添加派生字段。
- 将异步操作的执行推迟到实际需要其值的时候，避免不必要的计算。
缺点：
- 获取计算字段的值不再是直接访问属性，而是需要显式调用一个异步方法。
- 如果需要在列表中的每个用户都获取这个值，你可能需要在一个循环中多次 await，这可能导致 N+1 查询问题，需要谨慎优化。
解决方案二：利用模型扩展 (Model Extensions) 处理异步数据
如果你的异步逻辑与数据查询紧密相关，并且希望在数据返回之前就完成处理，那么 model 扩展是一个更合适的选择。model 扩展允许你在 Prisma Client 的模型上定义自定义方法，这些方法可以完全控制数据查询和后处理。
import { PrismaClient, Prisma } from "@prisma/client";
async function getdata(): Promise<string> {
return "external data here!";
}
// 定义一个类型，用于扩展方法的参数
export type UserFindManyWithDataArgs = {
where?: Prisma.UserWhereInput;
select?: Prisma.UserSelect;
};
const prisma = new PrismaClient().$extends({
model: {
user: {
/**
* 自定义查找多个用户的方法，并在其中处理异步数据。
* @param args 查询参数，包括 where 和 select。
* @returns 包含异步计算字段的用户列表。
*/
async findManyWithExternalData({ where, select }: UserFindManyWithDataArgs) {
const users = await prisma.user.findMany({ where, select });
// 对每个用户执行异步操作并添加计算字段
// 注意：这种方式可能导致 N+1 查询问题，更优的策略是使用 Promise.all 并行处理
const usersWithData = await Promise.all(users.map(async (user) => {
const externalInfo = await getdata(); // 异步获取外部数据
// 将计算字段直接添加到用户对象上
return {
...user,
nameAndAge: `${user.name} (${user.age}y) ${externalInfo}`
};
}));
return usersWithData;
},
},
},
});
async function main() {
// 使用自定义的 model 扩展方法
const users = await prisma.user.findManyWithExternalData({
where: {
age: { gt: 20 }
},
select: {
id: true,
name: true,
age: true
}
});
users.forEach(user => {
console.log(user.nameAndAge); // 直接访问已计算好的字段
});
}
main();优点：
- 将复杂的异步数据处理逻辑封装在模型方法中，提高了代码的内聚性。
- 在数据返回给调用者之前，所有异步计算都已完成，调用者可以直接访问已解析的字段。
- 可以更好地控制查询和数据处理流程，例如通过 Promise.all 优化并行异步操作，避免 N+1 查询。
缺点：
- 需要为每个自定义查询编写新的扩展方法，增加了客户端代码量。
- 自定义方法可能会绕过 result 扩展的某些自动计算特性。
总结与注意事项
- result 扩展主要用于同步、低开销的字段计算，例如基于现有字段进行字符串拼接或简单逻辑判断。如果你的计算字段需要执行异步操作（如数据库查询、API 调用），result 扩展的 compute 函数不适合直接 await。
- 当异步计算字段需要延迟加载且不希望影响初始查询性能时，解决方案一（返回异步函数）是合适的。
- 当异步计算字段需要在数据检索时就完成处理，并且逻辑复杂、涉及多个异步步骤时，解决方案二（model 扩展）提供了更大的灵活性和控制力。它允许你在查询阶段就整合异步逻辑，并可进行性能优化（如使用 Promise.all）。
- 在使用 model 扩展处理列表数据时，务必注意性能问题。如果每个数据项都需要独立的异步调用，考虑使用 Promise.all 等并发机制来避免串行执行带来的性能瓶颈。
选择哪种解决方案取决于你的具体需求和对性能、代码可读性的权衡。理解 Prisma Client 扩展的设计哲学是有效利用其强大功能的关键。
