使用 GraphQL 构建高效的 RESTful API

随着前端技术的不断发展以及移动设备的广泛应用,RESTful API 已经成为了一个不可或缺的组成部分。然而,RESTful API 的缺陷也逐渐显现出来:请求和响应的数据结构固定,需要进行多次请求才能得到所需的数据,数据冗余等。而 GraphQL 则可以有效地解决这些问题。

什么是 GraphQL

GraphQL 是一个由 Facebook 开源的查询语言和运行时系统,旨在提供更加高效、强大、灵活的 API。它可以替代 RESTful API,使得客户端可以按照自己的需求从服务器获取所需数据,而不必受到服务器的限制。

GraphQL 有以下几个特点:

  • 它是一种强类型的查询语言,即客户端可以明确指定需要返回哪些数据。
  • 它是一个单入口的 API,即客户端只需要发送一个查询请求便可以获取所有需要的数据。
  • 它是可扩展的,即客户端可以随时根据需要添加需要返回的字段。
  • 它是自文档化的,即客户端可以根据 GraphQL 的 schema 查看返回数据的结构以及当前可用的 API。

GraphQL 和 RESTful API 的对比

传统的 RESTful API 使用 HTTP 请求来执行 CRUD 操作(创建、读取、更新、删除),但仅限于如下的 HTTP 方法、状态码和数据格式:

  • HTTP 方法:GET、POST、PUT、PATCH、DELETE。
  • HTTP 状态码:200、201、204、400、401、403、404、422、500。
  • 数据格式:JSON、XML、HTML、Text 等。

GraphQL 则更加灵活,它可以使用单一的端点执行所有操作,而且响应格式可以随需求动态变化。两者之间的主要区别如下:

  • 数据结构:RESTful 可能会因为数据结构不够灵活而产生多个请求或重复数据,GraphQL 可以一请求内获取所需数据的子集。
  • 版本管理:如果要添加或更改 API 端点,则需要创建新版本的 RESTful API。GraphQL 的单入口使得修改和添加新功能变得非常容易。
  • 接口文档:RESTful API 需要提供接口文档,以便客户端开发人员了解数据格式。GraphQL 的 schema 充当了接口文档,使得开发人员可以了解 API 支持哪些操作。
  • 性能:GraphQL 可以避免不必要的网络请求,这也是许多公司选择它的原因之一。

GraphQL 的使用

虽然 GraphQL 具有许多优点,但使用它也有一定的门槛。下面是使用 GraphQL 的一般步骤:

1. 编写 GraphQL schema

GraphQL 的 schema 定义了服务器上可用的操作和数据结构。它是一种数据类型语言,类似于 JavaScript。下面是 schema 的一些示例:

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

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

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

schema 定义了 Query 类型,它包含 planet 和 starship 两个字段。planet 和 starship 两个字段定义了它们自己独立的类型,它们的属性及其类型也都被定义在了 schema 中。

2. 搭建 GraphQL 服务器

可以使用现成的 GraphQL 服务器,比如 Apollo Server。也可以在自己的服务器上运行官方提供的 graphql-js 库。下面是一个搭建 Apollo Server 的示例:

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

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

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

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

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

3. 发送查询请求

客户端可以使用任何支持 GraphQL 的客户端库来发送请求。下面是使用 Apollo Client 发送查询请求的示例:

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

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

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

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

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

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

这里我们定义了两个查询语句:planetQuery 和 starshipQuery。由于我们的 schema 定义了类型和属性,客户端查询语句中的属性也必须包含在对应的类型中。

4. 响应结果

GraphQL 的响应结果非常灵活,客户端可以自由选择返回所需的字段。例如,客户端只需要 planet 的 name 属性,可以使用以下查询语句:

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

总结

尽管 GraphQL 需要学习和使用一定的门槛,但它可以为我们的应用程序提供更好的灵活性、效率和维护性。特别是在大量数据的情况下,使用 GraphQL 避免了不必要的重复请求,使得网络通信更加高效。如果您正在寻求一种更好的 API 解决方案,GraphQL 绝对值得一试。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/64ca17e35ad90b6d04198914


猜你喜欢

  • 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 个月前

相关推荐

    暂无文章