介绍
open-oss 是一款用于上传文件到阿里云 OSS 的 npm 包，在前端开发中经常用到。该包支持上传文件夹和文件，并提供了多样化的参数配置，使用简单方便。本教程将详细介绍 open-oss 的安装、配置以及使用方法，并提供代码示例。
安装
要安装 open-oss，在终端中输入以下命令：
npm install open-oss
配置
在使用 open-oss 包时，需要配置一些信息，这些信息包括阿里云 ACCESS_KEY_ID、ACCESS_KEY_SECRET、BUCKET_NAME 和 OSS_REGION。可以通过以下方法配置：
- 在代码中直接写入配置
const config = {
accessKeyId: 'your_access_key_id',
accessKeySecret: 'your_access_key_secret',
bucket: 'your_bucket_name',
region: 'your_region'
}- 把配置写入一个配置文件，比如 .env 文件
ACCESS_KEY_ID=your_access_key_id ACCESS_KEY_SECRET=your_access_key_secret BUCKET_NAME=your_bucket_name OSS_REGION=your_region
- 使用命令行参数传递配置参数
open-oss --accessKeyId=your_access_key_id --accessKeySecret=your_access_key_secret --bucket=your_bucket_name --region=your_region
使用方法
使用 open-oss 上传一个文件或者文件夹非常简单，以下是一个简单的上传文件的示例：
-- -------------------- ---- -------
----- ----------- - --------------------
----- ---- - ----------------
----- -------- - --- --------------
-----------------
---------- -------------------- ------------
----------- --------------
---------- -- -
------------------- -----------
------------ -- -
--------------------- ------ ---
---以上代码首先引入 open-oss 和 path 两个模块，然后创建一个 OSSUploader 的实例，并且使用 upload() 方法上传了一个本地文件到 OSS 的一个指定的目录上。在上传成功后，控制台将会打印出 "upload success!"，如果上传失败，则会输出错误信息。
也可以使用以下方法上传文件夹：
-- -------------------- ---- -------
-- --------------
-----------------
---------- -------------------- --------
----------- -----------
-------- ------------- ----------------
---------- -- -
------------------- -----------
------------ -- -
--------------------- ------ ---
---通过设置 exclude 参数可以过滤掉指定的文件或文件夹，可以通过数组的形式传入。
-- -------------------- ---- -------
-- --------- ---- --- ------ ---
-----------------
---------- -------------------- -------
----------- ---------
-------- ----------
---------- -- -
------------------- -----------
------------ -- -
--------------------- ------ ---
---通过设置 include 参数，指定上传哪些文件。
除了上述示例中介绍的方法和参数，open-oss 还支持更多的功能和参数，包括：
- maxAge：设置缓存时间，单位为秒。
- headers：设置额外的请求头。
- limitSpeed：限制上传速度。
- multipartUploadThreshold：设置文件上传块的大小。
- parallel:设置文件并发上传的数量。
具体使用方法可以参考官方文档。
总结
本文对 open-oss 这个常用的 npm 包进行了详细的介绍和使用教程，并提供了代码示例以及参数说明。希望本文能够帮助开发者更好地使用 open-oss 去上传文件，提高前端开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600556c381e8991b448d3954