GraphQL 环境设置

在本章中,我们将讲解GraphQL的环境设置。要执行本教程中的示例,您需要以下内容:

  • 运行Linux,macOS或Windows的计算机。
  • 网络浏览器,最好是最新版本的Google Chrome。
  • 安装了最新版本的Node.js. 建议使用最新的LTS版本。
  • 安装了用于VSCode的扩展GraphQL的Visual Studio代码或您选择的任何代码编辑器。

如何使用Nodejs构建GraphQL服务器

我们将通过详细的逐步方法来构建带有Nodejs的GraphQL服务器,如下所示:

第1步 - 验证节点和Npm版本

安装NodeJ后,使用终端上的以下命令验证节点和npm的版本 -

C:\Users\Admin>node -v
v8.11.3

C:\Users\Admin>npm -v
5.6.0

第2步 - 创建项目文件夹并在VSCode中打开

项目的根文件夹可以命名为test-app。

使用visual studio代码编辑器使用以下说明打开文件夹 -

C:\Users\Admin>mkdir test-app
C:\Users\Admin>cd test-app
C:\Users\Admin\test-app>code.

第3步 - 创建package.json并安装依赖项

创建一个package.json文件,该文件将包含GraphQL服务器应用程序的所有依赖项。

{
   "name": "hello-world-server",
   "private": true,
   "scripts": {
      "start": "nodemon --ignore data/ server.js"
   },

   "dependencies": {
      "apollo-server-express": "^1.4.0",
      "body-parser": "^1.18.3",
      "cors": "^2.8.4",
      "express": "^4.16.3",
      "graphql": "^0.13.2",
      "graphql-tools": "^3.1.1"
   },

   "devDependencies": {
      "nodemon": "1.17.1"
   }
}

使用下面给出的命令安装依赖项

C:\Users\Admin\test-app>npm install

第4步 - 在数据文件夹中创建平面文件数据库

在此步骤中,我们使用平面文件来存储和检索数据。创建一个文件夹数据并添加两个文件students.json和colleges.json。

以下是schools.json文件

[
   {
      "id": "col-101",
      "name": "AMU",
      "location": "Uttar Pradesh",
      "rating":5.0
   },

   {
      "id": "col-102",
      "name": "CUSAT",
      "location": "Kerala",
      "rating":4.5
   }
]

以下是students.json文件

[
   {
      "id": "S1001",
      "firstName":"Mohtashim",
      "lastName":"Mohammad",
      "email": "mohtashim.mohammad@tutorialpoint.org",
      "password": "pass123",
      "collegeId": "col-102"
   },

   {
      "id": "S1002",
      "email": "kannan.sudhakaran@tutorialpoint.org",
      "firstName":"Kannan",
      "lastName":"Sudhakaran",
      "password": "pass123",
      "collegeId": "col-101"
   },

   {
      "id": "S1003",
      "email": "kiran.panigrahi@tutorialpoint.org",
      "firstName":"Kiran",
      "lastName":"Panigrahi",
      "password": "pass123",
      "collegeId": "col-101"
   }
]

第5步 - 创建数据访问层

我们需要创建一个加载数据文件夹内容的数据存储区。在这种情况下,我们需要收集变量,学生和大学。每当应用程序需要数据时,它都会使用这些集合变量。

在项目文件夹中创建文件db.js,如下所示

const { DataStore } = require('notarealdb');

const store = new DataStore('./data');

module.exports = {
   students:store.collection('students'),
   colleges:store.collection('colleges')
};

第6步 - 创建架构文件schema.graphql

在当前项目文件夹中创建模式文件并添加以下内容

type Query  {
   test: String
}

第7步 - 创建解析器文件,resolvers.js

在当前项目文件夹中创建解析程序文件并添加以下内容

const Query = {
   test: () => 'Test Success, GraphQL server is up & running !!'
}
module.exports = {Query}

第8步 - 创建Server.js并配置GraphQL

创建服务器文件并配置GraphQL,如下所示 -

const bodyParser = require('body-parser');
const cors = require('cors');
const express = require('express');
const db = require('./db');

const port = process.env.PORT || 9000;
const app = express();

const fs = require('fs')
const typeDefs = fs.readFileSync('./schema.graphql',{encoding:'utf-8'})
const resolvers = require('./resolvers')

const {makeExecutableSchema} = require('graphql-tools')
const schema = makeExecutableSchema({typeDefs, resolvers})

app.use(cors(), bodyParser.json());

const  {graphiqlExpress,graphqlExpress} = require('apollo-server-express')
app.use('/graphql',graphqlExpress({schema}))
app.use('/graphiql',graphiqlExpress({endpointURL:'/graphql'}))

app.listen(
   port, () => console.info(
      `Server started on port ${port}`
   )
);

步骤9 - 使用GraphiQL运行应用程序和测试

验证项目测试应用程序的文件夹结构如下

test-app /
   -->package.json
   -->db.js
   -->data
      students.json
      colleges.json
   -->resolvers.js
   -->schema.graphql
   -->server.js

运行命令npm start,如下所示

C:\Users\Admin\test-app>npm start

服务器在9000端口运行,因此我们可以使用GraphiQL工具测试应用程序。打开浏览器并输入URL http//localhost9000/graphiql。在编辑器中键入以下查询

{
   Test
}

服务器的响应如下

{
   "data": {
      "test": "Test Success, GraphQL server is running !!"
   }
}

服务器的响应

下一章:GraphQL 架构

GraphQL 是描述 GraphQL 服务器行为的规范。它是一套关于如何处理请求和响应的指南,如支持的协议,服务器可以接受的数据格式,服务器返回的响应格式等。客户端对GraphQL的请求server称为Query。G ...