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

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


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    2 个月前