GraphQL簡(jiǎn)明教程（graphql 教程）
GraphSQL是為了解決REST API存在的問(wèn)題而提出的一種新的查詢語(yǔ)言。GraphQL將數(shù)據(jù)對(duì)象關(guān)系映射到一個(gè)圖（Graph），并設(shè)計(jì)了一種查詢語(yǔ)言（Query Language）來(lái)遍歷圖中關(guān)系 —— 這也是GraphQL名稱的來(lái)源。本教程將介紹GraphQL規(guī)范的基本內(nèi)容并使用nodejs實(shí)現(xiàn)一個(gè)簡(jiǎn)單但完整的GraphQL API服務(wù)。
類似于我們熟悉的SQL（Strutural Query Language），GraphSQL也只是規(guī)范，你可以使用任何語(yǔ)言來(lái)實(shí)現(xiàn)GraphQL規(guī)范。目前已經(jīng)有了采用各種主流編程語(yǔ)言的實(shí)現(xiàn)，不過(guò)在本文中，我們將使用官方提供的JavaScript版本的GraphQL參考實(shí)現(xiàn)代碼。
如果希望快速掌握區(qū)塊鏈應(yīng)用的開(kāi)發(fā)，推薦匯智網(wǎng)的區(qū)塊鏈應(yīng)用開(kāi)發(fā)系列教程， 內(nèi)容涵蓋比特幣、以太坊、eos、超級(jí)賬本fabric和tendermint等多種區(qū)塊鏈，以及 java、go、nodejs、python、php、c#、dart等多種開(kāi)發(fā)語(yǔ)言。
1、GraphQL的基礎(chǔ)架構(gòu)
同樣類似于SQL，在GraphQL規(guī)范中約定了兩個(gè)組件：服務(wù)器和客戶端。
服務(wù)器負(fù)責(zé)處理查詢請(qǐng)求，解析查詢并使用指定的格式提取數(shù)據(jù)，然后通常以JSON 格式返回響應(yīng)。
應(yīng)用程序可以使用客戶端實(shí)現(xiàn)與GraphQL的通信，雖然也可以直接向GraphQL服務(wù)器 的訪問(wèn)端結(jié)點(diǎn)發(fā)送一個(gè)HTTP POST請(qǐng)求，但是GraphQL客戶端提供了更多的功能。
構(gòu)建一個(gè)Graph API會(huì)比構(gòu)建一個(gè)REST API的工作量大，但是在速度和可用性方面的提升可以彌補(bǔ)它的復(fù)雜性。
2、初識(shí)GraphQL
現(xiàn)在我們的小目標(biāo)是發(fā)送一個(gè)GraphQL查詢請(qǐng)求，然后獲取一個(gè)響應(yīng)，以此來(lái)初步了解GraphQL。
記住，GraphQL是一種自創(chuàng)一派的查詢語(yǔ)言，它不難學(xué)，而且大多數(shù)情況下查詢的寫(xiě)法很合直覺(jué)，容易理解。
現(xiàn)在先讓我們假設(shè)有一個(gè)航班和乘客信息數(shù)據(jù)庫(kù)。
在GraphQL中，我們可能這樣來(lái)查詢一個(gè)航班：
{
flight(id: “1234”) {
origin
destination
}
}
這個(gè)GraphQL查詢語(yǔ)句的意思是：查詢航班（flight）1234的出發(fā)地（origin）和目的地（destination）。
上述查詢的響應(yīng)如下：
{
“data”: {
“flight”: {
“origin”: “DFW”,
“destination”: “MKE”
}
}
}
你看，雖然航班信息可能包含很多字段，但是由于我們?cè)诓樵冋Z(yǔ)句中指定了要返回的字段，所以服務(wù)器精準(zhǔn)的只返回這一部分?jǐn)?shù)據(jù)，不多也不少。
這有點(diǎn)像你在SQL查詢時(shí)指定返回字段的感覺(jué)，不過(guò)GraphQL比這個(gè)還要強(qiáng)。假設(shè)接下來(lái)要查詢航班1234的出發(fā)地、目的地以及所有乘客的姓名，可以這樣寫(xiě)查詢語(yǔ)句：
{
flight(id: “1234”) {
origin
destination
passengers {
name
}
}
}
在這個(gè)查詢中，GraphQL就需要考慮航班數(shù)據(jù)、乘客數(shù)據(jù)以及這兩者的關(guān)系了。
響應(yīng)結(jié)果如下：
{
“data”: {
“flight”: {
“origin”: “DFW”,
“destination”: “MKE”,
“passengers”: [
{
“name”: “Luke Skywalker”
},
{
“name”: “Han Solo”
},
{
“name”: “R2-D2”
}
]
}
}
}
COOOOOOOOOOOOOOOOOOOOOOOL！我們只進(jìn)行了一次API調(diào)用就同時(shí)獲取了航班的起止地點(diǎn)以及全部乘客的名字！
由于GraphQL將數(shù)據(jù)關(guān)系視為圖，因此我們可以從任意方向進(jìn)行遍歷，例如查詢乘客Luke Skywalker的護(hù)照號(hào)以及所乘航班的編號(hào)、日期、出發(fā)地和目的地：
{
person(name: “Luke Skywalker”) {
passport_number
flights {
id
date
origin
destination
}
}
這個(gè)查詢的返回結(jié)果看起來(lái)是這樣：
{
“data”: {
“person”: {
“passport_number”: 78120935,
“flights”: [
{
“id”: “1234”,
“date”: “2019-05-24”,
“origin”: “DFW”,
“destination”: “MKE”
},
{
“id”: “2621”,
“date”: “2019-07-05”,
“origin”: “MKE”,
“destination”: “DFW”
}
]
}
}
}
3、實(shí)現(xiàn)GraphQL API
前面我們了解了GraphQL的查詢與響應(yīng)交互。現(xiàn)在我們了解如何實(shí)現(xiàn)GraphQL Server。下面列出了接下來(lái)要做的工作：
選擇一個(gè)實(shí)現(xiàn)GraphQL Server的開(kāi)發(fā)框架，我們選擇express
定義數(shù)據(jù)架構(gòu)，以免GraphQL知道如何路由收到的查詢請(qǐng)求
創(chuàng)建用于處理請(qǐng)求并返回響應(yīng)結(jié)果的解析函數(shù)
構(gòu)建訪問(wèn)端結(jié)點(diǎn)
編寫(xiě)客戶端查詢進(jìn)行測(cè)試
然后，你就可以在客戶端應(yīng)用中使用GraphQL的強(qiáng)大查詢能力了，不過(guò)在本教程中我們不會(huì)涉及如何在你的應(yīng)用中嵌入GraphQL查詢能力。另外，在現(xiàn)實(shí)應(yīng)用中，絕大多數(shù)GraphQL的應(yīng)用都會(huì)涉及到數(shù)據(jù)庫(kù)，不過(guò)在這個(gè)教程中我們也不會(huì)涉及數(shù)據(jù)庫(kù)的操作。
3.1 實(shí)現(xiàn)GraphQL服務(wù)器
首先，確保你已經(jīng)安裝了nodejs和npm。
接下來(lái)讓我們創(chuàng)建一個(gè)Express服務(wù)器。先初始化：
$ npm initThis utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.See `npm help json` for definitive documentation on these fields
and exactly what they do.Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.Press ^C at any time to quit.
package name: (graphql-medium)
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
About to write to /home/bennett/Repos/graphql-medium/package.json:{
“name”: “graphql-medium”,
“version”: “1.0.0”,
“description”: “”,
“main”: “index.js”,
“scripts”: {
“test”: “echo “Error: no test specified” && exit 1″
},
“author”: “”,
“license”: “ISC”
}Is this OK? (yes)
你可以一路回車下來(lái)，以后還有機(jī)會(huì)修改生成的package.json。
接下來(lái)，讓我們安裝Express、GraphQL和Express-GraphQL庫(kù)：
$ npm install express express-graphql graphqlnpm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN graphql-medium@1.0.0 No description
npm WARN graphql-medium@1.0.0 No repository field. express-graphql@0.8.0
graphql@14.3.1
express@4.17.0
added 53 packages from 38 contributors and audited 151 packages in 6.169s
found 0 vulnerabilities
現(xiàn)在，創(chuàng)建文件index.js，實(shí)現(xiàn)一個(gè)基本的Express Server：
// index.js
const express = require(‘express’);
const app = express();
app.get(‘/’, function(req, res) {
res.send(‘Express is working!’)
});
app.listen(4000, function() {
console.log(‘Listening on port 4000’)
});
試著運(yùn)行命令node index.js，你應(yīng)當(dāng)會(huì)看到如下提示信息：
Listening on port 4000
使用瀏覽器訪問(wèn)http://localhost:4000/，就可以看到如下內(nèi)容：
Express is working!”
3.2 定義數(shù)據(jù)架構(gòu)
首先，我們引入必要的模塊：
const graphqlHTTP = require(‘express-graphql’);
const { buildSchema } = require(‘graphql’);
接下來(lái)讓我們先定義一個(gè)hello world數(shù)據(jù)架構(gòu)來(lái)讓代碼跑起來(lái)。
let schema = buildSchema(`
type Query {
hello: String
}
`);
這個(gè)簡(jiǎn)單的數(shù)據(jù)架構(gòu)的作用，就是告訴GraphQL當(dāng)有查詢hello時(shí)，我們要返回一個(gè)字符串。
3.3 解析查詢語(yǔ)句
當(dāng)有人提交對(duì)hello的查詢時(shí)，我們將要返回一個(gè)字符串，這是我們?cè)谏厦娴臄?shù)據(jù)架構(gòu)中定義的。
現(xiàn)在我們需要告訴GraphQL應(yīng)當(dāng)返回哪個(gè)字符串 —— 這就是解析器的作用 ——找出要返回的數(shù)據(jù)。
在這個(gè)示例中，解析器非常簡(jiǎn)單，我們直接返回一個(gè)字符串常量：
return ‘Hello world!’;
1
但是我們需要把上述語(yǔ)言封裝到一個(gè)函數(shù)中，任何時(shí)候有人查詢hello，只需要調(diào)用這個(gè)函數(shù)就可以了：
function() {
return ‘Hello world!’;
}
目前而言，hello是我們實(shí)現(xiàn)的唯一的查詢類型。在將來(lái)我們也可以包含其他的訪問(wèn)端結(jié)點(diǎn)?，F(xiàn)在先將hello和我們的解析器函數(shù)關(guān)聯(lián)起來(lái)：
let root = {
hello: function() {
return ‘Hello world!’;
},
}
3.4 設(shè)置訪問(wèn)端結(jié)點(diǎn)
你可能會(huì)注意到，我們?cè)谇懊鎸?dǎo)入了graphqlHTTP，但并沒(méi)有使用它?，F(xiàn)在是時(shí)候了，我們將創(chuàng)建一個(gè)新的路由來(lái)提供GraphQL API服務(wù)：
app.use(‘/graphql’, graphqlHTTP({
schema: schema,
rootValue: root,
graphiql: true,
}));
schema和root都指向我們前面定義的變量。graphiql是一個(gè)有用的可視化工具，它與GraphSQL一起安裝，
我們接下來(lái)將用它進(jìn)行GraphQL API的測(cè)試。
3.5 查詢測(cè)試
現(xiàn)在可以啟動(dòng)GraphQL服務(wù)器，進(jìn)行測(cè)試了！
啟動(dòng)應(yīng)用：node index.js
用瀏覽器訪問(wèn)http://localhost:4000/graphql
應(yīng)該看到graphiql的界面：
現(xiàn)在就可以用這個(gè)界面來(lái)測(cè)試我們的GraphQL API了！
{
hello
}
點(diǎn)擊提交按鈕，將會(huì)看到：
{
“data”: {
“hello”: “Hello world!”
}
}
IT’S WORKING!!!
原文鏈接：從SQL到GraphQL – 匯智網(wǎng)
