@spatie/attachment-uploader 是一个帮助开发者将文件上传到云存储并返回一个 URL 的 npm 包。它支持多种云存储服务，如 AWS S3, Google Cloud Storage, Azure Blob Storage, Digital Ocean Spaces 等。本文将详细介绍如何使用该包进行文件上传，并针对一些常见问题给出解决方案。
安装
使用 npm 进行安装：
npm install @spatie/attachment-uploader
基本用法
初始化
使用 require 引入 @spatie/attachment-uploader：
const uploader = require('@spatie/attachment-uploader');初始化上传组件：
const upload = uploader({
key: 'MY_KEY',
secret: 'MY_SECRET',
region: 'MY_REGION',
bucket: 'MY_BUCKET'
});在 options 中填写你云存储的相关信息，其中 key 和 secret 是你在云存储服务商的授权账户，region 和 bucket 分别代表在哪个地区和哪个存储桶中进行上传。
上传文件
const file = 'path/to/local/upload/file.png';
upload(file).then(result => {
console.log(result);
}).catch(error => {
console.error(error);
});在上传过程中，@spatie/attachment-uploader 会自动判断文件大小以及文件类型，并上传至云存储服务。同时，上传成功后会返回包含云存储的路径和 URL 等相关信息的对象 result，你可以根据需要进行相应的操作。
删除文件
const url = 'https://MY_BUCKET.s3.MY_REGION.amazonaws.com/images/file.png';
upload.deleteFile(url).then(result => {
console.log(result);
}).catch(error => {
console.error(error);
});删除文件将之前上传的文件路径作为参数进行传递，@spatie/attachment-uploader 会自动判断文件是否存在于云存储，并返回相应的信息。
更多用法
带有选项的初始化
初始化时第二个参数可以传入上传选项，包括限制文件大小、限制文件类型、限制文件数量等等。例如：
-- -------------------- ---- -------
----- ------- - -
---------------- ------
----------- ------- ------- ------ -------
------ -
--
----- ------ - ----------
---- ---------
------- ------------
------- ------------
------- -----------
-- ---------注意，以上设置中，file_size_limit 和 file_types 选项只对上传单一文件和多文件队列上传有作用，而 limit 选项只对多文件队列上传有作用。
多文件上传
-- -------------------- ---- -------
----- ----- - -
------ ----------------------------------
------ ---------------------------------
--
------------------------- -- -
--------------------
-------------- -- -
---------------------
---在多文件上传时，可以将需要上传的文件按需求打包成数组进行传递。
自定义文件名
如果你需要自定义上传至云存储的文件名，只需将文件名作为第二个参数传递至上传函数：
const file = 'path/to/local/upload/file.jpg';
const customName = 'my_custom_name.jpg';
upload(file, customName).then(result => {
console.log(result);
}).catch(error => {
console.error(error);
});限制单个文件大小
通过 file_size_limit 选项可以限制单个上传文件的大小。默认为不限制，如需限制，可以将值设置为一个数字加上单位（如"1MB"）。如果上传文件超过了限制大小，将会抛出一个错误。
-- -------------------- ---- -------
----- ------- - -
---------------- -----
--
----- ------ - ----------
---- ---------
------- ------------
------- ------------
------- -----------
-- ---------限制上传文件类型
通过 file_types 选项可以限制上传的文件类型。默认情况下，@spatie/attachment-uploader 不限制上传的文件类型，即允许上传任何类型的文件。如果你只想允许上传某些类型的文件，可以在 file_types 选项中列出这些类型。
-- -------------------- ---- -------
----- ------- - -
----------- ------- ------ ------
--
----- ------ - ----------
---- ---------
------- ------------
------- ------------
------- -----------
-- ---------限制上传文件数量
如果你需要限制上传文件数量，可以通过 limit 选项设置限制的数量。当上传文件的数量超过了限制数量，将会抛出一个错误。
-- -------------------- ---- -------
----- ------- - -
------ --
--
----- ------ - ----------
---- ---------
------- ------------
------- ------------
------- -----------
-- ---------示例代码
下面是一个上传文件到 AWS S3 的完整示例代码：
-- -------------------- ---- -------
----- -------- - ---------------------------------------
----- ------- - -
---------------- ------
----------- ------- ------- ------ ------
--
----- ------ - ----------
---- ---------
------- ------------
------- ------------
------- -----------
-- ---------
----- ---- - --------------------------------
------------------------ -- -
--------------------
-------------- -- -
---------------------
---总结
@spatie/attachment-uploader 是一个简单而又实用的文件上传到云存储的 npm 包，它使得开发者可以轻松地上传和删除文件，并且支持多种云存储，非常适合用于前端开发中。
通过学习本文，相信大家已经可以初步了解如何使用这个包，并具备了解决遇到问题的能力。希望本文能够为你的开发工作提供帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005568a81e8991b448d3524