# UP2OSS

**Repository Path**: juuen/UP2OSS

## Basic Information

- **Project Name**: UP2OSS
- **Description**: 一个灵巧、快捷和方便的 oss 上传组件
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://gitee.com/juuen/UP2OSS
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-06-03
- **Last Updated**: 2025-12-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Nodejs, alioss, Express

## README

# UP2OSS

一个灵巧、快捷和方便的 oss 上传中间件

## 安装

```bash
npm install up2oss
```

## 使用

### 初始化配置

EXPRESS 项目推荐使用 app.js 配置，示例如下：

```js
const { UP2OSS } = require("up2oss");
const up2oss = new UP2OSS({
	accessKeyId: "your accessKeyId",
	accessKeySecret: "your accessKeySecret",
	bucket: "your bucket",
	region: "your region"
});

// 全局路由
app.use(up2oss.upload);

// 指定路由
app.use("/upload", up2oss.upload);
```

### 获取 OSS 上传结果

通过路由回调函数参数 req 获取相应结果。

#### 参数说明：

1. req.attachments: 上传文件列表
1. req.fields: 上传字段列表

| 对象        | 字段    | 描述         |
| ----------- | ------- | ------------ |
| attachments | name    | 文件名       |
| attachments | size    | 文件大小     |
| attachments | url     | OSS 文件地址 |
| fields      | name    | 字段名       |
| fields      | content | 字段值       |

#### 示例：

```js
router.post("/api/upload", (req, res) => {
	console.log("upload info: ", {
		attachments: req.attachments,
		fields: req.fields
	});
	res.end("upload successfully");
});
```

### 其他说明

- 如何自定义文件夹？

  1. 通过参数 `path` 设置，默认为 bucket 根目录。
  1. 初始化配置设置是全局属性，所有上传路由均生效。
  1. FORM 表单设置是局部属性，仅当前路由生效。
  1. 两者同时设置时优先级：表单参数 > 初始化参数

- 如何设置文件是否覆盖？

  1.  通过参数 `ow` 设置，默认为 false
  1.  设置方法与 `path`设置相似 。