如何优雅地从 REST 迁移到 GraphQL

阅读时长 7 分钟读完

REST(Representational State Transfer)是一种常用的网络架构,它在 Web 开发中被广泛使用。但是,它存在一些缺点,如灵活性较差、无法实现精细化的数据查询等。GraphQL 是一种新兴的数据查询语言,它可以优雅地解决 REST 存在的问题。在本文中,我们将详细探讨如何优雅地从 REST 迁移到 GraphQL。

REST 的缺陷

  1. 灵活性差:REST 要求前后端在接口设计上提前协商好,否则后期修改会比较困难,特别是当产品需求变化时,需要在前后端协商接口的改动,会造成沟通上的瓶颈和耗时。
  2. 无法实现精细化的数据查询:当需要查询某个对象的部分属性时,REST 只能返回整个对象,造成不必要的数据传输和解析开销。
  3. 频繁请求:当前端需要不同的资源时,需要通过不同的 REST 接口进行请求,造成频繁的请求和响应,增加了网络开销和客户端的负担。

GraphQL 的优点

  1. 灵活性强:GraphQL 的接口设计是基于 GraphQL Schema 的,后端只需定义好 Schema,前端就可以根据自己的需要进行查询,不必再和后端协商接口的改动,大大提高了开发效率。
  2. 可以实现精细化的数据查询:GraphQL 可以通过查询参数实现精确关注的数据,节省了带宽和解析消耗,提高了效率。
  3. 单次请求:通过 GraphQL,前端只需要发起一次请求,就可以获取到需要的资源。只需通过查询参数实现资源的筛选、排序、分页等操作,在一次网络请求中完成所有的操作,大大减少了请求次数。

迁移步骤

步骤一:确定需要转换的 REST API

首先,我们需要确定需要转换的 REST API,可以从各个方面来选择,如性能瓶颈、频繁的重复请求、前端需要时常合并多个请求处理等。

步骤二:设计 GraphQL Schema

根据 REST API,设计 GraphQL Schema,包括 Query、Mutation、Type 等,确保 GraphQL Schema 能够满足前端查询的需求,同时也要确保 GraphQL Schema 具有一定的可扩展性和可维护性。

步骤三:编写 GraphQL 服务端

编写 GraphQL 服务端,将 REST API 数据转化为 GraphQL API 数据,在数据获取的逻辑中,需要注意利用 data loader 来避免 N+1 查询问题,提高查询效率。

步骤四:修改前端代码

修改前端代码,将原有的 REST API 请求替换为 GraphQL API 请求。前端需要自上而下地对原有的 REST API 调用进行修改,以保证不影响现有的业务功能,同时也要善于发现和利用 GraphQL 的优势,如代码复用性和可扩展性等等。

实例

接下来,我们以一个实例来展示从 REST 迁移到 GraphQL 的过程。

REST API 示例

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

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

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

GraphQL Schema 示例

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

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

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

GraphQL 服务端实例

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

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

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

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

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

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

前端代码示例

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

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

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

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

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

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

总结

通过本文的介绍,我们了解了 REST 的缺点以及 GraphQL 的优点,以及要优雅地从 REST 迁移到 GraphQL 需要进行的步骤。在实际开发过程中,我们需要根据实际情况来选择使用 REST 还是 GraphQL,以达到最佳的开发效率和用户体验。

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

纠错
反馈