使用Prisma与Fastify构建GraphQL API实战指南

使用Prisma与Fastify构建GraphQL API实战指南

本文将通过一个完整的示例项目，介绍如何基于Prisma ORM和Fastify框架构建一个功能完善的GraphQL API服务。我们将从环境搭建开始，逐步深入到数据模型设计、API开发以及项目演进的全过程。

技术栈概览

本项目采用以下技术组合：

1. Fastify - 一个高性能、低开销的Node.js Web框架
2. Mercurius - Fastify的GraphQL适配器
3. GraphQL Nexus - 用于定义GraphQL模式和实现解析器
4. Prisma Client - 现代化的数据库访问ORM工具
5. Prisma Migrate - 数据库迁移工具
6. SQLite - 轻量级文件数据库（可替换为其他数据库）

项目初始化与配置

环境准备

首先需要创建项目目录并初始化项目依赖。项目默认使用SQLite作为数据库，但也可以根据需要切换为PostgreSQL或其他数据库。

数据库设置

项目的数据模型定义在prisma/schema.prisma文件中，包含User和Post两个主要模型：

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

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

执行以下命令创建数据库并应用初始迁移：

npx prisma migrate dev --name init

此命令会：

1. 创建SQLite数据库文件
2. 生成并执行迁移脚本
3. 运行种子脚本填充初始数据

GraphQL API开发

模式定义

GraphQL模式定义在schema.graphql文件中，主要包含以下类型和操作：

type Query {
  feed(searchString: String, skip: Int, take: Int, orderBy: PostOrderByUpdatedAtInput): [Post!]!
  draftsByUser(userUniqueInput: UserUniqueInput!): [Post]
  postById(id: Int): Post
}

type Mutation {
  createDraft(authorEmail: String!, data: PostCreateInput!): Post
  deletePost(id: Int!): Post
  incrementPostViewCount(id: Int!): Post
  signupUser(data: UserCreateInput!): User!
  togglePublishPost(id: Int!): Post
}

解析器实现

解析器函数负责处理GraphQL操作，并使用Prisma Client与数据库交互。例如获取所有已发布文章的解析器：

{
  Query: {
    feed: (_parent, args, context: Context) => {
      return context.prisma.post.findMany({
        where: { published: true },
        include: { author: true }
      })
    }
  }
}

API使用示例

查询操作

获取所有已发布的文章及其作者信息：

query {
  feed {
    id
    title
    content
    published
    author {
      id
      name
      email
    }
  }
}

变更操作

创建新用户：

mutation {
  signupUser(data: { name: "Sarah", email: "sarah@example.com" }) {
    id
  }
}

创建草稿文章：

mutation {
  createDraft(
    data: { title: "Prisma入门指南", content: "Prisma是一个现代化的ORM工具" }
    authorEmail: "sarah@example.com"
  ) {
    id
    title
    content
    published
  }
}

项目演进：添加用户资料功能

随着业务需求变化，我们需要为系统添加用户资料功能。这个过程分为两个主要步骤：

1. 数据库迁移

首先更新Prisma数据模型，添加Profile模型：

model Profile {
  id     Int     @default(autoincrement()) @id
  bio    String?
  user   User    @relation(fields: [userId], references: [id])
  userId Int     @unique
}

然后执行迁移命令：

npx prisma migrate dev --name add-profile

2. API更新

更新GraphQL模式，添加相关类型和操作：

type Profile {
  id: ID!
  bio: String
  user: User
}

type Mutation {
  addProfileForUser(bio: String, userUniqueInput: UserUniqueInput): Profile
}

实现对应的解析器：

{
  addProfileForUser: (_parent, args, context: Context) => {
    return context.prisma.profile.create({
      data: {
        bio: args.bio,
        user: { connect: args.userUniqueInput }
      }
    })
  }
}

数据库切换配置

项目默认使用SQLite，但可以轻松切换到其他数据库。只需修改prisma/schema.prisma中的datasource配置：

PostgreSQL配置示例

datasource db {
  provider = "postgresql"
  url      = "postgresql://user:password@localhost:5432/mydb?schema=public"
}

MySQL配置示例

datasource db {
  provider = "mysql"
  url      = "mysql://user:password@localhost:3306/mydb"
}

总结

通过这个项目，我们展示了如何：

1. 使用Prisma定义数据模型并管理数据库
2. 基于Fastify构建高性能GraphQL服务
3. 实现完整的CRUD操作
4. 处理模型间的关系
5. 进行项目迭代和数据库迁移

这种技术组合特别适合需要快速开发且对性能有要求的应用场景。Prisma提供了直观的数据访问方式，而Fastify确保了服务的高性能，GraphQL则为前端提供了灵活的数据查询能力。