关于后端:一文带你了解-GraphQL-和-REST-的区别和使用场景

一、概述

在创立 Web 服务来反对咱们的应用程序时，咱们能够抉择应用 REST 或者 GraphQL 作为通信模式。尽管两者都最有可能在 HTTP 上应用 JSON，但它们有不同的长处和毛病。

在本教程中，咱们将比拟 GraphQL 和 REST。咱们将创立一个产品数据库示例，并比拟两种解决方案在执行雷同的客户端操作时有何不同。

二、示例服务

咱们的示例服务将容许咱们：

在草稿状态下创立产品
更新产品详情
获取产品列表
获取单个产品的详细信息及其订单

让咱们从应用 REST 创立应用程序开始。

三、REST

REST (Representational State Transfer) 是分布式超媒体零碎的一种架构格调。 REST 中的次要数据元素称为 Resource。在此示例中，资源是 "product"。

3.1 创立产品

要创立产品，咱们将在 API 上应用 POST 办法：

curl --request POST 'http://localhost:8081/product' \--header 'Content-Type: application/json' \--data '{  "name": "Watch",  "description": "Special Swiss Watch",  "status": "Draft",  "currency": "USD",  "price": null,  "imageUrls": null,  "videoUrls": null,  "stock": null,  "averageRating": null}'

调用上述申请后零碎将创立一个新产品。

3.2 更新产品

在 REST 中，咱们通常应用 PUT 办法更新产品：

curl --request PUT 'http://localhost:8081/product/{product-id}' \--header 'Content-Type: application/json' \--data '{    "name": "Watch",    "description": "Special Swiss Watch",    "status": "Draft",    "currency": "USD",    "price": 1200.0,    "imageUrls": [        "https://graphqlvsrest.com/imageurl/product-id"    ],    "videoUrls": [        "https://graphqlvsrest.com/videourl/product-id"    ],    "stock": 10,    "averageRating": 0.0}'

因而，{product-id} 对象将会更新。

3.3 获取产品列表

列出产品通常是 GET 操作，咱们能够应用查问字符串来指定分页：

curl -X GET https://graphqlvsrest.com/product?size=10&page=0

第一个响应对象是：

{  "id": 1,  "name": "T-Shirt",  "description": "Special beach T-Shirt",  "status": Published,  "currency": "USD",  "price": 30.0,  "imageUrls": ["https://graphqlvsrest.com/imageurl/1"],   "videoUrls": ["https://graphqlvsrest.com/videourl/1"],   "stock": 10,   "averageRating": 3.5 }

3.4 通过订单获取单个产品

要获取产品及其订单，咱们通常心愿应用之前的 API 获取产品列表，而后调用 order 资源以查找相干订单：

curl -X GET https://graphqlvsrest.com/order?product-id=1

第一个响应对象是：

{  "id": 1,  "productId": 1,  "customerId": "de68a771-2fcc-4e6b-a05d-e30a8dd0d756",  "status": "Delivered",  "address": "43-F 12th Street",  "creationDate": "Mon Jan 17 01:00:18 GST 2022"}

当咱们通过 product-id 查问订单时，将 id 作为查问参数提供给 GET 操作是有意义的。然而，咱们应该留神，除了原始操作以获取所有产品之外，咱们还须要对咱们感兴趣的每个产品执行一次此操作。

四、GraphQL

GraphQL 是一种用于 API 的查询语言，它带有一个运行时，用于应用现有数据服务来实现这些查问。

GraphQL 的构建块是查问和渐变。查问负责获取数据，而渐变用于创立和更新。

查问和批改都定义了一个 Schema。Schema 定义了可能的客户端申请和响应。

让咱们应用 GraphQL Server 从新实现咱们的示例。

4.1 创立产品

让咱们应用一个名为 saveProduct 的批改：

curl --request POST 'http://localhost:8081/graphql' \--header 'Content-Type: application/json' \--data \'{  "query": "mutation {saveProduct (    product: {      name: \"Bed-Side Lamp\",      price: 24.0,      status: \"Draft\",      currency: \"USD\"    }){ id name currency price status}  }"}'

在这个 saveProduct 函数中，圆括号内的所有内容都是输出类型Schema。前面的大括号则形容了服务器要返回的字段。

当咱们运行批改时，咱们预期是服务端返回一个带有所选字段的响应值：

{  "data": {    "saveProduct": {      "id": "12",      "name": "Bed-Side Lamp",      "currency": "USD",      "price": 24.0,      "status": "Draft"    }  }}

这个申请与咱们应用 REST 版本收回的 POST 申请十分类似，只管咱们当初能够自定义响应。

4.2 更新产品

同样，咱们能够应用另一个名为 updateProduct 的办法来批改产品：

curl --request POST 'http://localhost:8081/graphql' \--header 'Content-Type: application/json' \--data \'{"query": "mutation {updateProduct(    id: 11    product: {      price: 14.0,      status: \"Publish\"    }){ id name currency price status }    }","variables":{}}'

咱们在响应中收到抉择的字段：

{  "data": {    "updateProduct": {      "id": "12",      "name": "Bed-Side Lamp",      "currency": "USD",      "price": 14.0,      "status": "Published"    }  }}

正如咱们所见，GraphQL 提供了响应格局的灵活性。

4.3 获取产品列表

要从服务器获取数据，咱们将应用查问：

curl --request POST 'http://localhost:8081/graphql' \--header 'Content-Type: application/json' \--data \'{    "query": "query {products(size:10,page:0){id name status}}"}'

在这里，咱们还形容了咱们心愿看到的后果页面：

{  "data": {    "products": [      {        "id": "1",        "name": "T-Shirt",        "status": "Published"      },      ...    ]  }}

4.4 通过订单获取单个产品

应用 GraphQL，咱们能够要求 GraphQL 服务器将产品和订单连贯在一起：

curl --request POST 'http://localhost:8081/graphql' \--header 'Content-Type: application/json' \--data \'{    "query": "query {product(id:1){ id name orders{customerId address status creationDate}}}"}'

在这个查问中，咱们获取 id 等于 1 的产品及其订单。这使咱们可能在单个操作中发出请求，让咱们查看响应：

{  "data": {    "product": {      "id": "1",      "name": "T-Shirt",      "orders": [        {          "customerId": "de68a771-2fcc-4e6b-a05d-e30a8dd0d756",          "status": "Delivered",          "address": "43-F 12th Street",          "creationDate": "Mon Jan 17 01:00:18 GST 2022"        },         ...      ]    }  }}

正如咱们在此处看到的，响应蕴含产品的详细信息及其各自的订单。

为了应用 REST 实现这一点，咱们须要发送几个申请——第一个申请获取产品，第二个申请获取相应的订单。

五、比拟

这些示例展现了 GraphQL 如何缩小客户端和服务器之间的流量，并容许客户端为响应提供一些格式化规定。

值得注意的是，这些 API 背地的数据源可能依然须要执行雷同的操作来批改或获取数据，但如果应用 GraphQL，客户端和服务器之间的丰盛接口会让客户端做的工作会更少。

让咱们进一步比拟这两种办法。

5.1 灵便和动静

GraphQL 容许灵便和动静的查问：

客户端应用程序只能申请必须得字段
别名可用于自定义字段的名称
客户端能够应用查问来治理后果程序
客户端能够更好地与 API 中的任何批改拆散，因为响应对象的构造没有繁多版本能够遵循

5.2 操作破费更少的资源

每个服务器申请的往返工夫和无效负载大小都和价格相干。

在 REST 中，咱们最终可能会发送多个申请以实现所需的性能。这些多个申请将是一项低廉的操作。此外，响应负载可能蕴含客户端应用程序可能不须要的不必要数据。

GraphQL 偏向于防止代价过高的操作。 咱们通常能够应用 GraphQL 在单个申请中获取咱们须要的所有数据。

5.3 什么时候要应用 REST？

先说论断：GraphQL 不能代替 REST。 两者甚至能够在同一个应用程序中共存。应用 GraphQL 的服务复杂性会减少可能是值得的，也取决于具体场景。

在以下状况下，咱们应用 REST 可能更适合：

咱们的应用程序天然是资源驱动的，其中操作与各个资源实体十分间接且齐全相关联
须要 Web 缓存
咱们须要文件上传

六、论断

在本文中，咱们应用一个理论的示例比拟了 REST 和 GraphQL。

咱们看到了咱们如何依照常规应用每种办法。最初，咱们探讨了这两种办法相互之间的劣势。咱们的论断是两者不能互相代替。

本文亦通过 NoOne's Blog 发表，更多分享请关注公众号 NoOneNoOne