Prisma ORM 实战：基于 Apollo Server 和 Nexus 实现 GraphQL 订阅功能

Prisma ORM 实战：基于 Apollo Server 和 Nexus 实现 GraphQL 订阅功能

prisma-examples 🚀 Ready-to-run Prisma example projects 项目地址: https://gitcode.com/gh_mirrors/pr/prisma-examples

技术栈概览

本文将通过一个博客系统示例，演示如何使用以下技术栈实现 GraphQL 订阅功能：

• Apollo Server：强大的 GraphQL 服务器实现
• GraphQL Nexus：类型安全的 GraphQL Schema 构建工具
• Prisma Client：现代化的 TypeScript ORM
• Prisma Migrate：数据库迁移工具
• SQLite：轻量级文件数据库（可替换为其他数据库）

核心概念解析

GraphQL 订阅机制

GraphQL 订阅是一种实时通信机制，允许客户端订阅特定事件，当这些事件发生时服务器会主动推送数据。与传统的轮询方式相比，订阅机制更加高效和实时。

实现原理

本示例中使用了 Apollo Server 内置的 PubSub 系统，它基于发布-订阅模式：

1. 客户端发起订阅请求
2. 服务器将客户端添加到订阅者列表
3. 当相关事件发生时（如创建新文章），服务器发布事件
4. 所有订阅该事件的客户端都会收到通知

环境准备

1. 初始化项目

建议使用以下命令快速创建项目：

npx try-prisma@latest --template orm/graphql-subscriptions
cd graphql-subscriptions

2. 数据库设置

默认使用 SQLite 数据库，执行以下命令初始化数据库：

npx prisma migrate dev --name init

此命令会：

• 创建数据库文件
• 根据 schema 定义创建表结构
• 执行种子脚本填充初始数据

3. 启动开发服务器

npm run dev

服务器启动后，访问 http://localhost:4000 可以使用 GraphQL Playground 进行测试。

核心功能实现

订阅新文章创建

在 GraphQL Playground 中执行以下订阅：

subscription {
  newPost {
    id
    title
    published
    author {
      id
      email
      name
    }
  }
}

此时 Playground 会进入等待状态，直到有新文章创建时才会收到通知。

创建草稿文章

在另一个 Playground 标签页中执行创建操作：

mutation {
  createDraft(
    data: { 
      title: "Prisma 实战指南", 
      content: "本文介绍 Prisma 的高级用法" 
    }
    authorEmail: "alice@prisma.io"
  ) {
    id
    author {
      id
      name
    }
  }
}

执行后，订阅端会立即收到新创建的文章数据。

文章发布订阅

还可以订阅文章发布事件：

subscription {
  postPublished {
    id
    title
    published
    author {
      id
      name
      email
    }
  }
}

当执行发布操作时：

mutation {
  togglePublishPost(id: 1) {
    id
    published
  }
}

注意：只有当文章从未发布状态变为已发布状态时，订阅才会触发。

数据库适配

本示例默认使用 SQLite，但可以轻松切换到其他数据库：

PostgreSQL 配置示例

修改 prisma/schema.prisma 文件：

datasource db {
  provider = "postgresql"
  url      = "postgresql://用户名:密码@主机:端口/数据库名?schema=模式名"
}

MySQL 配置示例

datasource db {
  provider = "mysql"
  url      = "mysql://用户名:密码@主机:端口/数据库名"
}

进阶建议

1. 生产环境优化：

   • 使用环境变量管理数据库连接
   • 考虑实现更健壮的 PubSub 实现（如 Redis）
   • 添加认证和授权层

2. 性能监控：

   • 实现订阅数量监控
   • 跟踪消息延迟

3. 客户端集成：

   • 在 React/Vue 等前端框架中实现订阅
   • 处理连接中断和重连逻辑

实现原理深入

在代码层面，订阅的实现主要涉及三个部分：

1. PubSub 实例创建：

   const pubsub = new PubSub()
   

2. 订阅解析器：

   t.field('newPost', {
     type: 'Post',
     subscribe: () => pubsub.asyncIterator('NEW_POST')
   })
   

3. 事件发布：

   pubsub.publish('NEW_POST', { newPost: createdPost })
   

这种模式可以灵活扩展到各种实时场景，如聊天应用、实时仪表盘等。

prisma-examples 🚀 Ready-to-run Prisma example projects 项目地址: https://gitcode.com/gh_mirrors/pr/prisma-examples