跳到主要内容

rejectOnNotFound 变更

从 Prisma ORM 5.0.0 版本开始,已弃用的参数 rejectOnNotFound 已被移除。根据您的项目是按查询还是全局使用 rejectOnNotFound,更新代码的方式会有所不同。

如果您在每个查询的基础上使用 rejectOnNotFound 参数,请按照我们的步骤在查询级别更新您的代码

相反,如果您在客户端级别设置了 rejectOnNotFound 参数,您将需要按照在客户端级别更新您的代码的步骤进行操作。

Prisma ORM 5 的完整变更列表可以在我们的发布说明中找到。

替换在查询级别启用的 rejectOnNotFound

如果您之前在每个查询的基础上启用了 rejectOnNotFound,您将需要在查询级别替换您的用法。您可以使用我们的 *OrThrow 查询变体,findFirstOrThrowfindUniqueOrThrow,而不是向 findFirstfindUnique() 提供参数。

简单的 rejectOnNotFound 用法

以下示例

prisma.user.findFirst({
where: { name: 'Alice' },
rejectOnNotFound: true,
})

需要转换为

prisma.user.findFirstOrThrow({
where: { name: 'Alice' },
})

带有自定义错误处理程序的 rejectOnNotFound 用法

如果您使用如下自定义错误处理程序

prisma.user.findFirst({
where: { name: 'Alice' },
rejectOnNotFound: () => new UserNotFoundError(),
})

您将需要修改您的代码以处理 ...OrThrow 方法抛出的错误。

try {
await prisma.user.findFirstOrThrow({
where: { name: 'Alice' },
})
} catch (err) {
if (err.code === 'P2025') {
throw new UserNotFoundError()
}
throw err
}

如果您的错误处理程序在多个地方使用,您还可以创建一个可重用的错误适配器,然后可以在您的函数上调用的 .catch() 中使用该适配器。

const adaptError = (customThrowFn) => (error) => {
if (error.code === 'P2025') {
throw customThrowFn()
}
throw error
}

const user = await prisma.user.findFirstOrThrow({
where: { name: 'Alice' },
}).catch(adaptError(() => new MyCustomError())

替换在客户端级别启用的 rejectOnNotFound

通过 Prisma Client 构造函数 rejectOnNotFound

如果您之前通过 Prisma Client 构造函数中的配置全局启用了 rejectOnNotFound,例如在这些示例中

// Example 1
const prisma = new PrismaClient({
rejectOnNotFound: true,
})

// Example 2
const prisma = new PrismaClient({
rejectOnNotFound: {
findUnique: true,
},
})

您将需要更新您的代码库以使用 findUniqueOrThrowfindFirstOrThrow 而不是 findUnique()findFirst,具体取决于您希望哪些调用抛出错误。

通过带有自定义错误处理程序的 Prisma Client 构造函数 rejectOnNotFound

相反,如果您将自定义错误处理程序与 rejectOnNotFound 属性一起使用,如这些示例所示

// Example 3
const prisma = new PrismaClient({
rejectOnNotFound: (err) => new Error('something'),
})

// Example 4
const prisma = new PrismaClient({
rejectOnNotFound: {
findUnique: (err) => new Error('something'),
},
})

// Example 5
const prisma = new PrismaClient({
rejectOnNotFound: {
findFirst: {
User: (err) => new Error('User error'),
Post: (err) => new Error('Post error'),
},
findUnique: {
User: (err) => new Error('User error'),
Post: (err) => new Error('Post error'),
},
},
})

您将需要更新您的方法用法为 ...OrThrow,然后使用客户端扩展,以便获得相同的行为。

例如,以下扩展将在 Prisma ORM 5 中提供与 Prisma ORM 4 及更低版本中 Example 5 相同的行为。

import { PrismaClient } from '@prisma/client';

const customErrorFunc = async (model, query, args) => {
try {
await query(args)
} catch (error: any) {
if (error.code === 'P2025') {
throw new Error(`${model} error`)
}
throw error;
}
}

const prisma = (new PrismaClient()).$extends({
query: {
user: {
async findFirstOrThrow({ model, query, args }) {
return await customErrorFunc(model, query, args)
},
async findUniqueOrThrow({ model, query, args }) {
return await customErrorFunc(model, query, args)
},
},
post: {
async findFirstOrThrow({ model, query, args }) {
return await customErrorFunc(model, query, args)
},
async findUniqueOrThrow({ model, query, args }) {
return await customErrorFunc(model, query, args)
},
},
},
})