跳到主内容

如何在 Turborepo 中使用 Prisma ORM

15 分钟

Prisma 是一款强大的数据库 ORM，而 Turborepo 简化了 monorepo 工作流程。通过结合这些工具，您可以为项目创建可扩展、模块化的架构。

本指南将向您展示如何在 Turborepo monorepo 中将 Prisma 设置为独立包，从而在多个应用程序之间实现高效配置、类型共享和数据库管理。

您将学到什么：​

  • 如何在 Turborepo monorepo 中设置 Prisma。
  • 在包之间生成和重用 PrismaClient 的步骤。
  • 将 Prisma 包集成到 monorepo 中的其他应用程序中。

先决条件​

1. 设置您的项目​

要设置名为 turborepo-prisma 的 Turborepo monorepo，请运行以下命令

npx create-turbo@latest turborepo-prisma

系统会提示您选择包管理器，本指南将使用 npm

信息
  • 您想使用哪个包管理器？ npm

设置完成后，为项目选择一个包管理器。导航到项目根目录并安装 Turborepo 作为开发依赖项

cd turborepo-prisma
npm install turbo --save-dev

有关安装 Turborepo 的更多信息，请参阅 官方 Turborepo 指南。

2. 向 monorepo 添加一个新的 database 包​

2.1 创建包并安装 Prisma​

在 packages 目录中创建一个 database 包。然后，通过运行以下命令为该包创建 package.json 文件

cd packages/
mkdir database
cd database
touch package.json

将 package.json 文件定义如下

packages/database/package.json
{
  "name": "@repo/db",
  "version": "0.0.0"
}

接下来，安装使用 Prisma ORM 所需的依赖项。使用您首选的包管理器

npm install prisma --save-dev
npm install @prisma/client
注意

如果使用 Prisma Postgres，请安装 @prisma/extension-accelerate 包

npm install @prisma/extension-accelerate

2.2. 初始化 Prisma 并定义模型​

在 database 目录内，运行以下命令初始化 Prisma

npx prisma init --db --output ../generated/prisma

这将在 packages/database 内部创建几个文件

  • 一个包含 schema.prisma 文件的 prisma 目录。
  • 一个 Prisma Postgres 数据库。
  • 项目根目录中包含 DATABASE_URL 的 .env 文件。
  • 一个用于生成 Prisma Client 的 output 目录，路径为 generated/prisma。

在 packages/database/prisma/schema.prisma 文件中，添加以下模型

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

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

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

model Post {
  id        Int     @id @default(autoincrement())
  title     String
  content   String?
  published Boolean @default(false)
  authorId  Int
  author    User    @relation(fields: [authorId], references: [id])
}
警告

建议将 ../generated/prisma 添加到 .gitignore 文件中，因为它包含平台特定的二进制文件，可能导致不同环境之间的兼容性问题。

在自定义目录中生成 Prisma 类型的重要性​

在 schema.prisma 文件中，我们指定了一个自定义的 output 路径，Prisma 将在此处生成其类型。这确保了 Prisma 的类型在不同的包管理器中都能正确解析。

信息

在本指南中，类型将在 database/generated/prisma 目录中生成。

2.3. 添加脚本并运行迁移​

让我们在 packages/database 内部的 package.json 中添加一些脚本

packages/database/package.json
{
  "name": "@repo/db",
  "version": "0.0.0",
  "scripts": {
    "db:generate": "prisma generate",
    "db:migrate": "prisma migrate dev --skip-generate",
    "db:deploy": "prisma migrate deploy"
  },
  "devDependencies": {
    "prisma": "^6.6.0"
  },
  "dependencies": {
    "@prisma/client": "^6.6.0"
  }
}

我们还将这些脚本添加到根目录的 turbo.json 中，并确保 DATABASE_URL 已添加到环境中

turbo.json
{
"$schema": "https://turbo.net.cn/schema.json",
"ui": "tui",
"tasks": {
  "build": {
    "dependsOn": ["^build"],
    "inputs": ["$TURBO_DEFAULT$", ".env*"],
    "outputs": [".next/**", "!.next/cache/**"],
    "env": ["DATABASE_URL"]
  },
  "lint": {
    "dependsOn": ["^lint"]
  },
  "check-types": {
    "dependsOn": ["^check-types"]
  },
  "dev": {
    "cache": false,
    "persistent": true
  },
  "db:generate": {
    "cache": false
  },
  "db:migrate": {
    "cache": false,
    "persistent": true // This is necessary to interact with the CLI and assign names to your database migrations.
  },
  "db:deploy": {
    "cache": false
  }
}

迁移您的 prisma.schema 并生成类型

导航到项目根目录并运行以下命令以自动迁移我们的数据库

npx turbo db:migrate

生成您的 prisma.schema

要从 Prisma schema 生成类型，请在项目根目录运行

npx turbo db:generate

2.4. 导出 Prisma 客户端和类型​

接下来，导出生成的类型和 PrismaClient 实例，以便在您的应用程序中使用。

在 packages/database 目录中，创建一个 src 文件夹并添加一个 client.ts 文件。此文件将定义 PrismaClient 的实例

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

const globalForPrisma = global as unknown as { prisma: PrismaClient };

export const prisma =
  globalForPrisma.prisma || new PrismaClient().$extends(withAccelerate());

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

然后在 src 文件夹中创建一个 index.ts 文件，重新导出生成的 Prisma 类型和 PrismaClient 实例

packages/database/src/index.ts
export { prisma } from './client' // exports instance of prisma 
export * from "../generated/prisma" // exports generated types from prisma

遵循 即时打包模式，并在 packages/database/package.json 中创建包的入口点

警告

如果您不使用打包器，请改用 编译包 策略。

packages/database/package.json
{
  "name": "@repo/db",
  "version": "0.0.0",
  "scripts": {
    "db:generate": "npx prisma generate",
    "db:migrate": "npx prisma migrate dev --skip-generate",
    "db:deploy": "npx prisma migrate deploy"
  },
  "devDependencies": {
    "prisma": "^6.6.0"
  },
  "dependencies": {
    "@prisma/client": "^6.6.0"
  },
  "exports": {
    ".": "./src/index.ts"
  }
}

完成这些步骤后，您就可以在整个 monorepo 中访问 Prisma 类型和 PrismaClient 实例。

3. 在 Web 应用中导入 database 包​

turborepo-prisma 项目应在 apps/web 处有一个名为 web 的应用程序。将 database 依赖项添加到 apps/web/package.json

{
  // ...
  "dependencies": {
    "@repo/db": "*"
    // ...
  }
  // ...
}

在 apps/web 目录内运行您的包管理器的安装命令

cd apps/web
npm install

让我们从 web 应用程序中的 database 包导入实例化后的 prisma 客户端。

在 apps/web/app 目录中，打开 page.tsx 文件并添加以下代码

apps/web/app/page.tsx
import styles from "./page.module.css";
import { prisma } from "@repo/db";

export default async function Home() {
  const user = await prisma.user.findFirst() 
  return (
    <div className={styles.page}>
      {user?.name ?? "No user added yet"}
    </div>
  );
}

然后，在 web 目录中创建一个 .env 文件，并将 /database 目录中包含 DATABASE_URL 的 .env 文件内容复制到其中。

apps/web/.env
DATABASE_URL="Same database url as used in the database directory"
注意

如果您想在 Turborepo 设置中，在所有应用程序和包中使用根目录中的单个 .env 文件，请考虑使用 dotenvx 等包。

要实现这一点，请更新每个包或应用程序的 package.json 文件，以确保它们从共享的 .env 文件加载所需的环境变量。有关详细说明，请参阅 Turborepo 的 dotenvx 指南。

请记住，Turborepo 建议为每个包使用单独的 .env 文件，以促进模块化并避免潜在冲突。

4. 配置 Turborepo 中的任务依赖项​

db:generate 和 db:deploy 脚本尚未针对 monorepo 设置进行优化，但对于 dev 和 build 任务至关重要。

如果新开发人员在未首先运行 db:generate 的情况下运行应用程序上的 turbo dev，他们将遇到错误。

为防止这种情况发生，请确保在运行 dev 或 build 之前始终执行 db:generate。此外，请确保在 db:build 之前执行 db:deploy 和 db:generate。以下是如何在 turbo.json 文件中配置它们：

turbo.json
{
  "$schema": "https://turbo.net.cn/schema.json",
  "ui": "tui",
  "tasks": {
    "build": {
      "dependsOn": ["^build", "^db:generate"],
      "inputs": ["$TURBO_DEFAULT$", ".env*"],
      "outputs": [".next/**", "!.next/cache/**"],
      "env": ["DATABASE_URL"]
    },
    "lint": {
      "dependsOn": ["^lint"]
    },
    "check-types": {
      "dependsOn": ["^check-types"]
    },
    "dev": {
      "dependsOn": ["^db:generate"],
      "cache": false,
      "persistent": true
    },
    "db:generate": {
      "cache": false
    },
    "db:migrate": {
      "cache": false,
      "persistent": true
    },
    "db:deploy": {
      "cache": false
    }
  }
}

5. 在开发环境中运行项目​

警告

在启动开发服务器之前，请注意，如果您使用的是 Next.js v15.2.0，请不要使用 Turbopack，因为存在已知的 问题。通过更新 apps/web/package.json 从开发脚本中移除 Turbopack

apps/web/package.json
"script":{
    "dev": "next dev --port 3000",
}

然后从项目根目录运行项目

npx turbo run dev --filter=web

导航到 http://localhost:3000，您应该会看到消息

No user added yet
注意

您可以通过创建种子脚本或手动使用 Prisma Studio 将用户添加到数据库。

要使用 Prisma Studio 通过 GUI 手动添加数据，请导航到 packages/database 目录并使用您的包管理器运行 prisma studio

npx prisma studio

此命令会在 http://localhost:5555 启动一个带 GUI 的服务器，允许您查看和修改数据。

恭喜，您已完成 Turborepo 的 Prisma 设置！

后续步骤​

  • 扩展您的 Prisma 模型以处理更复杂的数据关系。
  • 实现额外的 CRUD 操作以增强应用程序的功能。
  • 查看 Prisma Postgres，了解如何扩展您的应用程序。

更多信息​


与 Prisma 保持联系

通过以下方式继续您的 Prisma 之旅 我们的活跃社区。保持信息灵通，积极参与，并与其他开发者协作

我们真诚地珍视您的参与，并期待您成为我们社区的一员！