GraphQL - 环境设置


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

  • 运行 Linux、macOS 或 Windows 的计算机。

  • 网络浏览器,最好是最新版本的 Google Chrome。

  • 安装了最新版本的 Node.js。建议使用最新的 LTS 版本。

  • 安装了 VSCode 扩展 GraphQL 的 Visual Studio Code 或您选择的任何代码编辑器。

如何使用 Nodejs 构建 GraphQL 服务器

我们将通过详细的逐步方法使用 Nodejs 构建 GraphQL 服务器,如下所示 -

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

安装 NodeJs 后,在终端上使用以下命令验证节点和 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 - 在数据文件夹中创建平面文件数据库

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

以下是Colleges.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 步 - 创建数据访问层

我们需要创建一个加载数据文件夹内容的数据存储。在本例中,我们需要集合变量StudentsCollege。每当应用程序需要数据时,它就会使用这些集合变量。

在项目文件夹中创建文件 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 的文件夹结构如下 -

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://localhost:9000/graphiql。在编辑器中输入以下查询 -

{
   Test 
}

来自服务器的响应如下 -

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

环境设置.jpg