基本概念
GraphQL
GraphQL 是一種用於 API 的查詢語言,由Facebook開發和開源,是使用基於型別系統來執行查詢的服務端執行時(型別系統由你的資料定義)。GraphQL並沒有和任何特定資料庫或者儲存引擎繫結,而是依靠你現有的程式碼和資料支撐。
背景介紹
相信看了上面的基本概念,大家都是和我一樣一臉萌萌噠。所以這裡就需要介紹一下其產生的背景和原因。
在我們目前的前後端開發過程中,大部分都是以http請求服務端介面的方式完成互動過程的。在這種場景下,每當需求變化,就需要修改或建立一個新的介面去滿足特定的需求。
舉個例子: 在一個商品詳情頁,當我們需要獲取商品詳情時,服務端會給前端一個介面,例如:
https://www.example.com/getInfoById?infoId=000000
當前端請求介面時,會返回給一個固定格式的資料,例如:
{
data:{
title:'商品的標題',
content:'商品的描述內容',
special:'商品特點',
price:'商品價格',
image:'商品的圖片'
}
}
複製程式碼
前端接收到資料後,進行各種相應的處理展示,最終將包含有商品標題,商品描述,商品特點,商品價格,商品圖片資訊的頁面展示給使用者。
一切看起來都很美好,直到有一天……
產品大搖大擺的走過來,輕描淡寫的說道:“能不能把商品的特點去掉,加一個商品的庫存,另外還需要再加一個賣家的模組進去。包含賣家的名稱和頭像,可以點進賣家的詳情頁,也不用太著急,午飯前上線就行。”
於是前後端坐在一起開始商量,前端弱弱的說:“能不能改一下你的介面,把產品不要的都去掉,產品需要的都加上”。
後端心裡說,你當我傻啊,於是一邊砸吧嘴一邊趕忙說道:“這樣改風險太大,好多資料都不在一個表,我不好查。這樣,詳情頁那個介面我就不改了,你不顯示不就完了嘛,萬一哪天產品那小子的小子再想起來加上,我們倆還得忙活。庫存再給你一個介面,賣家資訊再給你一個介面,完美,就這麼定了。”
前端還想再說什麼,可後端的背影已經隨著產品越走越遠。
就在前端絕望之時,霹靂一聲震天響,graphql閃亮登場。
在graphql模式下,假設我們的服務端部分已經部署完成,前端使用vue框架,那麼前端部分的請求就可以簡化為:
apollo: {
goods: {
query() {
return gql`{
goods(infoId:"${this.infoId}"){
title
content
price
image
}
}`
}
},
store: {
query() {
return gql`{
store(infoId:"${this.infoId}"){
store
}
}`
}
},
seller: {
query() {
return gql`{
seller(infoId:"${this.infoId}"){
name
age
}
}`
}
}
}
複製程式碼
可以看到graphql為我們定義了一種類似sql的查詢語言,而這種查詢語言是用於api的。和之前的資料請求處理不同,在這裡,我們只要定義好需要的資料,其他的不再關心,我們就可以按需索取需要的資料。這對於我們的開發提供了更大的自由與便利,只要資料支援,我們就可以擺脫對於服務端介面的依賴,提高生產效率,贏得自由,完成前端的逆襲。
前後端實踐
講完了故事,我們開始講一些實際的乾貨。 對於graphql,網上已經有很多實踐經驗,以下部分是在參考完成實踐經驗並自我實踐後給出的總結歸納。
服務端
服務端的技術選型,我們使用了eggjs框架,配合egg-graphqlegg-graphql外掛完成。
1.安裝依賴包
$ npm install --save egg-graphql
複製程式碼
2.開啟外掛
// config/plugin.js
exports.graphql = {
enable: true,
package: 'egg-graphql',
};
//開啟 cros 跨域訪問
exports.cors = {
enable: true,
package: 'egg-cors'
}
複製程式碼
3.配置graphql路由和跨域
//config/config.default.js
// graphql路由
config.graphql = {
router: '/graphql',
// 是否載入到 app 上,預設開啟
app: true,
// 是否載入到 agent 上,預設關閉
agent: false,
// 是否載入開發者工具 graphiql, 預設開啟。路由同 router 欄位。使用瀏覽器開啟該可見。
graphiql: true,
// graphQL 路由前的攔截器
onPreGraphQL: function*(ctx) {},
// 開發工具 graphiQL 路由前的攔截器,建議用於做許可權操作(如只提供開發者使用)
onPreGraphiQL: function*(ctx) {},
}
// cors跨域
config.cors = {
origin: '*',
allowMethods: 'GET,HEAD,PUT,POST,DELETE,PATCH,OPTIONS'
}
複製程式碼
4.開啟graphql中介軟體
//config/config.default.js
exports.middleware = [ 'graphql' ];
複製程式碼
專案配置告於段落。
5.編寫業務員程式碼
下面開始寫程式碼。 目錄結構如下:
├── app
│ ├── graphql //graphql 程式碼,所有和graphql相關的程式碼都在這裡,已經在前面做好了配置
│ │ └── common //通用型別定義,graphql有一套自己的系統型別,除此之外還可以自定義
│ │ | |── scalars //自定義型別定義
│ │ | | └── date.js // 日期型別實現
│ │ | └── resolver.js //合併所有全域性型別定義
│ │ | └── schema.graphql // schema 定義
│ │ └──goods // 商品詳情的graphql模型
│ │ └── connector.js //連線資料服務
│ │ └── resolver.js //型別實現,和goods中schema.graphql定義的模型相對應,是其具體的實現
│ │ └── schema.graphql //schema 定義,在這裡定義商品詳情資料物件
│ │ └──store // 庫存的graphql模型
│ │ └── connector.js //連線資料服務
│ │ └── resolver.js //型別實現
│ │ └── schema.graphql //schema 定義,在這裡定義商品詳情資料物件
│ │ └──seller // 賣家資訊的graphql模型
│ │ └── connector.js //連線資料服務
│ │ └── resolver.js //型別實現
│ │ └── schema.graphql //schema 定義,在這裡定義商品詳情資料物件
│ │ └──query // 所有的查詢都會經過這裡,這裡是一個總的入口
│ │ └── schema.graphql //schema 定義
│ ├── service
│ │ └── goods.js //商品詳情的具體實現
│ │ └── store.js //庫存的具體業務邏輯
│ │ └── seller.js //賣家資訊的具體業務邏輯
│ └── router.js
複製程式碼
app/graphql/query/schema.graphql是整個graphql查詢的總入口,所有需要查詢的物件都要在這裡定義。它的定義形式如下:
#定義查詢物件,在graphql裡的註釋使用#號
type Query {
goods(
#查詢條件,相當於介面的入參商品id
infoId: ID!
):Goods #Goods是在app/graphql/goods/schema.graphql中定義的商品詳情
}
複製程式碼
在總入口中涉及到的查詢物件,都需要在graphql資料夾下建立相應的資料夾,如上文中提到的goods,就在app/graphql資料夾中存在相應的goods資料夾。goods資料夾包含三個部分:schema.graphql,resolve.js和connector.js。 schema.graphql中需要定義總入口中提及的Goods物件:
# 商品
type Goods {
# 流水號
infoId: ID!
# 商品標題
title:String!,
# 商品內容
content:'String!,
#商品特點
special:'String!,
#商品價格
price:'nt!,
#商品圖片
image:'String!,
}
複製程式碼
graphql自帶一組預設標量型別,包括Int,Float,String,Boolean,ID。在定義欄位時需要註明型別,這也是graphql的特點之一,是支援強型別的。如果非空,就在型別後面跟上一個!號。graphql還包括列舉型別,列表和自定義型別,具體可以檢視相關文件。
resolve.js是資料型別的具體實現,依賴connector.js完成:
'use strict'
module.exports = {
Query: {
goods(root, {infoId}, ctx) {
return ctx.connector.goods.fetchById(infoId)
}
}
複製程式碼
connector.js是連線資料的具體實現,可以使用dataloader來降低資料訪問頻次,提高效能:
'use strict'
//引入dataloader,是由facebook推出,能大幅降低資料庫的訪問頻次,經常在Graphql場景中使用
const DataLoader = require('dataloader')
class GoodsConnector {
constructor(ctx) {
this.ctx = ctx
this.loader = new DataLoader(id=>this.fetch(id))
}
fetch(id) {
const goods = this.ctx.service.goods
return new Promise(function(resolve, reject) {
const goodsInfo = goods.getInfoById(id)
resolve([goodsInfo]) //注意這裡需要返回陣列形式
})
}
fetchById(id) {
return this.loader.load(id)
}
}
module.exports = GoodsConnector
複製程式碼
上面程式碼中涉及的this.ctx.service.goods就是app/service資料夾下的goods.js檔案匯出的方法物件,也就是獲取資料的具體業務邏輯:
const Service = require('egg').Service
const {createAPI} = require('../util/request')//實現的http請求
class GoodsService extends Service {
// 獲取商品詳情
async getInfoById(infoId) {
const result = await createAPI(this, 'example/getInfoById', 'get', {infoId})
return result
}
}
module.exports = GoodsService
複製程式碼
獲取資料可以用你能實現的任何方式,可以直接從資料庫獲取,也可以用http從現有的介面獲取。 這樣一個使用egg框架實現的graphql服務就完成了。 下面說一下前端。
前端
我們會使用vue配合Apollo完成前端搭建。
1 安裝依賴包
npm install --save vue-apollo apollo-client
複製程式碼
2.引用apollo
import 'isomorphic-unfetch'//黑板敲重點,apollo-client中直接使用了fetch,引入相容低版本瀏覽器
import { ApolloClient } from 'apollo-client'
import { HttpLink } from 'apollo-link-http'
import { InMemoryCache } from 'apollo-cache-inmemory'
import VueApollo from 'vue-apollo'
複製程式碼
3.配置連結
const httpLink = new HttpLink({
// 需要配置一個絕對路徑
uri: 'http://exzample.com/graphql',
})
複製程式碼
4.建立ApolloClient例項和PROVIDER
// Create the apollo client
const apolloClient = new ApolloClient({
link: httpLink,
cache: new InMemoryCache(),
connectToDevTools: true,
})
const apolloProvider = new VueApollo({
defaultClient: apolloClient,
})
複製程式碼
4.在vue中引入使用
Vue.use(VueApollo);
複製程式碼
5.根例項引用
var vm = new Vue({
el: '#app',
provide: apolloProvider.provide(),
router,
components: {
app: App
},
render: createEle => createEle('app')
})
複製程式碼
6.使用
<script>
import gql from "graphql-tag";
export default {
data() {
return {
goods:{},
infoId:123123
};
},
apollo: {
goods: {
query() {
return gql`{
goods(infoId:"${this.infoId}"){
title
content
price
image
}
}`
}
},
}
};
</script>
複製程式碼
展望
graphql對於目前介面數量多,難維護,擴充套件成本高,資料格式不可預知,文件難維護等問題給出了一個相對完善的方案,相信在未來,它將是我們工作中不可或缺的一部分。