GraphQL 服务端:一种简单实用的构建 API 的方法

阅读时长 9 分钟读完

GraphQL 是一种由 Facebook 开发的数据查询和操作语言,旨在为前后端数据交互提供更加灵活高效的解决方案。与传统的 RESTful API 不同,GraphQL 的 API 设计思想更加面向客户端需求,能够精确地获取客户端所需的数据,从而获得更好的性能和易用性。本文将详细介绍 GraphQL 服务端的设计和实现方法,并通过示例代码展示其具体应用。

GraphQL 服务端的设计方法

GraphQL 的服务端设计方法与传统的 RESTful API 有很大不同。传统的 RESTful API 通常采用基于资源的 URI 设计,通过不同的 URI 获得不同的资源,但这种方式存在以下几个问题:

  • API 设计过于依赖于 URL 设计,URL 一旦变更会产生不必要的麻烦。
  • 返回的数据结构不能根据客户端需求动态调整。
  • 不能一次性获取多个资源,需要多次请求。

而 GraphQL 服务端采用的是基于 Schema 的设计方法,将数据结构定义和查询操作分离开来,客户端通过向服务端发送查询请求,服务端返回客户端所需的数据,具体实现方法如下:

  1. 定义 Schema: 在 GraphQL 服务端,我们首先需要定义一个 Schema,Schema 是一种描述数据结构和操作的语言,包含数据类型、字段、查询、变更等元素。例如以下代码定义了一个 TodoList 的 Schema:
-- -------------------- ---- -------
---- ---- -
  --- ----
  ----- -------
  ---------- --------
-

---- ----- -
  ------------ -------
-

其中 Todo 表示一个 TodoItem,包含 id、text、completed 三个属性;Query 表示查询,getTodoList 表示获取 TodoItem 列表。

  1. 响应查询请求: 当客户端向服务端发送一个查询请求时,服务端会查询 Schema 中定义的数据并返回给客户端。例如以下代码实现了服务端的查询操作:
-- -------------------- ---- -------
------ - ---------------- - ---- ----------------

----- -------- - ----
  ---- ---- -
    --- ----
    ----- -------
    ---------- --------
  -
  
  ---- ----- -
    ------------ -------
  -
--

----- -------- - -
  - --- -- ----- -------- ------ ---------- ----- --
  - --- -- ----- ------ ------ ---------- ----- --
  - --- -- ----- -------- ------ ---------- ---- -
--

----- --------- - -
  ------ -
    ------------ -- -- --------
  -
--

----- ------ - --- -------------- --------- --------- ---

----------------------- --- -- -- -
  ---------------  ------ ----- -- ---------
---

在上述代码中,我们定义了一个 Schema,然后使用 ApolloServer 创建一个服务端实例,最后监听服务端的请求并响应客户端请求。

GraphQL 服务端的实现方法

在实现 GraphQL 服务端时,我们需要使用以下技术:

  1. 语言:GraphQL 支持多种语言,例如 JavaScript、Go、Java 等。

  2. 框架:GraphQL 框架有很多,例如 Apollo、Relay 等。

  3. 数据库:GraphQL 可以与多种数据库集成,例如 MongoDB、MySQL 等。

例如以下代码使用 express 框架、MongoDB 数据库实现了一个 TodoList 的 GraphQL 服务端:

-- -------------------- ---- -------
------ ------- ---- ----------
------ - ------------- --- - ---- ------------------------
------ - ----------- - ---- ----------

----- -------- - ----
  ---- ---- -
    --- ----
    ----- -------
    ---------- --------
  -

  ---- ----- -
    ------------ -------
  -

  ---- -------- -
    ----------------- --------- ----
    ------------------ ------ ----
  -
--

----- --------- - -
  ------ -
    ----- ------------------- ----- - -- -- ----- -
      ----- -------- - ----- --
        -----------------------
        ---------
        -----------
      ------ ---------
    -
  --
  --------- -
    ----- ------------------- - ---- -- - -- -- ----- -
      ----- -------- - - ----- ---------- ----- --
      ----- - ---------- - - ----- --
        -----------------------
        ---------------------
      ------ - --- ----------- ----------- --
    --
    ----- ---------------------- - -- -- - -- -- ----- -
      ----- -------- - ----- --
        -----------------------
        ---------- -- ---
      ----- - --- ----------- ----- --------- - - ---------
      ----- ----------- - - --- ----------- ----- ---------- ---------- --
      ----- --
        -----------------------
        --------- -- -- -------------
      ------ ------------
    -
  -
--

----- --- - ----------
----- ------ - --- --------------
  ---------
  ----------
  -------- ----- -- -- -
    ----- -- - ----- ----------------------------------------------------- -
      ---------------- -----
      ------------------- ----
    ---
    ------ - -- --
  -
---
------------------------ --- ---

------------ ----- ---- -- -- -- -
  ------------------- ----- -- ---------------------------------------------
---

在上述代码中,我们使用了 ApolloServer 框架,通过 MongoDB 存储数据,最后使用 express 框架将服务端与客户端连接起来。

GraphQL 服务端的示例代码

以下是一个完整的 GraphQL 服务端与客户端示例代码,包括添加 TodoItem 和获取 TodoList 两个操作:

-- -------------------- ---- -------
------ ----- ---- --------
------ -------- ---- ------------
------ - ------------- --------------- -------------- ---- -------- - ---- -----------------

----- ------------- - ----
  ----- ----------- -
    ----------- -
      --
      ----
      ---------
    -
  -
--

----- ------------- - ----
  -------- ------------------ -------- -
    ----------------- ------ -
      --
      ----
      ---------
    -
  -
--

-------- ----- -
  ----- - -------- ------ ----- ------- - - ------------------------

  -- --------- ------ ------------------
  -- ------- ------ -------- -------

  ------ -
    -----
      ----
        ------------------------------ -- -
          --- ------------------
            ------------------- - -------------------------- - --------------
          -----
        ---
      -----
      -----
        ----------- -- -
          -------------------
          ----- --------- - ---------------------
          ----- ---- - -----------------------
          --------------- - ---
          ------------- ---------- - ---- - ---------- -- -
            ----------
          ---
        --
      -
        ------ ----------- --
        ------- --------------------------
      -------
    ------
  --
-

----------------
  --------------- ----------------
    ---- --
  ------------------
  -------------------------------
--

在上述代码中,我们使用了 ApolloClient 作为客户端框架,并定义了两个 GraphQL 操作:获取 TodoList 和添加 TodoItem。在 App 组件中,我们使用 useQuery 钩子获取 TodoList 并通过 map 渲染到页面上,同时监听表单提交事件并在添加 TodoItem 后使用 refetch 更新页面。

总结

GraphQL 是一种构建灵活、高效、易用的 API 的方法,在前端和后端开发中有很大的应用前景。本文详细介绍了 GraphQL 服务端的设计和实现方法,并通过示例代码演示了其具体应用,希望对读者有所启发。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6517e04a95b1f8cacd007c1d

纠错
反馈