koa-body 使用教程

本系列是我的常用 koa 中间件使用笔记，防止忘记使用方法而作记录

koa-body 是一个可以帮助解析 http 中 body 的部分的中间件，包括 json、表单、文本、文件等。

 

基本使用

const Koa = require('koa');     // 引入koa
const app = new Koa();      // 创建koa应用
const koaBody = require('koa-body');    //引入koa-body

app.use(
    koaBody({
        multipart: true,    //解析多个文件
        formidable: {
            maxFileSize: 100 * 1024 * 1024,    // 设置上传文件大小最大限制，默认2M
            //uploadDir: 可以填写一个路径，不填写默认为 os.tmpDir()
        }
    })
)

app.use(async (ctx, next) => {
    let file1 = ctx.request.files.file1;     //其中files后是 form-data的key值
    //file1中有这个文件的信息
})

app.listen(3000);

 

 获得内容

要获得文件内容使用 ctx.request.files，获得表单内容使用 ctx.request.body。

 

其他参数

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

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){}