npm 包 egg-qiniu-sdk 使用教程

前言

如今,互联网中的大部分应用都需要上传文件功能,例如图片、视频、文档等。因此,云存储服务也应运而生,其中七牛云是一家值得推荐的云存储服务商。七牛云提供了丰富的 API 和 SDK,让开发者能够快速使用云存储服务。

本文将介绍一个 npm 包 —— egg-qiniu-sdk,它是 Egg.js 框架中使用七牛云服务的封装包,可以方便地将七牛云作为 Egg.js 项目的上传文件服务。

安装和配置

为了使用 egg-qiniu-sdk,我们需要先安装它。使用以下命令安装:

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

安装完成后,我们需要在 Egg.js 中进行配置。

在 config 文件夹下新建 config.default.js 文件。在其中加入如下代码:

------------- - -
  ---------- ----- -----
  ---------- ----- --------
  ------- ----- --------
  -- ----
  ----- ----- ------
  ------- ----- --------
  --------- ----- ----------
  -- ----- ---
  ---- ---------- ---- -- -
    -- ------ ------
    ------ --------------------------------
  -
--
  • accessKey:在七牛云控制台中申请的 AccessKey;

  • secretKey:在七牛云控制台中申请的 SecretKey;

  • bucket:用来存储文件的空间名称;

  • zone:该参数可以不填。默认为 Zone_z0,也就是华东地区;

  • origin:该参数可以不填。默认为 http://${bucket}.qiniudn.com/

  • pathname:该参数可以不填。默认为 /upload/

  • key:可选参数,为自定义上传 key。默认为随机字符串。

使用方法

封装 Service

在应用中,我们通常会将对七牛云的请求封装成 Service,以便在 Controller 中使用。

在 app/service 目录下新建文件 qiniu.js,其中加入如下代码:

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

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

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

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

异步上传文件

在上传文件时,我们可以使用七牛云提供的异步上传方式,从而在上传完文件后,七牛云会异步地执行我们提供的 callback 函数。

在 app/controller 目录下新建文件 upload.js,其中加入如下代码:

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

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

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

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

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

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

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

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

-------------- - -----------------
  • 在 egg 中,我们可以使用 multipart() 方法获取上传的文件。由于异步上传文件时,需要等待文件流全部传输到服务器才能上传到七牛云,因此需要循环处理。

  • 在处理每个 part 时,我们可以通过调用 await ctx.helper.saveUploadFile(part, { extname: '.png', sha1: true }) 方法来保存文件至本地,并获取类似如下的 fileInfo:

-
  ---------- -------
  ----------------- -----------
  ------------ -----------------------------------------
  ----- ------------------------------------------
-
  • 同时,在该方法中可以调用 ctx.app.config.qiniu.key 来获取自定义上传 key 的方法。我们可以自行实现该方法,以便将上传 key 与当前用户关联。默认的实现方式为返回一个随机字符串。

  • 最后,我们通过调用 formUploader.putFile() 方法来上传文件到七牛云。

  • 该接口的返回值为上传文件的 key。

在模板中使用上传文件链接

在模板中,我们可以使用以下方法来生成文件的链接:

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

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

其中,上述代码中,fileKey 即为我们上传时返回的 key。

总结

本文介绍了 Egg.js 中使用七牛云上传文件的 npm 包 —— egg-qiniu-sdk,并且将它封装到 Service 中,以便在 Controller 中进行调用。

同时,本文还给出了如何使用异步上传文件的示例代码,以及在模板中使用上传文件链接的方法。它们不仅在 Egg.js 中使用,也对于其他框架实现上传文件功能时有一定的参考价值。

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


猜你喜欢

  • npm 包 react-native-blob-upload 使用教程

    React Native 是一种用于构建跨平台原生应用程序的框架。react-native-blob-upload 是一个npm包,它可以让你轻松地上传和下载文件。

    3 年前
  • npm 包 Smart-RSS-to-JSON 使用教程

    在 Web 开发中,我们常常需要使用 RSS(Really Simple Syndication)这样的标准协议来获取博客、新闻等网站的最新动态。而 Smart-RSS-to-JSON 就是一个能够将...

    3 年前
  • 使用 Puppexport:一个前端开发必备的 npm 包

    引言 在前端开发过程中,我们经常需要进行一些自动化测试、爬虫以及页面截图等操作。而 Puppexport 正是一个非常实用的 npm 包,它可以非常方便地使用 headless Chrome 自动完成...

    3 年前
  • npm 包 @set-state/core 使用教程

    介绍 在前端开发中,当我们需要管理组件的状态时,我们通常会利用 React 提供的组件状态机制来进行开发。但是,直接使用 React 的状态机制可能会导致一些问题,例如需要手动维护多个状态和容易出现分...

    3 年前
  • npm 包 generator-express-lambda 使用教程

    在现代前端开发中,使用 npm 包已经成为一种必不可少的方式。在这篇文章中,我们将学习如何使用一个 npm 包,generator-express-lambda。 generator-express-...

    3 年前
  • npm 包 hop-cli 使用教程

    npm 包 hop-cli 是一个前端构建工具,它提供了一套简单易用的命令行工具,可以帮助我们快速搭建前端项目的基础架构,例如 webpack 配置,babel 配置,eslint 配置等,极大地提高...

    3 年前
  • npm 包 js-xlsx-jszip-concat 使用教程

    在前端项目中,Excel 格式的数据是常见的数据交换格式。而如何在前端中操作 Excel 格式的文件呢?这就需要使用到 js-xlsx-jszip-concat 这个 npm 包了。

    3 年前
  • npm 包 react-native-jalali-date-picker 使用教程

    简介 React Native 是一款让你可以使用 JavaScript 和 React 语法编写原生 iOS 和 Android 应用的开发框架。同时,React Native 的开发生态也非常丰富...

    3 年前
  • NPM 包 @conga/framework-worker 使用教程

    简介 @conga/framework-worker 是一个基于 Node.js 的任务队列框架,可以用于解决并发任务的问题。它提供了多种任务处理方式,可以使用 Web Worker、child_pr...

    3 年前
  • npm 包 hyperterm-savetext 使用教程

    简介 hyperterm-savetext 是 HyperTerm 的一个 npm 插件,提供了保存终端文本的功能,这对于前端开发者来说是非常有用的。 安装 你可以执行以下命令来安装 hyperter...

    3 年前
  • npm 包 @citizenos/stream_upload 使用教程

    最近,@citizenos/stream_upload 这个 npm 包备受关注。该包主要用于向文件上传流上传文件。在本文中,我们将学习如何使用这个包。 什么是 @citizenos/stream_u...

    3 年前
  • npm 包 jsdoc-webpack4-plugin 使用教程

    如果你正在编写 JavaScript 库或构建了一个 Node.js 应用程序,那么文档化是非常重要的。文档化可以帮助其他开发人员理解你的代码库,并更快地进行开发。

    3 年前
  • npm 包 kaiquecruz-cordova-plugin-chrome-apps-sockets-udp 使用教程

    前言 在前端开发中,我们经常会需要在不同设备之间进行数据传输。而 UDP 协议是一种面向无连接的传输层协议,具有简单、快速和高效的特点。本文将介绍 npm 包 kaiquecruz-cordova-p...

    3 年前
  • npm 包 react-native-template-re-base-test 使用教程

    在 React Native 的开发中,我们经常需要用到模板来加快应用的开发速度。react-native-template-re-base-test 是一个非常流行的模板,它大大减少了应用的开发难度...

    3 年前
  • npm 包 watch-typing 使用教程

    前言 在前端开发过程中,经常需要使用一些第三方库。而这些库的升级和安装可能经常会出现问题。为了方便管理,npm 包管理器应运而生。npm 是一个管理前端依赖包的工具,它可以使我们在开发时更加方便地管理...

    3 年前
  • npm 包 @batteryincluded/ts-eventsourcing 使用教程

    背景 在现代的大型应用程序中,通过事件驱动架构实现的事件溯源(Event Sourcing)模式变得越来越流行。它强制开发人员将所有状态变更视为事件,并记录下这些事件,而不是直接将更改写入数据库。

    3 年前
  • npm 包 lycwed-cordova-plugin-clipboard 使用教程

    前言 在前端开发中,我们常常需要实现复制与粘贴的功能。Cordova 插件 lycwed-cordova-plugin-clipboard 提供了实现这些功能的解决方案。

    3 年前
  • npm包 kofi-body 使用教程

    在前端开发中,经常需要对页面进行布局,而布局又需要用到各种不同的HTML元素。kofi-body就是一个方便的npm包,可以帮助我们快速构建HTML页面的布局。 kofi-body简介 kofi-bo...

    3 年前
  • npm 包 nuxt-base 使用教程

    什么是 nuxt-base nuxt-base 是一个基于 nuxt.js 的前端脚手架,它提供了一个现代化,结构合理的前端项目基础架构,帮助开发者快速搭建基于 Vue.js 的 Web 应用程序。

    3 年前
  • npm 包 abtest-util 使用教程

    一、前言 在大型 Web 应用开发中,我们经常需要进行 A/B 测试,以了解用户喜好,优化页面设计或功能等。而在实现 A/B 测试时,我们通常需要使用到一些工具。其中,npm 包 abtest-uti...

    3 年前

相关推荐

    暂无文章