GraphQL初體驗，Node.js構建GraphQL API指南

作者：張張 2020-09-28 06:57:39

在過去的幾年中，GraphQL[1]已經成為一種非常流行的API規范，該規范專注于使客戶端(無論客戶端是前端還是第三方)的數據獲取更加容易。

目錄：

為什么選擇GraphQL?
定義一個GraphQL schema
設置解析器
運行服務器
性能考量
- 緩存
- 授權
Schema最佳實踐
GraphQL什么時候不合適?
了解更多

在傳統的基于REST的API方法中，客戶端發出請求，而服務器決定響應：

curl https://api.heroku.space/users/1 
 
{ 
  "id": 1, 
  "name": "Luke", 
  "email": "luke@heroku.space", 
  "addresses": [ 
    { 
    "street": "1234 Rodeo Drive", 
    "city": "Los Angeles", 
    "country": "USA" 
    } 
  ] 
}

但是，在GraphQL中，客戶端可以精確地確定其從服務器獲取的數據。例如，客戶端可能只需要用戶名和電子郵件，而不需要任何地址信息：

curl -X POST https://api.heroku.space/graphql -d ' 
query { 
  user(id: 1) { 
    name 
    email 
  } 
} 
 
 
{ 
  "data": 
    { 
    "name": "Luke", 
    "email": "luke@heroku.space" 
    } 
}

通過這種新的模式，客戶可以通過縮減響應來滿足他們的需求，從而向服務器進行更高效的查詢。對于單頁應用(SPA)或其他前端重度客戶端應用，可以通過減少有效載荷大小來加快渲染時間。但是，與任何框架或語言一樣，GraphQL也需要權衡取舍。在本文中，我們將探討使用GraphQL作為API的查詢語言的利弊，以及如何開始構建實現。

為什么選擇GraphQL?

與任何技術決策一樣，了解GraphQL為你的項目提供了哪些優勢是很重要的，而不是簡單地因為它是一個流行詞而選擇它。

考慮一個使用API連接到遠程數據庫的SaaS應用程序。你想要呈現用戶的個人資料頁面，你可能需要進行一次API GET 調用，以獲取有關用戶的信息，例如用戶名或電子郵件。然后，你可能需要進行另一個API調用以獲取有關地址的信息，該信息存儲在另一個表中。隨著應用程序的發展，由于其構建方式的原因，你可能需要繼續對不同位置進行更多的API調用。雖然每一個API調用都可以異步完成，但你也必須處理它們的響應，無論是錯誤、網絡超時，甚至暫停頁面渲染，直到收到所有數據。如上所述，這些響應的有效載荷可能超過了渲染你當前頁面的需要，而且每個API調用都有網絡延遲，總的延遲加起來可能很可觀。

使用GraphQL，你無需進行多個API調用(例如 GET /user/:id 和 GET /user/:id/addresses )，而是進行一次API調用并將查詢提交到單個端點：

query { 
  user(id: 1) { 
    name 
    email 
    addresses { 
    street 
    city 
    country 
    } 
  } 
}

然后，GraphQL僅提供一個端點來查詢所需的所有域邏輯。如果你的應用程序不斷增長，你會發現自己在你的架構中添加了更多的數據存儲——PostgreSQL可能是存儲用戶信息的好地方，而Redis可能是存儲其他種類信息的好地方——對GraphQL端點的一次調用將解決所有這些不同的位置，并以他們所請求的數據響應客戶端。

如果你不確定應用程序的需求以及將來如何存儲數據，則GraphQL在這里也很有用。要修改查詢，你只需添加所需字段的名稱：

addresses { 
      street 
+     apartmentNumber   # new information 
      city 
      country 
    }

這極大地簡化了隨著時間的推移而發展你的應用程序的過程。

定義一個GraphQL schema

有各種編程語言的GraphQL服務器實現，但在你開始之前，你需要識別你的業務域中的對象，就像任何API一樣。就像REST API可能會使用JSON模式一樣，GraphQL使用SDL或Schema定義語言來定義它的模式，這是一種描述GraphQL API可用的所有對象和字段的冪等方式。SDL條目的一般格式如下：

type $OBJECT_TYPE { 
  $FIELD_NAME($ARGUMENTS): $FIELD_TYPE 
}

讓我們以前面的例子為基礎，定義一下user和address的條目是什么樣子的。

type User { 
  name:     String 
  email:    String 
  addresses:   [Address] 
} 
 
type Address { 
  street:   String 
  city:     String 
  country:  String 
}

user 定義了兩個 String 字段，分別是 name 和 email ，它還包括一個稱為 addresses 的字段，它是 Addresses 對象的數組。Addresses 還定義了它自己的幾個字段。(順便說一下，GraphQL模式不僅有對象，字段和標量類型，還有更多，你也可以合并接口，聯合和參數，以構建更復雜的模型，但本文中不會介紹。)

我們還需要定義一個類型，這是我們GraphQL API的入口點。你還記得，前面我們說過，GraphQL查詢是這樣的：

query { 
  user(id: 1) { 
    name 
    email 
  } 
}

該 query 字段屬于一種特殊的保留類型，稱為 Query ，這指定了獲取對象的主要入口點。(還有用于修改對象的 Mutation 類型。)在這里，我們定義了一個 user 字段，該字段返回一個 User 對象，因此我們的架構也需要定義此字段：

type Query { 
  user(id: Int!): User 
} 
 
type User { ... } 
type Address { ... }

字段中的參數是逗號分隔的列表，格式為 $NAME: $TYPE。! 是GraphQL表示該參數是必需的方式，省略表示它是可選的。

根據你選擇的語言，將此模式合并到服務器中的過程會有所不同，但通常，將信息用作字符串就足夠了。Node.js有 graphql[2] 包來準備GraphQL模式，但我們將使用 graphql-tools[3] 包來代替，因為它提供了一些更多的好處。讓我們導入該軟件包并閱讀我們的類型定義，以為將來的開發做準備：

const fs = require('fs') 
const { makeExecutableSchema } = require("graphql-tools"); 
 
let typeDefs = fs.readFileSync("schema.graphql", { 
  encoding: "utf8", 
  flag: "r", 
});

設置解析器

schema設置了構建查詢的方式，但建立schema來定義數據模型只是GraphQL規范的一部分。另一部分涉及實際獲取數據，這是通過使用解析器完成的，解析器是一個返回字段基礎值的函數。

讓我們看一下如何在Node.js中實現解析器。我們的目的是圍繞著解析器如何與模式一起操作來鞏固概念，所以我們不會圍繞著如何設置數據存儲來做太詳細的介紹。在“現實世界”中，我們可能會使用諸如knex[4]之類的東西建立數據庫連接。現在，讓我們設置一些虛擬數據：

const users = { 
  1: { 
    name: "Luke", 
    email: "luke@heroku.space", 
    addresses: [ 
    { 
      street: "1234 Rodeo Drive", 
      city: "Los Angeles", 
      country: "USA", 
    }, 
    ], 
  }, 
  2: { 
    name: "Jane", 
    email: "jane@heroku.space", 
    addresses: [ 
    { 
      street: "1234 Lincoln Place", 
      city: "Brooklyn", 
      country: "USA", 
    }, 
    ], 
  }, 
};

Node.js中的GraphQL解析器相當于一個Object，key是要檢索的字段名，value是返回數據的函數。讓我們從初始 user 按id查找的一個簡單示例開始:

const resolvers = { 
  Query: { 
    user: function (parent, { id }) { 
      // 用戶查找邏輯 
    }, 
  }, 
}

這個解析器需要兩個參數：一個代表父的對象(在最初的根查詢中，這個對象通常是未使用的)，一個包含傳遞給你的字段的參數的JSON對象。并非每個字段都具有參數，但是在這種情況下，我們將擁有參數，因為我們需要通過用戶ID來檢索其用戶。該函數的其余部分很簡單：

const resolvers = { 
  Query: { 
    user: function (_, { id }) { 
      return users[id]; 
    }, 
  } 
}

你會注意到，我們沒有明確定義 User 或 Addresses 的解析器，graphql-tools 包足夠智能，可以自動為我們映射這些。如果我們選擇的話，我們可以覆蓋這些，但是現在我們已經定義了我們的類型定義和解析器，我們可以建立我們完整的模式：

const schema = makeExecutableSchema({ typeDefs, resolvers });

運行服務器

最后，讓我們來運行這個demo吧!因為我們使用的是Express，所以我們可以使用 express-graphql[5] 包來暴露我們的模式作為端點。該程序包需要兩個參數：schema和根value，它有一個可選參數 graphiql，我們將稍后討論。

使用GraphQL中間件在你喜歡的端口上設置Express服務器，如下所示：

const express = require("express"); 
const express_graphql = require("express-graphql"); 
 
const app = express(); 
app.use( 
  "/graphql", 
  express_graphql({ 
    schema: schema, 
    graphiql: true, 
  }) 
); 
app.listen(5000, () => console.log("Express is now live at localhost:5000"));

將瀏覽器導航到 http://localhost:5000/graphql，你應該會看到一種IDE界面。在左側窗格中，你可以輸入所需的任何有效GraphQL查詢，而在右側你將獲得結果。

這就是 graphiql: true 所提供的：一種方便的方式來測試你的查詢，你可能不想在生產環境中公開它，但是它使測試變得容易得多。

嘗試輸入上面展示的查詢：

query { 
  user(id: 1) { 
    name 
    email 
  } 
}

要探索GraphQL的類型化功能，請嘗試為ID參數傳遞一個字符串而不是一個整數。

# 這不起作用 
query { 
  user(id: "1") { 
    name 
    email 
  } 
}

你甚至可以嘗試請求不存在的字段：

# 這不起作用 
query { 
  user(id: 1) { 
    name 
    zodiac 
  } 
}

只需用schema表達幾行清晰的代碼，就可以在客戶機和服務器之間建立強類型的契約。這樣可以防止你的服務接收虛假數據，并向請求者清楚地表明錯誤。

性能考量

盡管GraphQL為你解決了很多問題，但它并不能解決構建API的所有固有問題。特別是緩存和授權這兩個方面，只是需要一些預案來防止性能問題。GraphQL規范并沒有為實現這兩種方法提供任何指導，這意味著構建它們的責任落在了你身上。

緩存

基于REST的API在緩存時不需要過度關注，因為它們可以構建在web的其他部分使用的現有HTTP頭策略之上。GraphQL不具有這些緩存機制，這會對重復請求造成不必要的處理負擔。考慮以下兩個查詢：

query { 
  user(id: 1) { 
    name 
  } 
} 
 
query { 
  user(id: 1) { 
    email 
  } 
}

在沒有某種緩存的情況下，只是為了檢索兩個不同的列，會導致兩個數據庫查詢來獲取ID為 1 的 User。實際上，由于GraphQL還允許使用別名，因此以下查詢有效，并且還執行兩次查找：

query { 
  one: user(id: 1) { 
    name 
  } 
  two: user(id: 2) { 
    name 
  } 
}

第二個示例暴露了如何批處理查詢的問題。為了快速高效，我們希望GraphQL以盡可能少的往返次數訪問相同的數據庫行。

dataloader[6]程序包旨在解決這兩個問題。給定一個ID數組，我們將一次性從數據庫中獲取所有這些ID;同樣，后續對同一ID的調用也將從緩存中獲取該項目。要使用 dataloader 來構建這個，我們需要兩樣東西。首先，我們需要一個函數來加載所有請求的對象。在我們的示例中，看起來像這樣：

const DataLoader = require('dataloader'); 
const batchGetUserById = async (ids) => { 
   // 在現實生活中，這將是數據庫調用 
  return ids.map(id => users[id]); 
}; 
// userLoader現在是我們的“批量加載功能” 
const userLoader = new DataLoader(batchGetUserById);

這樣可以解決批處理的問題。要加載數據并使用緩存，我們將使用對 load 方法的調用來替換之前的數據查找，并傳入我們的用戶ID：

const resolvers = { 
  Query: { 
    user: function (_, { id }) { 
      return userLoader.load(id); 
    }, 
  }, 
}

授權

對于GraphQL來說，授權是一個完全不同的問題。簡而言之，它是識別給定用戶是否有權查看某些數據的過程。我們可以想象一下這樣的場景：經過認證的用戶可以執行查詢來獲取自己的地址信息，但應該無法獲取其他用戶的地址。

為了解決這個問題，我們需要修改解析器函數。除了字段的參數外，解析器還可以訪問它的父節點，以及傳入的特殊上下文值，這些值可以提供有關當前已認證用戶的信息。因為我們知道地址是一個敏感字段，所以我們需要修改我們的代碼，使對用戶的調用不只是返回一個地址列表，而是實際調用一些業務邏輯來驗證請求：

const getAddresses = function(currUser, user) { 
  if (currUser.id == user.id) { 
    return user.addresses 
  } 
 
  return []; 
} 
 
const resolvers = { 
  Query: { 
    user: function (_, { id }) { 
      return users[id]; 
    }, 
  }, 
  User: { 
    addresses: function (parentObj, {}, context) { 
      return getAddresses(context.currUser, parentObj); 
    }, 
  }, 
};

同樣，我們不需要為每個 User 字段顯式定義一個解析程序，只需定義一個我們要修改的解析程序即可。

默認情況下，express-graphql 會將當前的HTTP請求作為上下文的值來傳遞，但在設置服務器時可以更改：

app.use( 
  "/graphql", 
  express_graphql({ 
    schema: schema, 
    graphiql: true, 
    context: { 
      currUser: user // 當前經過身份驗證的用戶 
    } 
  }) 
);

Schema最佳實踐

GraphQL規范中缺少的一個方面是缺乏對版本控制模式的指導。隨著應用程序的成長和變化，它們的API也會隨之變化，很可能需要刪除或修改GraphQL字段和對象。但這個缺點也是積極的：通過仔細設計你的GraphQL schema，你可以避免在更容易實現(也更容易破壞)的REST端點中明顯的陷阱，如命名的不一致和混亂的關系。

此外，你應該盡量將業務邏輯與解析器邏輯分開。你的業務邏輯應該是整個應用程序的單一事實來源。在解析器中執行驗證檢查是很有誘惑力的，但隨著模式的增長，這將成為一種難以維持的策略。

GraphQL什么時候不合適?

GraphQL不能像REST一樣精確地滿足HTTP通信的需求。例如，無論查詢成功與否，GraphQL僅指定一個狀態碼——200 OK。在這個響應中會返回一個特殊的錯誤鍵，供客戶端解析和識別出錯的地方，因此，錯誤處理可能會有些棘手。

同樣，GraphQL只是一個規范，它不會自動解決你的應用程序面臨的每個問題。性能問題不會消失，數據庫查詢不會變得更快，總的來說，你需要重新思考關于你的API的一切：授權、日志、監控、緩存。版本化你的GraphQL API也可能是一個挑戰，因為官方規范目前不支持處理中斷的變化，這是構建任何軟件不可避免的一部分。如果你有興趣探索GraphQL，你需要投入一些時間來學習如何將其與你的需求進行最佳整合。

本文轉載自微信公眾號「前端全棧開發者」，可以通過以下二維碼關注。轉載本文請聯系前端全棧開發者公眾號。

責任編輯：武曉燕來源：前端全棧開發者