GraphQL 中使用 File Uploads 的完整指南

在前端开发中,文件上传是必不可少的功能之一。而在使用GraphQL进行服务端开发时,如何处理文件上传就显得比较困难。但现在,我们可以使用GraphQL的第三方解决方案 Apollo Server,它可以帮助我们方便地处理文件上传。

在本篇文章中,我们将介绍如何在GraphQL中使用File Uploads,一步步学习如何设置环境、定义schema、处理上传文件、以及如何在GraphQL Playground中进行文件上传测试等。

环境设置

在使用Apollo Server之前,需要先安装两个必要的依赖:apollo-servergraphql-upload。可以使用以下命令进行安装:

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

接着,我们需要在Apollo Server中使用graphqlUploadExpress中间件,具体代码如下:

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

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

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

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

这段代码可以实现开启Apollo Server的GraphQL Playground,并使用File Uploads功能。需要注意的是,我们需要在上面代码中关闭uploads选项,等待中间件进行处理。同时,我们也需要定义context上下文,后面需要使用。

定义Schema

在GraphQL中,我们需要定义Schema来说明我们的数据模型。对于文件上传,我们需要增加对应的自定义类型,用于上传文件和获取上传文件的数据。

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

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

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

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

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

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

在上面代码中,我们定义了两个mutation,分别是singleUploadmultipleUpload,用于上传单个文件和多个文件。同时定义了一个自定义类型Upload,用于上传文件数据。还需要定义一个自定义类型File,用于获取上传文件信息。

处理上传文件

在客户端发送上传请求之后,服务端需要对上传的文件进行处理,通过graphql-upload工具类实现文件的解析和上传。我们需要新建一个用于处理上传文件的resolver函数。

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

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

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

在代码中,我们通过createReadStream方法获取上传文件的可读流,使用createWriteStream方法将可读流写入到服务器的磁盘上。最后,将文件信息和路径通过Promise返回给客户端。

需要注意的是,我们在上面的代码中添加了唯一的id作为文件名的标识,这样可以有效地防止文件重复覆盖问题。

测试文件上传

到这一步,我们就实现了文件上传功能,下一步我们需要在GraphQL Playground中进行测试。首先,我们需要在请求头部添加Content-Type: multipart/form-data,表明上传内容类型是多媒体数据。

接着,我们就可以通过GraphQL Playground进行文件上传测试了。在Playground的左边菜单面板中,选择MUTATION,并在右边QUERY VARIABLES中添加如下代码:

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

MUTATION面板中,我们可以使用singleUploadmultipleUpload函数进行文件上传操作。具体使用如下:

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

点击QUERY VARIABLES中的运行按钮,在弹出的对话框中选择上传的文件,最后点击MUTATION面板的完成按钮即可提交。

总结

以上就是GraphQL中使用File Uploads的完整指南,我们学习了如何设置环境、定义Schema、处理上传文件、以及在GraphQL Playground中进行文件上传测试等操作。希望本文可以为大家在使用GraphQL进行前端开发时提供有价值的参考。

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


猜你喜欢

  • 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 个月前