npm 包 @graphql-toolkit/graphql-file-loader 使用教程

GraphQL 是一种用于 API 的查询语言,同时也是一个满足你数据查询的运行时。GraphQL 对你的 API 中所提供的数据设定了一套统一的、易用的、强大的、可操作的 API,同时对你的应用程序所面临的查询,变更,和订阅等方面也同样具备相关能力。

GraphQL 可以看作一个是 API 的中间层,协调服务端和客户端间的数据交互。在 Node.js 中使用 GraphQL 提供的工具可以大大方便我们的开发。

graphql-file-loader 是一个使得我们可以在 .js 或 .ts 文件中书写 GraphQL Schema 或者模拟客户端请求的工具,可以帮助我们在开发中更加快速的进行 schema 的开发。

安装

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

使用

在 .js 或者 .ts 等文件中使用 graphql-file-loader

通过 import 或者 require 引入的 GraphQL 模块,我们可以把 .graphql 文件中的语句传递给 graphql-parse,就可以对其中的 GraphQL 语句进行编译和操控。在加载模块时,webpack 会查找 .graphql 文件,自动调用该 loader 并把它当成一个模块调入。

在 webpack.config.js 中加入规则

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

在代码中引用 .graphql

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

或者,使用 require:

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

我们也可以在代码中继续使用 gql 解析出来的字符串:

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

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

将 .graphql 文件编译为 .js

可以先编写好 GraphQL Schema 语句并保存在 .graphql 文件中,然后利用 graphql-file-loader 对其进行编译并生成一个 js 文件,最后再将生成的 js 文件作为一个普通 js 文件进行引用,就可以直接使用其中的 schema 语句。

举个例子,在新建一个 helloworld.graphql 文件,然后进行以下定义:

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

GraphQL 视极简代码规范为生死攸关,尤其在建立定义好的 Schema 命名时,使用数据源名称作为前缀命名。

若命名为 Hello World,则会出现正则等相关复杂操作时的无法预知错误。

接着,我们在 package.json 中新建以下内容:

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

并在项目根目录下写入 codegen.yml 的配置文件,如下:

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

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

webpack.config.js 指定 loader:

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

我们可以直接使用 import 命令或通过 require 的方法,将编译后的文件作为模块导入:

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

或者:

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

使用演示

示例代码如下(假设在文件路径 src/graphql/schema.graphql 文件中有以下 Schema 定义):

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

创建resolvers.js文件:

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

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

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

创建 index.js 文件:

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

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

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

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

在项目根目录下执行:

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

便可以看到控制台输出以下信息:

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

至此,通过 webpack 和 graphql-file-loader 工具,我们可以很方便地对 GraphQL Schema 语句进行管理,并且可以在代码中引用已经对 GraphQL Schema 语句进行了编译的文件,而不用担心 GraphQL Schema 语句过于庞大导致代码难以维护的问题。

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


猜你喜欢

  • npm 包 get-object-path 使用教程

    我们在前端开发中经常需要处理 JavaScript 对象,有时候需要操作嵌套对象的属性,这时候就需要使用一个方便快捷的方法来访问对象的属性,这个时候 get-object-path 就派上用场了。

    7 个月前
  • npm包stylco使用教程

    在Web开发领域,CSS样式是网站重要的视觉设计元素。但是,CSS的样式管理常常会变得混乱和难以维护。 stylco是一个npm软件包,可以解决CSS样式管理问题。

    7 个月前
  • npm 包 aliyun-cs-client 使用教程

    前言 在今天的云计算和容器化浪潮的背景下,阿里云容器服务(Alibaba Cloud Container Service,简称 ACS)成为了越来越多企业解决容器化方案的首选。

    7 个月前
  • npm 包 darmody-fine-uploader 使用教程

    在前端开发中,文件上传是一个常见的需求。而 npm 包 darmody-fine-uploader 就是一个非常好用的文件上传包,支持多种上传方式和自定义样式等功能。

    7 个月前
  • npm 包 nativescript-utilities 使用教程

    简介 nativescript-utilities 是一个为 NativeScript 应用程序开发而设计的 npm 包,旨在帮助开发者提高效率和增强功能。它常用于简化常见工作,如 HTTP 请求、文...

    7 个月前
  • npm 包 serverless-plugin-scripts 使用教程

    简介 serverless-plugin-scripts 是一个 npm 包,可以帮助开发者在 serverless 构架中方便地运行脚本,包括在 pipeline 中运行 bash 脚本、在 bui...

    7 个月前
  • npm 包 simple-dispatch 使用教程

    npm 包 simple-dispatch 使用教程 前言 在前端开发过程中,我们经常会遇到需要进行事件的订阅和发布的情况,例如发送一个全局通知,或者监控一个按钮的点击事件是否触发,这时候我们可以使用...

    7 个月前
  • npm 包 zup 使用教程

    简介 zup 是一个基于 puppeteer 的可视化 web 页面自动化测试工具。它可以方便地模拟用户操作,进行页面元素的自动点击、填写等操作,实现 UI 测试、性能测试、爬虫等多种应用。

    7 个月前
  • npm 包 clarkchen633 使用教程

    前言 在前端开发过程中,我们常常需要使用一些外部的库和工具来提高开发效率和代码质量。npm(Node Package Manager)是世界上最大的软件库之一,其中不乏许多优秀的前端工具包和插件。

    7 个月前
  • npm 包 my-package-zpy 使用教程

    简介 my-package-zpy 是一个开源的 npm 包,旨在提供一些有用的前端工具函数和组件。这个包是由前端开发者 zpy 所编写和维护,并在他的开源项目中使用。

    7 个月前
  • npm包didi_texi使用教程

    在前端开发中,npm是不可或缺的依赖管理工具,能够方便地引入各种第三方包。在这里,我们介绍一款非常实用的npm包——didi_texi,它可以方便地处理各种文本格式。

    7 个月前
  • npm 包 gh-compare-commits 使用教程

    随着开源社区的不断发展,GitHub 成为一个被广泛使用的版本管理平台。在进行代码开发的过程中,常常需要进行代码比较,以便了解代码变更的情况。这个时候,一个比较好用的工具就是 gh-compare-c...

    7 个月前
  • npm 包 ng2-uimodule-thetasp 使用教程

    在前端开发中,使用 npm 包是十分常见的。npm 包为我们提供了许多实用功能和工具,大大提升了前端开发的效率。在本文中,我们将介绍一个非常有用的 npm 包 ng2-uimodule-thetasp...

    7 个月前
  • npm 包 cordova-plugin-ddplugin 使用教程

    什么是 cordova-plugin-ddplugin cordova-plugin-ddplugin 是一个针对 Cordova 应用开发的插件,可以快速简便地实现钉钉 API 功能的调用。

    7 个月前
  • npm 包 webpack-cdnizer 使用教程

    随着前端项目越来越复杂,依赖的第三方库也越来越多,经常会有这样的场景:相同的库在不同的页面都被引用,导致重复加载,浪费带宽和加载时间。该怎么办呢?CDN 选择是个不错的方案,webpack-cdniz...

    7 个月前
  • npm 包 cordova.plugin.location 使用教程

    前言 在开发移动应用过程中,获取用户位置信息是非常常见的需求之一。而 cordova.plugin.location 这个 npm 包便是一个很好的解决方案。本文将深入介绍如何使用 cordova.p...

    7 个月前
  • npm 包 feathers-postgres 使用教程

    在现代的 Web 应用开发中,一般使用前端框架与后端框架配合使用。前端框架可以帮助我们快速开发客户端页面,而后端框架可以帮助我们完成数据存储和处理等任务。其中,SQL 数据库是常用的一种存储方式,而 ...

    7 个月前
  • npm 包 lite-bencode 使用教程

    前言 随着云计算和大数据的兴起,种子文件在文件共享和文件传输中的地位越来越重要。在种子文件中,bencode 是一种常用的编码方式。因此,很多前端开发者也需要掌握 bencode 编解码的技能。

    7 个月前
  • npm 包 react-native-action-sheet-veedy 使用教程

    在 React Native 开发中,弹出对话框是非常常见的需求。其中,ActionSheet 对话框是一种在 App 中用来展示一组可供选择的操作项的组件,通常用于提示用户在不同情境中可使用的操作,...

    7 个月前
  • npm 包 feathers-postgresql 使用教程

    介绍 feathers-postgresql 是一个 Node.js API 服务开发框架 FeathersJS 的一个 PostgreSQL 数据库适配器。使用该适配器,开发人员可以轻松地对 Pos...

    7 个月前