Multer中文文档

ゝ一纸荒年。 2023-07-17 12:39 3阅读 0赞

**此文档于2016年10月3日翻译时multer的版本是1.2.0，它可能不是最新的！** **甚至可能存在翻译错误！你可能需要阅读原版英语[README][]** **此文档仅供参考！**

# Multer    #

Multer 是一个 node.js 中间件，用于处理 `multipart/form-data` 类型的表单数据，它主要用于上传文件。它是写在 [busboy][] 之上非常高效。

**注意**: Multer 不会处理任何非 `multipart/form-data` 类型的表单数据。

## 其它语言 ##

*  [English][README] (英语)
 *  [한국어][Link 1] (朝鲜语)
 *  [Русский язык][Link 2] (俄語)

## 安装 ##

$ npm install --save multer

## 使用 ##

Multer 会添加一个 `body` 对象 以及 `file` 或 `files` 对象 到 express 的 `request` 对象中。 `body` 对象包含表单的文本域信息，`file` 或 `files` 对象包含对象表单上传的文件信息。

基本使用方法:

var express = require('express')
    var multer  = require('multer')
    var upload = multer({ dest: 'uploads/' })
    
    var app = express()
    
    app.post('/profile', upload.single('avatar'), function (req, res, next) {
      // req.file 是 `avatar` 文件的信息
      // req.body 将具有文本域数据，如果存在的话
    })
    
    app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
      // req.files 是 `photos` 文件数组的信息
      // req.body 将具有文本域数据，如果存在的话
    })
    
    var cpUpload = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
    app.post('/cool-profile', cpUpload, function (req, res, next) {
      // req.files 是一个对象 (String -> Array) 键是文件名，值是文件数组
      //
      // 例如：
      //  req.files['avatar'][0] -> File
      //  req.files['gallery'] -> Array
      //
      // req.body 将具有文本域数据，如果存在的话
    })

如果你需要处理一个只有文本域的表单，你应当使用 `.none()`:

var express = require('express')
    var app = express()
    var multer  = require('multer')
    var upload = multer()
    
    app.post('/profile', upload.none(), function (req, res, next) {
      // req.body 包含文本域
    })

## API ##

### 文件信息 ###

每个文件具有下面的信息:

<table> 
 <thead> 
  <tr> 
   <th>Key</th> 
   <th>Description</th> 
   <th>Note</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>fieldname</code></td> 
   <td>Field name 由表单指定</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>originalname</code></td> 
   <td>用户计算机上的文件的名称</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>encoding</code></td> 
   <td>文件编码</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>mimetype</code></td> 
   <td>文件的 MIME 类型</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>size</code></td> 
   <td>文件大小（字节单位）</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td><code>destination</code></td> 
   <td>保存路径</td> 
   <td><code>DiskStorage</code></td> 
  </tr> 
  <tr> 
   <td><code>filename</code></td> 
   <td>保存在&nbsp;<code>destination</code>&nbsp;中的文件名</td> 
   <td><code>DiskStorage</code></td> 
  </tr> 
  <tr> 
   <td><code>path</code></td> 
   <td>已上传文件的完整路径</td> 
   <td><code>DiskStorage</code></td> 
  </tr> 
  <tr> 
   <td><code>buffer</code></td> 
   <td>一个存放了整个文件的&nbsp;<code>Buffer</code></td> 
   <td><code>MemoryStorage</code></td> 
  </tr> 
 </tbody> 
</table>

### `multer(opts)` ###

Multer 接受一个 options 对象，其中最基本的是 `dest` 属性，这将告诉 Multer 将上传文件保存在哪。如果你省略 options 对象，这些文件将保存在内存中，永远不会写入磁盘。

为了避免命名冲突，Multer 会修改上传的文件名。这个重命名功能可以根据您的需要定制。

以下是可以传递给 Multer 的选项。

<table> 
 <thead> 
  <tr> 
   <th>Key</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>dest</code>&nbsp;or&nbsp;<code>storage</code></td> 
   <td>在哪里存储文件</td> 
  </tr> 
  <tr> 
   <td><code>fileFilter</code></td> 
   <td>文件过滤器，控制哪些文件可以被接受</td> 
  </tr> 
  <tr> 
   <td><code>limits</code></td> 
   <td>限制上传的数据</td> 
  </tr> 
  <tr> 
   <td><code>preservePath</code></td> 
   <td>保存包含文件名的完整文件路径</td> 
  </tr> 
 </tbody> 
</table>

通常，一般的网页应用，只需要设置 `dest` 属性，像这样：

var upload = multer({ dest: 'uploads/' })

如果你想在上传时进行更多的控制，你可以使用 `storage` 选项替代 `dest`。Multer 具有 `DiskStorage` 和 `MemoryStorage` 两个存储引擎；另外还可以从第三方获得更多可用的引擎。

`.single(fieldname)`

接受一个以 `fieldname` 命名的文件。这个文件的信息保存在 `req.file`。

`.array(fieldname[, maxCount])`

接受一个以 `fieldname` 命名的文件数组。可以配置 `maxCount` 来限制上传的最大数量。这些文件的信息保存在 `req.files`。

`.fields(fields)`

接受指定 `fields` 的混合文件。这些文件的信息保存在 `req.files`。

`fields` 应该是一个对象数组，应该具有 `name` 和可选的 `maxCount` 属性。

Example:

[
      { name: 'avatar', maxCount: 1 },
      { name: 'gallery', maxCount: 8 }
    ]

`.none()`

只接受文本域。如果任何文件上传到这个模式，将发生 "LIMIT\_UNEXPECTED\_FILE" 错误。这和 `upload.fields([])` 的效果一样。

`.any()`

接受一切上传的文件。文件数组将保存在 `req.files`。

**警告:** 确保你总是处理了用户的文件上传。 永远不要将 multer 作为全局中间件使用，因为恶意用户可以上传文件到一个你没有预料到的路由，应该只在你需要处理上传文件的路由上使用。

### `storage` ###

磁盘存储引擎 (`DiskStorage`)

磁盘存储引擎可以让你控制文件的存储。

var storage = multer.diskStorage({
      destination: function (req, file, cb) {
        cb(null, '/tmp/my-uploads')
      },
      filename: function (req, file, cb) {
        cb(null, file.fieldname + '-' + Date.now())
      }
    })
    
    var upload = multer({ storage: storage })

有两个选项可用，`destination` 和 `filename`。他们都是用来确定文件存储位置的函数。

`destination` 是用来确定上传的文件应该存储在哪个文件夹中。也可以提供一个 `string` (例如 `'/tmp/uploads'`)。如果没有设置 `destination`，则使用操作系统默认的临时文件夹。

**注意:** 如果你提供的 `destination` 是一个函数，你需要负责创建文件夹。当提供一个字符串，multer 将确保这个文件夹是你创建的。

`filename` 用于确定文件夹中的文件名的确定。 如果没有设置 `filename`，每个文件将设置为一个随机文件名，并且是没有扩展名的。

**注意:** Multer 不会为你添加任何扩展名，你的程序应该返回一个完整的文件名。

每个函数都传递了请求对象 (`req`) 和一些关于这个文件的信息 (`file`)，有助于你的决定。

注意 `req.body` 可能还没有完全填充，这取决于向客户端发送字段和文件到服务器的顺序。

内存存储引擎 (`MemoryStorage`)

内存存储引擎将文件存储在内存中的 `Buffer` 对象，它没有任何选项。

var storage = multer.memoryStorage()
    var upload = multer({ storage: storage })

当使用内存存储引擎，文件信息将包含一个 `buffer` 字段，里面包含了整个文件数据。

**警告**: 当你使用内存存储，上传非常大的文件，或者非常多的小文件，会导致你的应用程序内存溢出。

### `limits` ###

一个对象，指定一些数据大小的限制。Multer 通过这个对象使用 busboy，详细的特性可以在 [busboy's page][busboy_s page] 找到。

可以使用下面这些:

<table> 
 <thead> 
  <tr> 
   <th>Key</th> 
   <th>Description</th> 
   <th>Default</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>fieldNameSize</code></td> 
   <td>field 名字最大长度</td> 
   <td>100 bytes</td> 
  </tr> 
  <tr> 
   <td><code>fieldSize</code></td> 
   <td>field 值的最大长度</td> 
   <td>1MB</td> 
  </tr> 
  <tr> 
   <td><code>fields</code></td> 
   <td>非文件 field 的最大数量</td> 
   <td>无限</td> 
  </tr> 
  <tr> 
   <td><code>fileSize</code></td> 
   <td>在 multipart 表单中，文件最大长度 (字节单位)</td> 
   <td>无限</td> 
  </tr> 
  <tr> 
   <td><code>files</code></td> 
   <td>在 multipart 表单中，文件最大数量</td> 
   <td>无限</td> 
  </tr> 
  <tr> 
   <td><code>parts</code></td> 
   <td>在 multipart 表单中，part 传输的最大数量(fields + files)</td> 
   <td>无限</td> 
  </tr> 
  <tr> 
   <td><code>headerPairs</code></td> 
   <td>在 multipart 表单中，键值对最大组数</td> 
   <td>2000</td> 
  </tr> 
 </tbody> 
</table>

设置 limits 可以帮助保护你的站点抵御拒绝服务 (DoS) 攻击。

### `fileFilter` ###

设置一个函数来控制什么文件可以上传以及什么文件应该跳过，这个函数应该看起来像这样：

function fileFilter (req, file, cb) {
    
      // 这个函数应该调用 `cb` 用boolean值来
      // 指示是否应接受该文件
    
      // 拒绝这个文件，使用`false`，像这样:
      cb(null, false)
    
      // 接受这个文件，使用`true`，像这样:
      cb(null, true)
    
      // 如果有问题，你可以总是这样发送一个错误:
      cb(new Error('I don\'t have a clue!'))
    
    }

## 错误处理机制 ##

当遇到一个错误，multer 将会把错误发送给 express。你可以使用一个比较好的错误展示页 ([express标准方式][express])。

如果你想捕捉 multer 发出的错误，你可以自己调用中间件程序。如果你想捕捉 [Multer 错误][Multer]，你可以使用 `multer` 对象下的 `MulterError` 类 (即 `err instanceof multer.MulterError`)。

var multer = require('multer')
    var upload = multer().single('avatar')
    
    app.post('/profile', function (req, res) {
      upload(req, res, function (err) {
        if (err instanceof multer.MulterError) {
          // 发生错误
        } else if (err) {
          // 发生错误
        }
    
        // 一切都好
      })
    })

## 定制存储引擎 ##

如果你想要构建自己的存储引擎，请看 [这里][Link 3] 。

[README]: https://github.com/expressjs/multer/blob/master/README.md
[busboy]: https://github.com/mscdex/busboy
[Link 1]: https://github.com/expressjs/multer/blob/master/doc/README-ko.md
[Link 2]: https://github.com/expressjs/multer/blob/master/doc/README-ru.md
[busboy_s page]: https://github.com/mscdex/busboy#busboy-methods
[express]: http://expressjs.com/guide/error-handling.html
[Multer]: https://github.com/expressjs/multer/blob/master/lib/multer-error.js
[Link 3]: https://github.com/expressjs/multer/blob/master/StorageEngine.md