npm包graphql-express-nodejs使用教程

前言

GraphQL 是一种用于 API 的查询语言。GraphQL 通过定义类型和对类型的查询、操作和订阅的结构来描述 API,使用 GraphQL 客户端可以精确地进行数据查询,任意粒度的执行查询操作,只需发送一个请求即可获取到所需数据,而不是像传统RESTful API一样获取所有数据甚至是不必要的数据。GraphQL 在前端领域得到了广泛的应用和追捧,而 graphql-express-nodejs 则是一个相对易用的 GraphQL 的 Node.js 实现,其构建在 graphql、express 和 node.js 之上,并得到了众多Node.js开发者的喜爱。

安装graphql-express-nodejs

在开始使用 graphql-express-nodejs 前,我们需要首先安装这个包,可以通过 npm 安装,命令如下:

--- - ----------------------

搭建GraphQL服务器

  1. 安装依赖

在你的项目目录下,使用 npm 安装必要的依赖:

--- ------- ------ ------- ------- ----------------------
  1. 初始化GraphQL中间件

在你的应用程序的入口文件中使用 graphql-express-nodejs 为应用程序创建 GraphQL 中间件。只需要在 Express 应用程序中调用 graphqlExpress() 函数:

----- ------- - -------------------
----- - -------------- - - ----------------------------------
----- --- - ----------
-- --- ------
--------
    -----------
    ----------------
        -------
    --
--

其中的 schema 是一个包含数据模型和查询的对象,在 GraphQL 中描述了 API 的类型系统。schema 可以使用类似 graphql-tools 之类的模块定义,其内容超出了本篇文章的范围,我们只做简单介绍。

  1. 创建示例 schema

在本教程中,我们将创建一个简单的 GraphQL schema,用于演示 graphql-express-nodejs 的工作原理。

先安装 graphql 和 graphql-tools:

--- - ------- -------------

创建一个名为 schema.js 的文件。

----- - -------------------- - - -------------------------
--- ----- - -
    -
        ------ ---- --------- -------
        ------- ----- ---------
    --
    -
        ------ --------- ------
        ------- -------- ----------
    --
--
----- -------- - -
  ---- ---- -
    ------ ------
    ------- ------
  -
  ---- ----- -
    ------ ------
    ----------- --------- ----
  -
  ---- -------- -
    -------------- -------- ------- --------- ----
  -
--
----- --------- - -
    ------ -
        ------ -- -- ------
        ----- -------- ----- -- -
            ------ --------------- -- ---------- --- ------------
        --
    --
    --------- -
        -------- -------- ----- -- -
            ----- ------- - -
                ------ -----------
                ------- ------------
            --
            --------------------
            ------ --------
        --
    --
--
----- ------ - ----------------------
    ---------
    ----------
---
-------------- - -------

在此例子中,我们使用了 typeDefs 定义了三个类型(Book, Query, Mutation),并在 resolvers 中实现了它们的功能,使用 GraphQLClient 发送相应的请求即可调用这些函数,得到对应的结果。

  1. 初始化Express

创建我们的入口文件(index.js),并导入必要的库。在这个示例中,我们使用了 express 和 body-parser 库。

----- ------- - -------------------
----- ---------- - -----------------------
----- - -------------- - - ----------------------------------
----- ------ - --------------------
----- --- - ----------

--------
    -----------
    ------------------
    ----------------
        -------
    --
--

----- ---- - -----
---------------- -- -- -
    -------------------- --- ------ -- --------- -- ---- ----------
---

在这个示例中,我们创建了一个 Express 应用程序,并使用 body-parser 来解析 GraphQL 请求体。我们还调用了 graphqlExpress() 方法,来将创建好的中间件挂载到 /graphql 路径上。

  1. 启动服务器

使用 node index.js 命令启动我们的服务器,在控制台中交互式的运行我们的请求,获取对应的数据。

GraphQL 请求方法

我们在示例代码中使用了方法名为 graphqlExpress() 的 GraphQL 中间件,它是基于 Express 的静态方法;此中间件由 GraphQL 所提供,用于执行 GraphQL 查询语句。让我们看一下这个中间件可接受的一些参数:

  • schema: 必选,GraphQL schema 对象。
  • context: 上下文对象,GraphQL 查询的内部使用,用于存储全局变量,例如数据库连接等。
  • rootValue: 请求处理程序从 schema 中读取的可选根值。如果未指定,默认根值设置为 request 对象。
  • graphiql: 可选的,Boolean 类型,如果为 true, 中间件将安装 GraphiQL 用户界面,用户界面可通过浏览器打开,它支持测试和 IDE 的功能。

GraphQL 请求示例

使用 GraphQL 客户端发送查询请求来获取数据,就像这样:

----- -
  ----- -
    -----
    ------
  -
-

----- -
  ----------- ---- --------- ------- -
    -----
    ------
  -
-

-------- -
  -------------- ---- --------- ------- -------- ------ -
    -----
    ------
  -
-

在上述请求中,我们使用了两种类型的请求,一种是查询请求,另一种是变更请求,通过这样的方式我们往往可以更为准确的获取我们需求的数据。

结语

本文向您展示了如何使用 graphql-express-nodejs 构建 GraphQL服务器,并针对示例进行了讲解,供各位前端开发者参考。GraphQL 的 API查询语言消除了RESTful的不足之处,并且还是未来的一种发展趋势,希望通过本文向大家传达了 GraphQL 的初步使用,帮助大家更快的掌握这个技术并提高项目的开发效率。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005731781e8991b448e94a9


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    1 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    1 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    1 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    1 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    1 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    1 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    1 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    1 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    1 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    1 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    1 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    1 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    1 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    1 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    1 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    1 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    1 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    1 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    1 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    1 个月前

相关推荐

    暂无文章