如何在 GraphQL 中上传和下载文件

面试官：小伙子，你的代码为什么这么丝滑？

GraphQL 是一种 API 查询语言，它可以帮助前端开发人员更有效地构建和管理后端 API。在使用 GraphQL 时，与传统 RESTful API 不同的是，客户端可以通过单个请求获取所需的数据。虽然 GraphQL 可以方便地传输各种数据类型，但在处理文件时，操作可能会复杂一些。在本篇文章中，我们将介绍如何使用 GraphQL 在前端中上传和下载文件。

上传文件

使用 GraphQL 上传文件的方法依赖于服务端实现的方式。在本文中，我们假设后端使用 Node.js 和 Apollo Server。

安装依赖

在 Node.js 中，可以使用 multipart/form-data 格式的 HTTP 请求上传文件。我们需要安装以下两个库：

您可以使用以下命令安装这些库：

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

创建 schema

在 schema 中定义上传文件的类型：

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

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

我们使用 Upload 标量类型来表示上传的文件。在 File 类型中，我们定义了各种文件类型的元数据，包括文件名、MIME 类型、编码和 URL。在 Mutation 类型中，我们定义了一个名为 uploadFile 的操作，该操作接收一个 file 参数。

实现上传 API

在服务端实现功能的 API，我们需要创建一个 Express 应用程序，使用 apollo-server-express 构建 Apollo Server，以及使用 graphql-upload 处理文件上传。以下是实现 uploadFile API 的代码：

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

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

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

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

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

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

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

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

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

在上面的代码中，我们创建了一个 uploadFile 的 Mutation 类型的解析程序，并在其中获取来自客户端的 file 对象，并从中提取文件流、文件名、MIME 类型和编码。然后，我们将文件流复制到 uploads 文件夹中，并返回 File 类型的对象，该对象包含上传文件的元数据和 URL。

为了使用 graphql-upload，我们将 graphqlUploadExpress 中间件应用于 Express 应用程序。每当 GraphQL 查询中包含 Upload 标量类型时，该中间件将请求解析为可迭代的对象，并将这些对象放置在 file 字段中。

请注意，上面的代码只是示例代码，您可以根据需要进行更改。

客户端上传

一旦服务端 API 准备就绪，客户端就可以通过构造 FormData 对象上传文件。以下是一个简单的示例，展示了如何使用 JavaScript 对象和 mutation 来上传文件：

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

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

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

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

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

在上面的代码中，我们导入了 gql 和 useMutation 来创建并使用一个 UPLOAD_FILE mutation。然后，我们通过调用 handleFileUpload 函数在用户选择文件时上传文件。

下载文件

当使用 GraphQL 作为 RESTful API 时，您将客户端从特定 URL 下载文件，但在 GraphQL 中，您需要使用查询和解析程序获取文件，并将其返回给客户端。以下是在 GraphQL 中下载文件的简单示例。

定义 schema

首先，在您的 schema 中定义可以返回文件的新类型：

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

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

在 Query 类型中，我们定义了一个名为 downloadFile 的操作，该操作接收一个文件名，并返回一个文件对象。在 File 类型中，我们定义了各种文件类型的元数据，包括文件名、MIME 类型、编码和内容。

实现下载 API

然后，创建一个返回文件的解析程序。以下是实现 downloadFile API 的代码：

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

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

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

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

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

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

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

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

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

上述代码中，我们从本地文件系统获取请求文件的内容，并以 base64 编码返回文件对象。

客户端下载

一旦服务端 API 准备就绪，客户端可以发送查询以获取文件，并将其保存到计算机上。以下是一个简单的示例，展示了如何使用 JavaScript 对象和 window.open 函数来下载文件：

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

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

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

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

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

在上述代码中，我们使用 useQuery hook 发送一个名为 DOWNLOAD_FILE 的查询，并在 handleDownload 函数中映射客户端下载的文件。首先，我们将 data.downloadFile.content 基本解码，并将其转换为 Blob。然后，我们使用 URL.createObjectURL 函数生成一个文件 URL，该 URL 包含请求的文件。最后，我们将 URL 传递给 window.open 函数以启动下载。

结论

GraphQL 作为一种优秀的 API 查询语言，可以帮助前端开发人员更有效地使用后端 API。本文介绍了如何在前端中使用 GraphQL 上传和下载文件，以及如何在 GraphQL schema 和解析程序中定义文件类型。尽管文件处理可能会带来一定的挑战，但使用 GraphQL 可以让它变得更加容易。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/66f79ab7c5c563ced5a4bb93

阅读全文

猜你喜欢

  • 使用 Headless CMS 简化博客网站搭建

    在传统的博客网站搭建模式中，通常需要使用一个完整的 CMS 系统，如 WordPress 或 Joomla 等，它们提供了完整的前端和后端功能，包括用户管理、文章发布、样式自定义等。

    5 小时前
  • Cypress 错误解决：如何解决 No Such Element 错误

    Cypress 是一个基于 JavaScript 的前端自动化测试框架，它可以帮助我们高效地编写和运行自动化测试用例。然而，在使用 Cypress 进行测试的过程中，我们有时会遇到 No Such E...

    5 小时前
  • Mocha 测试中怎么样才能只执行部分测试用例？

    在使用 Mocha 进行测试时，你可能需要只运行部分测试用例而不是全部运行。这可能是因为你的测试套件非常大，或者你想只测试一部分代码。本文将介绍如何在 Mocha 中只执行部分测试用例，并提供一些示例...

    5 小时前
  • IOS 开发：如何优化本地存储

    本地存储是一种在移动应用程序和网站开发中常见的技术，它可以在用户离线时继续提供信息、内容和功能。在 IOS 开发中，使用本地存储的最佳方法是使用内置数据库 SQLite。

    5 小时前
  • TypeScript 中使用 let 和 const 定义变量和常量

    介绍 TypeScript 是一种静态类型检查器，它扩展了 JavaScript 并使其更易于使用和维护。在 TypeScript 中，我们可以使用 let 和 const 来定义变量和常量。

    5 小时前
  • 如何修复 CSS Reset 对滚动条样式的影响？

    在前端开发中，CSS Reset 是一个非常常见的技术。 它的原理是通过将浏览器的默认样式重置为一致的标准，以确保不同浏览器之间的样式相同。 但是 CSS Reset 常常会对浏览器滚动条样式造成影响...

    5 小时前
  • 在 Fastify 中构建 JWT 认证服务器

    引言 JWT（JSON Web Tokens）是一种用于安全交换信息的开放式标准，它可以在多个服务之间传递认证信息。在构建 Web 应用程序时，往往需要在请求和响应之间进行身份验证，JWT 作为一种有...

    5 小时前
  • 如何使用 ES6 中的数组方法简化代码

    如何使用 ES6 中的数组方法简化代码 随着 JavaScript 语言的发展，ES6 中新增的许多数组方法大大简化了开发人员的编程工作。这些方法可以让我们更容易地处理数据和操作数组，同时大大增加了代...

    5 小时前
  • SPA 开发中前后端分离的优缺点及应用实践

    单页应用（Single Page Application，SPA）是一种现代化的 Web 应用程序开发模式，它的一个特点就是前后端分离。本文将介绍 SPA 开发中前后端分离的优缺点，以及如何实践前后端...

    5 小时前
  • 使用 Enzyme + Jest 测试通过 HOC 形式创建的 React 组件

    在 React 中，高阶组件（Higher Order Component，简称 HOC）是一种非常常见的模式，它允许我们将组件逻辑重用在多个组件之间。使用 HOC 可以让我们更好地管理组件间的复杂度...

    5 小时前
  • PM2 与 Docker：构建可伸缩的 Node.js 应用程序

    前言 在开发现代 Web 应用程序时，Node.js 已成为最受欢迎的开发语言之一。Node.js 可以大力发挥其高度可扩展的架构，以构建高性能的 Web 应用程序。

    5 小时前
  • Material Design 中主题颜色的修改与自定义方法

    Material Design 是 Google 在 2014 年发布的一种全新的平面设计语言，旨在提供一个简洁、明晰、具有层次的用户界面设计风格。该设计语言使用明亮的色彩、深入的阴影效果、多种类型的...

    5 小时前
  • CSS Grid 布局问题集锦

    CSS Grid 布局是一种基于网格的布局系统，可以帮助前端开发人员更轻松地构建自适应、灵活且可复用的界面。尽管 CSS Grid 布局越来越普及，但是仍然存在一些问题需要面对和解决。

    5 小时前
  • 在 TailwindCSS 中实现无限滚动加载的技巧

    随着 Web 应用程序的普及，无限滚动加载成为了越来越流行的设计模式。它可以使用户感到更流畅，避免需要单击“下一页”按钮的情况。在 TailwindCSS 中实现无限滚动加载并不难，但是需要了解一些特...

    5 小时前
  • Redux 和 Immutable 数据结构的集成

    Redux 和 Immutable 数据结构的集成 储存和操作状态是前端应用程序的重要组成部分。Redux 和 Immutable 都是流行的前端技术，它们可以帮助处理状态，并提高应用程序的性能。

    5 小时前
  • ECMAScript 2021 和 React：优化性能的新方法

    前言 前端开发涉及到很多复杂的技术，而随着业界不断提升对用户体验的要求，性能优化也成为了前端开发的重点。ECMAScript 2021 和 React 的新功能在性能优化方面提供了一些新的方法，让开发...

    5 小时前
  • 10个ECMAScript 2019的新特性

    ECMAScript是JavaScript的标准规范，每年都会推出新的版本，提供新的特性和语法糖。2019版的ECMAScript已经发布，本篇文章将详细介绍10个新特性，对前端开发有指导意义。

    5 小时前
  • 如何实现无障碍访问依赖动态内容的应用程序？

    随着互联网技术的发展，越来越多的应用程序需要依赖动态内容来提供用户体验，例如 AJAX 加载、单页应用程序等。然而，这些应用程序往往会给残障人士造成访问困难，导致其无法充分利用这些服务。

    5 小时前
  • 构建高可用的 SPA 应用：浏览器兼容解决方案

    单页应用（Single Page Application，SPA）是现代 Web 开发技术的重要组成部分，它可以提供卓越的用户体验和高效的页面加载速度。但是，由于 Web 浏览器市场的多样性，有时候我...

    5 小时前
  • 在 SASS 中使用媒体查询的正确方法

    在SASS中使用媒体查询的正确方法 作为前端开发人员，我们经常需要针对不同的屏幕尺寸和设备类型来优化我们的网页布局和样式。这时候，媒体查询就成了我们必不可少的工具。

    5 小时前

相关推荐