本文屬使用Prisma構(gòu)建GraphQL服務(wù)系列。

本文介紹如何使用typescript開發(fā)prisma服務(wù)。將使用graphql-yoga作為web服務(wù)器，并使用prisma-binding連接Prisma數(shù)據(jù)庫(kù)服務(wù)。

本文代碼可從GitHub上的GraphQL樣板項(xiàng)目中找到。

先安裝node和Docker吧，騷年

安裝CLI

本教程使用Prisma CLI管理Prisma數(shù)據(jù)庫(kù)服務(wù)，第一步先安裝CLI工具。
打開終端，全局安裝Prisma CLI：

# 1
npm install -g prisma

確保已安裝了Docker，再繼續(xù).
初始化本地環(huán)境，后續(xù)可將Prisma服務(wù)部署在本地，

## 2
prisma local start

說(shuō)明：這行命令從Docker下載兩個(gè)鏡像文件，比較大，耐心等待。

構(gòu)建GraphQL服務(wù)

現(xiàn)在可以使用prisma init命令構(gòu)建GraphQL 服務(wù)。注意，這條命令將觸發(fā)選擇模版的交互式會(huì)話。

prisma init命令my-app參數(shù)，Prisma CLI將創(chuàng)建my-app目錄，此目錄下存放項(xiàng)目所有文件。

## 3
prisma init my-app

• 當(dāng)提示how you want to set up your Prisma service?時(shí)，選擇GraphQL server/fullstack boilerplate(recommended)選項(xiàng)。
• 接著CLI提示選擇GraphQL 樣板(select a GraphQL boilerplate as foundation for your project)作為基礎(chǔ)時(shí)，選擇typescript-basic樣板。
• 最終，提示何處部署(which cluster you want to deploy)時(shí)，選擇localcluster。

注意，此處的cluster與Docker中的集群還是有點(diǎn)差別，但可以如此理解。

prisma init命令執(zhí)行完成后，Prisma 數(shù)據(jù)庫(kù)服務(wù)部署完成，可以通過 http://localhost:4466/my-app/dev訪問。

如你所知，數(shù)據(jù)庫(kù)服務(wù)的HTTP端點(diǎn)由以下組件組成：

• cluster的域(指~/.prisma/config.yml文件中的host屬性):http://localhost:4466/my-app/dev;
• Prisma service名字，在prisma.yml文件中指定:my-app;
• 服務(wù)部署stage，默認(rèn)為:dev。

注意，此端點(diǎn)在src/index.ts中引用，實(shí)例化Prisma，并綁定application schema與Prisma schema：

const server = new GraphQLServer({
  typeDefs: './src/schema.graphql',                 // points to the application schema
  resolvers,
  context: req => ({
    ...req,
    db: new Prisma({
      endpoint: 'http://localhost:4466/my-app/dev', // the endpoint of the Prisma DB service
      secret: 'mysecret123',                        // specified in `database/prisma.yml`
      debug: true,                                  // log all GraphQL queries & mutations
    }),
  }),
})

文件結(jié)構(gòu)如下：

1.1.1structure.png

了解以下：

• /(根目錄)
  • .graphqlconfig.yml:GraphQL配置文件，包含端點(diǎn)和schema配置. 由graphql-cli和GraphQL Playground使用。
  • package.json: npm包管理文件，詳見package.json
• /database
  • database/prisma.yml: 數(shù)據(jù)庫(kù)服務(wù)配置文件；
  • database/datamodel.graphql 數(shù)據(jù)模型定義(SDL);
  • database/seed.graphql: 初始數(shù)據(jù)。
• /src
  • src/schema.graphql 定義application schema，指明向客戶端公開的GraphQL API ;
  • src/generated/prisma.graphql 定義 Prisma schema，根據(jù)/database/datamodel.graphql生成，包含數(shù)據(jù)模型的CRUD(* Create、Retrieve、Update、Delete) API定義，不要手動(dòng)修改此文件*，而是通過修改數(shù)據(jù)模型/database/datamodel.graphql文件，并通過 prisma deploy命令自動(dòng)生成。
  • src/index.ts 服務(wù)入口, 將所有東西組合起來(lái)，通過 graphql-yoga啟動(dòng) GraphQLServer。

最重要的兩個(gè)文件database/datamodel.graphql和src/schema.graphql。

• database/datamodel.graphql:定義數(shù)據(jù)模型;
• src/schema.graphql:定義向客戶端公開的API。

典型的database/datamodel.graphql`數(shù)據(jù)模型如下：

type Post {
  id: ID! @unique
  isPublished: Boolean!
  title: String!
  text: String!
}

基于此數(shù)據(jù)模型,Prisma生成Prisma schema，即GraphQL schema，定義了CRUD API，此schema保存在src/generated/prisma.graphql中，并由CLI在部署時(shí)更新。
現(xiàn)在可以啟動(dòng)服務(wù)了....

第三步:啟動(dòng)服務(wù)

調(diào)用package.json中定義的devscript，其將啟動(dòng)服務(wù)，且打開一個(gè)GraphQL Playground程序。

## 4
cd my-app
yarn dev

注意，Playground可同時(shí)使用兩個(gè)API：

• app:application schema，即公開的Web服務(wù)GraphQL API(在src/schema.graphql定義)
• database:Prisma schema，即Prisma數(shù)據(jù)庫(kù)服務(wù)提供的GraphQL CRUD API(在database/datamodel.graphql定義)。

可以簡(jiǎn)單理解為：app為對(duì)外公開的服務(wù)API，供客戶端調(diào)用；database為數(shù)據(jù)庫(kù)，供自己使用，對(duì)客戶端不可見。

1.1.1playground.png

注意，Playground自動(dòng)生成文檔，顯示所有支持的GraphQL API操作(如查詢query、突變mutation和訂閱subscription)，如上圖右邊所示.

一旦Playground打開，可以發(fā)送查詢和突變。

針對(duì)appliction schema發(fā)送查詢和突變

使用 appPlayground訪問application schema中定義的GraphQL API。

粘貼如下代碼到左側(cè)面板中appPlayground，點(diǎn)擊Play-button(CMD+Enter)：

mutation {
  createDraft(
    title: "GraphQL is awesome!",
    text: "It really is."
  ) {
    id
  }
}

如果此時(shí)發(fā)送feedQuery，服務(wù)仍然返回空數(shù)組，因?yàn)?code>feed僅僅返回Post中isPublished屬性true的數(shù)據(jù)(createDraft突變創(chuàng)建的數(shù)據(jù)isPublished為false)，可以通過publish突變先發(fā)布一個(gè)Post。

復(fù)制調(diào)用createDraft返回Post的id，替換如下代碼中__POST_ID__占位符：

mutation {
  publish(id: "__POST_ID__") {
    id
    isPublished
  }
}

執(zhí)行上面突變后，有一條數(shù)據(jù)isPublished為true了，即可調(diào)用feedQuery,返回已經(jīng)發(fā)布了的Post：

query {
  feed {
    id
    title
    text
  }
}

這與訪問傳統(tǒng)REST API有點(diǎn)像：在數(shù)據(jù)庫(kù)之上封裝了一層向外公開的API。

針對(duì)Prisma API發(fā)送查詢和突變

Prisma scheme(src/generated/prisma.graphql)定義GraphQL CRUD API,使用database Playground訪問。

現(xiàn)在直接針對(duì)數(shù)據(jù)庫(kù)API，所以不受application scheme邏輯限制，可以使用完整的CRUD功能發(fā)布Post。

粘貼如下代碼到左側(cè)面板中database Playground，點(diǎn)擊Play-button(CMD+Enter)：

mutation {
  createPost(
    data: {
      title: "What I love most about GraphQL",
      text: "That it is declarative.",
      isPublished: true
    }
  ) {
    id
  }
}

通過mutation創(chuàng)建Post數(shù)據(jù)，其isPublished字段為true，所以可用feed query返回。

在database Playground，當(dāng)然也可以針對(duì)現(xiàn)有的Post直接發(fā)送update和 delete mutation，依照規(guī)則，必須先獲取其id值。

在database Playground發(fā)送如下查詢：

{
  posts {
    id
    title
  }
}

從返回的數(shù)組中任意取一個(gè)id值，替換如下代碼中的__POST_ID__占位符：

mutation {
  updatePost(
    where: { id: "__POST_ID__" },
    data: { text: "The awesome community." }
  ) {
    id
    title
    text
  }
}

將對(duì)應(yīng)id的text屬性修改為The awesome community.，

最后，刪除Post，發(fā)送如下mutation(再次使用上面的id替換__POST_ID__占位符)：

mutation {
  deletePost(
    where: { id: "__POST_ID__" }
  ) {
    id
    title
    text
  }
}

這與用SQL直接訪問數(shù)據(jù)庫(kù)有點(diǎn)像，供系統(tǒng)內(nèi)部使用