前言
在开发 web 应用时,文件上传功能是一个不可或缺的部分。传统的文件上传会将文件保存在服务器的本地磁盘上,但是这种方式存在一些问题,例如磁盘空间不足、服务器处理大量文件的效率低等。近年来,越来越多的应用开始使用 Amazon S3 来存储文件,因为它具有可靠性高、无限的存储空间、高可扩展性等优点。
为了方便使用 Amazon S3 来存储上传的文件,有一些第三方工具出现了。本文将讲解如何使用 npm 包 @come25136/multer-s3 来实现文件上传到 Amazon S3 的功能。
@come25136/multer-s3 简介
@come25136/multer-s3 是一个用于上传文件到 Amazon S3 的 multer 存储引擎。Multer 是一个 Node.js 中间件,用于处理文件上传,它基于 busboy 构建,可以同时处理多个文件上传,并支持多种存储引擎。
下面分别介绍 multer 和 Amazon S3 的相关概念。
Multer
Multer 是一个处理 Express 中间件的库,用于处理 HTTP POST 请求中的多部分数据,也就是文件上传。Multer 好比通过浏览器上传文件时,选择文件时的那个文件选择框,只不过是通过 Node.js 发送请求,将文件上传到服务器端。
Multer 的使用十分简单,只需在 Express 实例中使用 multer()
函数即可。示例代码如下:
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ------ - ----------------- ----- --- - --------- ----- ------ - -------- ------------------- ---------------------- ----- ---- -- - ----- ---- - -------- -- ------- --
上述代码中,upload.single('file')
表示要上传一个文件,文件的字段名为 file
。在请求处理函数中,可以通过 req.file
来获取上传的文件信息。
Amazon S3
Amazon S3 是一个 Amazon Web Services (AWS) 提供的面向对象存储平台,这一服务可以被用于存储和检索任意类型的数据,任意大小的对象。它是一个定位、连接和保护 Internet 内容的存储库,让开发者可以方便地存储和提取任意数量的数据,无需担心网络和存储资源的扩展问题。
Amazon S3 提供了许多不同的配置选项,这使得开发者可以根据自己的需要来调整它们的存储解决方案。
使用 @come25136/multer-s3 上传文件
下面将介绍如何使用 @come25136/multer-s3 来上传文件到 Amazon S3。
步骤 1:安装 @come25136/multer-s3
npm install @come25136/multer-s3
步骤 2:引入依赖
const aws = require('aws-sdk') const multer = require('multer') const multerS3 = require('@come25136/multer-s3')
步骤 3:配置 AWS SDK
aws.config.update({ secretAccessKey: 'your_secret_access_key', accessKeyId: 'your_access_key_id', sessionToken: 'your_session_token', // 可选 region: 'your_aws_region' })
注:以上值可在 AWS IAM 控制台中的安全凭证页面找到。
步骤 4:配置 multer 和 multer-s3
-- -------------------- ---- ------- ----- -- - --- -------- -- ------- -- -- ----- ------ - -------- -------- ---------- --- --- ------- ------------------ ---- -------------- -- ------ ------- --------- -------- ----- ----- --- - -------- - ---------- -------------- -- -- ---- -------- ----- ----- --- - -------- ---------------------- - -- --
上述代码中,s3
对象为 AWS SDK 的 S3 类,bucket
为上传的目标存储桶名。
其他配置项说明:
acl
:一个字符串,默认为private
,表示上传的文件的权限。metadata
:一个函数,用于设置文件的元数据。文件的 field 名称可以在fieldname
属性中获取。key
:一个函数,用于设置文件的名称。默认使用 Date.now()。
步骤 5:使用 multer 中间件
app.post('/upload', upload.single('file'), (req, res) => { const file = req.file // 处理上传的文件 })
上述代码中,upload.single('file')
指示 Multer 上传单个文件,文件的字段名为 file
。
完整示例
-- -------------------- ---- ------- ----- --- - ------------------ ----- ------- - ------------------ ----- ------ - ----------------- ----- -------- - ------------------------------- ------------------- ---------------- ------------------------- ------------ --------------------- ------------- --------------------- ------- ----------------- -- ----- --- - --------- ----- -- - --- -------- ----- ------ - -------- -------- ---------- --- --- ------- ------------------ ---- -------------- --------- -------- ----- ----- --- - -------- - ---------- -------------- -- -- ---- -------- ----- ----- --- - -------- ---------------------- - -- -- ------------------- ---------------------- ----- ---- -- - ----- ---- - -------- ---------- ---- -- --
结语
本文介绍了如何使用 npm 包 @come25136/multer-s3 来上传文件到 Amazon S3。在实际开发中,可以根据需要修改配置项,以适应不同的业务场景。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005670a81e8991b448e34a6