当前位置：首页 > article >正文

使用 SurrealDB 构建高效的 GraphQL 后端

article 2025/2/10 2:43:19

1. SurrealDB 简介

SurrealDB 是一款新兴的分布式多模型数据库，它结合了关系型数据库（SQL 的强大查询能力）与 NoSQL 数据库的灵活性，支持图数据库的复杂关系查询，同时具有内置的实时订阅功能。相比传统数据库，它在以下方面有明显优势：

原生支持 GraphQL：可以直接通过 GraphQL 进行查询，无需额外的 ORM 层。
多模型存储：支持文档、表、图数据等多种存储模式。
简化查询逻辑：支持类似 SQL 的查询语法，同时允许 JSON 存储，减少数据转换成本。
高性能与水平扩展：采用分布式架构，具备自动扩展能力。
实时数据流：原生支持 WebSocket，可用于实时应用场景。

2. GraphQL 与 SurrealDB 的结合方式

GraphQL 是一种强类型查询语言，使前端能够精准地获取所需数据，减少冗余数据传输。SurrealDB 通过其 HTTP API、WebSocket 或直接嵌入的方式与 GraphQL 进行交互，主要有以下两种方式：

直接使用 SurrealDB 作为 GraphQL 数据源：SurrealDB 提供 RESTful API，可以直接用 GraphQL 解析请求并返回 JSON 数据。
通过 Apollo Server 连接 SurrealDB：在 Node.js 服务器端使用 Apollo Server 作为 GraphQL 解析层，SurrealDB 作为底层数据库。

3. 实战案例：构建一个 GraphQL API

3.1 环境准备

首先，安装 SurrealDB 并启动服务：

# 下载并启动 SurrealDB
curl -sSf https://install.surrealdb.com | sh
surreal start --log debug --user root --pass root

然后，在 Node.js 项目中安装 Apollo Server 和 SurrealDB 客户端：

npm install @apollo/server surrealdb.js graphql

3.2 连接 SurrealDB

创建一个 db.js 连接文件：

import { Surreal } from 'surrealdb.js';
const db = new Surreal();

(async () => {
    await db.connect('ws://127.0.0.1:8000/rpc');
    await db.signin({ user: 'root', pass: 'root' });
    await db.use('test', 'test');
})();

export default db;

3.3 定义 GraphQL Schema

创建 schema.js 文件：

import { gql } from 'graphql-tag';

export const typeDefs = gql`
  type User {
    id: ID!
    name: String!
    email: String!
  }

  type Query {
    users: [User]
    user(id: ID!): User
  }

  type Mutation {
    createUser(name: String!, email: String!): User
  }
`;

3.4 编写 Resolvers

创建 resolvers.js 文件：

import db from './db.js';

export const resolvers = {
  Query: {
    users: async () => await db.select('user'),
    user: async (_, { id }) => await db.select(`user:${id}`),
  },
  Mutation: {
    createUser: async (_, { name, email }) => {
      const user = { name, email };
      return await db.create('user', user);
    },
  },
};

3.5 启动 GraphQL 服务器

创建 server.js 文件：

import { ApolloServer } from '@apollo/server';
import { startStandaloneServer } from '@apollo/server/standalone';
import { typeDefs } from './schema.js';
import { resolvers } from './resolvers.js';

const server = new ApolloServer({ typeDefs, resolvers });
const { url } = await startStandaloneServer(server, { listen: { port: 4000 } });
console.log(`🚀 Server ready at ${url}`);

运行服务器：