koa-body koa2 使用 koa-body 代替 koa-bodyparser 和 koa-multer

koa2 使用 koa-body 代替 koa-bodyparser 和 koa-multer

评论：7 · 阅读：22543· 喜欢：7

一、需求

之前使用 koa2 的时候，处理 post 请求使用的是 koa-bodyparser，同时如果是图片上传使用的是 koa-multer。

这两者的组合没什么问题，不过 koa-multer 和 koa-route（注意不是 koa-router）存在不兼容的问题。

这个问题已经在这篇文章中说明了：

使用koa-multer实现文件上传并自定义文件名和目录

关于 koa-bodyparser 的使用，见下面文章：

手动实现koa2 body-parser中间件及koa-boayparser的使用

但是这两者可以通过 koa-body 代替，并且只是用 koa-body 即可。

koa-body 主要是下面两个依赖：

"co-body": "^5.1.1",
"formidable": "^1.1.1"

具体的实现可以在 github 上查看： https://github.com/dlau/koa-body

二、`koa-body` 的基本使用

在 koa2 中使用 koa-body,我使用的是全局引入，而不是路由级别的引入，因为考虑到很多地方都有 post 请求或者是文件上传请求，没必要只在路由级别引入。

1、安装依赖

yarn add koa-body
## npm i koa-body -S

2、app.js

省略了 koa 的一些基本代码

const koaBody = require('koa-body');
const app = new koa();
app.use(koaBody({
  multipart:true, // 支持文件上传
  encoding:'gzip',
  formidable:{
    uploadDir:path.join(__dirname,'public/upload/'), // 设置文件上传目录
    keepExtensions: true,    // 保持文件的后缀
    maxFieldsSize:2 * 1024 * 1024, // 文件上传大小
    onFileBegin:(name,file) => { // 文件上传前的设置
      // console.log(`name: ${name}`);
      // console.log(file);
    },
  }
}));

3、有用的参数

1）koa-body 的基本参数

参数名	描述	类型	默认值
patchNode	将请求体打到原生 node.js 的`ctx.req`中	Boolean	`false`
patchKoa	将请求体打到 koa 的 `ctx.request` 中	Boolean	`true`
jsonLimit	JSON 数据体的大小限制	String / Integer	`1mb`
formLimit	限制表单请求体的大小	String / Integer	`56kb`
textLimit	限制 text body 的大小	String / Integer	`56kb`
encoding	表单的默认编码	String	`utf-8`
multipart	是否支持 `multipart-formdate` 的表单	Boolean	`false`
urlencoded	是否支持 `urlencoded` 的表单	Boolean	`true`
text	是否解析 `text/plain` 的表单	Boolean	`true`
json	是否解析 `json` 请求体	Boolean	`true`
jsonStrict	是否使用 json 严格模式，`true` 会只处理数组和对象	Boolean	`true`
formidable	配置更多的关于 `multipart` 的选项	Object	`{}`
onError	错误处理	Function	`function(){}`
stict	严格模式,启用后不会解析 `GET, HEAD, DELETE` 请求	Boolean	`true`

2）formidable 的相关配置参数

参数名	描述	类型	默认值
maxFields	限制字段的数量	Integer	`1000`
maxFieldsSize	限制字段的最大大小	Integer	`2 * 1024 * 1024`
uploadDir	文件上传的文件夹	String	`os.tmpDir()`
keepExtensions	保留原来的文件后缀	Boolean	`false`
hash	如果要计算文件的 hash，则可以选择 `md5/sha1`	String	`false`
multipart	是否支持多文件上传	Boolean	`true`
onFileBegin	文件上传前的一些设置操作	Function	`function(name,file){}`

关于 onFileBegin 的更多信息可以查看：

https://github.com/felixge/node-formidable#filebegin

4、获取文件上传后的信息

这些代码是在路由中体现的

需要注意的是，如果是获取上传后文件的信息，则需要在 ctx.request.files 中获取。

如果是获取其他的表单字段，则需要在 ctx.request.body 中获取，这是由 co-body 决定的（默认情况）。

router.get('/', async (ctx) => {
  await ctx.render('index');
});

router.post('/',async (ctx)=>{
  console.log(ctx.request.files);
  console.log(ctx.request.body);
  ctx.body = JSON.stringify(ctx.request.files);
});