跳到主要内容

如何在 pnpm workspaces monorepo 中使用 Prisma ORM

10 分钟

Prisma 是一个强大的 ORM，用于管理您的数据库，当与 pnpm Workspaces 结合使用时，您可以维护精简且模块化的 monorepo 架构。在本指南中，我们将逐步介绍如何在 pnpm Workspaces monorepo 中设置 Prisma 在其自己的包中，从而在您的应用程序中实现可维护的类型共享和高效的数据库管理。

您将学到什么：​

  • 如何使用 pnpm Workspaces 初始化 monorepo。
  • 将 Prisma 作为独立包集成的步骤。
  • 如何在包之间生成和共享 Prisma Client。
  • 将 Prisma 包集成到您的工作区中的应用程序中。

1. 准备您的项目并配置 pnpm workspaces​

在集成 Prisma 之前，您需要设置您的项目结构。首先，为您的项目创建一个新目录（例如，my-monorepo）并初始化一个 Node.js 项目

mkdir my-monorepo
cd my-monorepo
pnpm init

接下来，创建一个 pnpm-workspace.yaml 文件来定义您的工作区结构并锁定 Prisma 版本

touch pnpm-workspace.yaml

将以下配置添加到 pnpm-workspace.yaml

pnpm-workspace.yaml
packages:
  - "apps/*"
  - "packages/*"
catalogs:
  prisma:
    prisma: latest
注意

catalogs 帮助您在整个仓库中锁定特定版本的 prisma。您可以在此处了解更多信息。显式锁定 prisma 的最新版本在 pnpm-workspace.yaml 文件中。在撰写本文时，这是版本 6.3.1。

最后，为您的应用程序和共享包创建目录

mkdir apps
mkdir -p packages/database

2. 设置共享数据库包​

本节介绍如何创建一个使用 Prisma 的独立数据库包。该包将包含所有数据库模型和生成的 Prisma Client，使其可在您的 monorepo 中重用。

2.1. 初始化包并安装依赖项​

导航到 packages/database 目录并初始化一个新包

cd packages/database
pnpm init

在您的 package.json 中使用锁定的 catalog 将 Prisma 添加为开发依赖项

database/package.json
"devDependencies": {
  "prisma": "catalog:prisma"
}

然后安装 Prisma

pnpm install

然后，添加其他依赖项

pnpm add typescript tsx @types/node -D

然后安装使用 Prisma Postgres 所需的 Prisma Client 扩展

pnpm add @prisma/extension-accelerate
信息

本指南使用 Prisma Postgres。如果您计划使用不同的数据库，则可以省略 @prisma/extension-accelerate package。

为您的 database 包初始化一个 tsconfig.json 文件

pnpm tsc --init

2.2. 在您的数据库包中设置 Prisma ORM​

通过运行以下命令，在 database 包中使用 Prisma Postgres 的实例初始化 Prisma ORM

pnpm prisma init --db

输入您的项目名称并选择数据库区域。

信息

在本指南中，我们将使用 Prisma Postgres。如果您未使用 Prisma Postgres 数据库，则无需添加 --db 标志。

此命令

  • 将您的 CLI 连接到您的帐户。如果您未登录或没有帐户，您的浏览器将打开以指导您创建新帐户或登录现有帐户。
  • 创建一个 prisma 目录，其中包含用于您的数据库模型的 schema.prisma 文件。
  • 创建一个 .env 文件，其中包含您的 DATABASE_URL（例如，对于 Prisma Postgres，它应该类似于 DATABASE_URL="prisma+postgres://accelerate.prisma-data.net/?api_key=eyJhbGciOiJIUzI..."）。

编辑 schema.prisma 文件以在您的数据库中定义 User 模型，并指定一个自定义 output 目录来生成 Prisma Client。这确保生成的类型得到正确解析

prisma/schema.prisma
generator client {
  provider = "prisma-client-js"
  output = "../generated/client"
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

接下来，将辅助脚本添加到您的 package.json 以简化 Prisma 命令

database/package.json
{
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "db:generate": "prisma generate --no-engine",
    "db:migrate": "prisma migrate dev",
    "db:deploy": "prisma migrate deploy",
    "db:studio": "prisma studio"
  }
}

使用 Prisma Migrate 迁移您的数据库更改

pnpm run db:migrate

当 CLI 提示时，为您的迁移输入一个描述性名称。

迁移成功后，创建一个 client.ts 文件以使用 Accelerate 扩展初始化 Prisma Client

database/client.ts
import { PrismaClient } from "./generated/client";
import { withAccelerate } from '@prisma/extension-accelerate'

const prisma = new PrismaClient().$extends(withAccelerate())

const globalForPrisma = global as unknown as { prisma: typeof prisma }

if (process.env.NODE_ENV !== 'production') globalForPrisma.prisma = prisma

export { prisma };

然后，创建一个 index.ts 文件以重新导出 Prisma Client 的实例和所有生成的类型

database/index.ts
export { prisma } from "./client";
export * from "./generated/client";

此时，您的共享数据库包已完全配置，可以跨您的 monorepo 使用。

3. 设置和集成您的前端应用程序​

既然数据库包已设置完成，创建一个前端应用程序（使用 Next.js），该应用程序使用共享的 Prisma Client 与您的数据库进行交互。

3.1. 引导 Next.js 应用程序​

导航到 apps 目录

cd ../../apps

创建一个名为 web 的新 Next.js 应用程序

pnpm create next-app@latest web --yes

然后，导航到 web 目录

cd web/

从数据库包复制 .env 文件，以确保相同的环境变量可用

cp ../../packages/database/.env .
重要提示

--yes 标志使用默认配置来引导 Next.js 应用程序（在本指南中，它使用没有 src/ 目录的 app router 和 pnpm 作为安装程序）。

此外，该标志可能会自动在 web 文件夹中初始化 Git 仓库。如果发生这种情况，请通过运行 rm -r .git 删除 .git 目录。

打开您的 Next.js 应用程序的 package.json 文件，并将共享的 database 包添加为依赖项

web/package.json
"dependencies": {
  "database": "workspace:*",
  // additional dependencies
  // ...
}

运行以下命令以安装 database 包

pnpm install

3.2. 在您的应用程序代码中集成共享的 database 包​

修改您的 Next.js 应用程序代码以使用来自数据库包的 Prisma Client。按如下方式更新 app/page.tsx

app/page.tsx
import { prisma } from "database";

export default async function Home() {
  const user = await prisma.user.findFirst({
    select: {
      name: true
    }
  })

  return (
    <div>
      {user?.name && <p>Hello from {user.name}</p>}
      {!user?.name && <p>No user has been added to the database yet. </p>}
    </div>
  );
}

此代码演示了导入和使用共享的 Prisma Client 来查询您的 User 模型。

3.3. 添加辅助脚本并运行您的应用程序​

将以下脚本添加到您的 monorepo 的根 package.json 中。它们确保数据库迁移、类型生成和应用程序构建以正确的顺序运行

"scripts": {
  "build": "pnpm --filter database db:deploy && pnpm --filter database db:generate  && pnpm --filter web build",
  "start": "pnpm --filter web start",
  "dev": "pnpm --filter database db:generate && pnpm --filter web dev",
  "studio": "pnpm --filter database db:studio"
}

3.4. 运行您的应用程序​

然后回到 monorepo 的根目录

cd ../../

通过执行以下命令启动您的开发服务器

pnpm run dev

在浏览器中打开 https://127.0.0.1:3000 以查看您的应用程序运行效果。

3.5. （可选）使用 Prisma Studio 向您的数据库添加数据​

您的数据库中尚不应有数据。您可以在 CLI 中执行 pnpm run studio 以在 Prisma Studio 中启动 https://127.0.0.1:5555 以与您的数据库交互并向其中添加数据。

下一步​

您现在已经创建了一个有效使用 Prisma ORM 的 monorepo，其中共享数据库包已集成到 Next.js 应用程序中。

为了进一步探索和增强您的设置，请考虑阅读 如何将 Prisma ORM 与 Turborepo 一起使用 指南。