在本文中,我们将探讨如何在 Node.js
中设置 Express.js
和 GraphQL
。另外,本文还将分享一些基本技巧,以确保我们的服务器已准备好投入实际使用!
GraphQL
是 API
的查询语言,它提供了一种更灵活的方式来获取所需的数据。使用 GraphQL
,我们不必拥有用于不同目的的多个端点,而是可以使用单个端点来根据您提供的查询提供不同的数据。
今天,我们就来看看如何通过使用 Express
来设置 GraphQL
。
创建一个名为node-demo
的新文件夹,在控制台上打开该文件夹并输入:
npm init
@graphql-tools/load-files
:这个工具帮助我们从项目中加载模式文件。@graphql-tools/schema
:对于合并和创建 GraphQL
模式很有用。cors
:提供中间件以在我们的 Express
应用程序中启用跨源资源共享(CORS
)。dotenv
:帮助将环境变量从.env
文件加载到process.env
.express
:Node.js
的 Web
服务器框架。它是我们应用程序的支柱。express-graphql
:将 GraphQL
与 Express
集成的中间件。graphql
:使用JavaScript
实现的GraphQL
核心包。graphql-tools
:提供一组用于在 JavaScript
中构建 GraphQL API
的实用程序。首先,让我们使用 yarn
安装这些包:
yarn add @graphql-tools/load-files @graphql-tools/schema cors dotenv express express-graphql graphql graphql-tools
安装好后,项目中的package.json
应该如下所示:
{
"name": "node-demo",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"@graphql-tools/load-files": "^6.6.1",
"@graphql-tools/schema": "^10.0.0",
"cors": "^2.8.5",
"dotenv": "^16.3.1",
"express": "^4.18.2",
"express-graphql": "^0.12.0",
"graphql": "^15.8.0",
"graphql-tools": "^7.0.5"
}
}
// index.js
const http = require('http');
const app = require('./app.js');
require('dotenv').config();
const PORT = process.env.PORT || 8000;
const httpServer = http.createServer(app);
async function startServer() {
httpServer.listen(PORT, () => {
console.log(' server is live on ', PORT);
});
}
startServer();
http
模块并用它初始化一个 Node.js
服务器。app.js
文件中加载我们的 Express
服务器配置。我们稍后将讨论该文件的细节。dotenv
,它将从一个名为 .env
的特殊文件中读取一些环境变量。在继续之前,请在项目根目录中创建一个
.env
文件。可以在此处放置数据库连接详细信息、密钥等信息。
// app.js
const cors = require("cors");
const express = require("express");
const { graphqlHTTP } = require('express-graphql');
const Api1 = require("./routes/api.js");
const graphqlServer = require("./graphql/index.js");
const app = express();
app.use(
'/graphql',
graphqlHTTP({
schema: graphqlServer,
graphiql: true,
})
)
app.use(
cors()
);
app.use(express.json());
app.use("/v1", Api1);
module.exports = app;
在 app.js
文件中,我们正在为我们的服务器奠定基础:
./routes/api.js
文件,定义路由。cors
跨源请求、构建我们的服务器并将express-graphql
和express
集成 GraphQL
。GraphQL
, 设置并启用graphiql
来更简单的实现 GraphQL
查询。CORS
并设置中间件来解析传入的 JSON
请求。Express
服务器。注意:确保项目根目录中有
routes
和graphiql
文件夹。它们将分别容纳我们的Express
路由和GraphQL
架构。
// graphql/index.js
const path = require("path");
const { loadFilesSync } = require("@graphql-tools/load-files");
const { makeExecutableSchema } = require("@graphql-tools/schema");
const typeDefs = loadFilesSync(path.join(__dirname, "**/*.graphql"));
const resolvers = loadFilesSync(path.join(__dirname,"**/*.resolver.js"))
const executableSchema = makeExecutableSchema({
typeDefs,
resolvers,
});
module.exports = executableSchema;
// graphql/index.js
const { loadFilesSync } = require("@graphql-tools/load-files");
const { makeExecutableSchema } = require("@graphql-tools/schema");
@graphql-tools/load-files
模块中引入loadFilesSync
函数。它是加载多个文件的助手。@graphql-tools/schema
模块中引入makeExecutableSchema
,它将帮助我们结合类型定义和解析器来创建 GraphQL
模式。// graphql/index.js
const typeDefs = loadFilesSync(path.join(__dirname, "**/*.graphql"));
在这里,我们从当前目录及其子目录中加载所有后缀为.graphql
的文件。这些文件描述了我们数据的“形状”以及我们可以对其执行的操作。
// graphql/index.js
const resolvers = loadFilesSync(path.join(__dirname,"**/*.resolver.js"))
const executableSchema = makeExecutableSchema({
typeDefs,
resolvers,
});
从当前目录及其子目录加载所有后缀为.resolve.js
文件,这些文件是提供处理 GraphQL
操作逻辑的函数,例如获取数据或进行更改。
// graphql/hello/hello.graphql
type Query {
hello: String!
}
// graphql/hello/hello.resolver.js
const resolvers = {
Query: {
hello: () => "Hello, World!"
}
};
我们创建了以.graphql
和.resolver.js
结尾的文件。此设置的优点在于我i们不需要跟踪每个新文件或手动导入它们。@graphql-tools/load-files
中的loadFilesSync
方法会自动替我们完成。
// routes/api.js
const { Router } = require('express');
const Api1 = Router();
const helloRouter = require('./hello/hello.router.js');
Api1.use('/hello', helloRouter);
module.exports = Api1;
// routes/hello/hello.router.js
const { Router } = require("express");
const helloRouter = Router();
const helloController = require("./hello.controller.js");
helloRouter.get("/", helloController.sayHello);
module.exports = helloRouter;
// routes/hello/hello.controller.js
async function sayHello(request, response) {
response.status(200).json("hello from the express graphql server");
return
}
module.exports = {
sayHello,
};
在这些文件中,我们按照 MVC
模式设置基本的 Express.js
服务。
通过我们之前的设置,我们的服务器现已完成并准备好处理传入请求。要启动并运行它,只需在终端中输入node index.js
即可。在服务启动之后我们可以:
http://localhost:8000/graphql
访问 GraphQL
URL
访问 Express
服务