egg-multipart
Use co-busboy to upload file by streaming and
process it without save to disk(using the stream
mode).
Just use ctx.multipart()
to got file stream, then pass to image processing liberary such as gm
or upload to cloud storage such as oss
.
Whitelist of file extensions
For security, if uploading file extension is not in white list, will response as 400 Bad request
.
Default Whitelist:
const whitelist = [
'.jpg', '.jpeg',
'.png',
'.gif',
'.bmp',
'.wbmp',
'.webp',
'.tif',
'.psd',
'.svg',
'.js', '.jsx',
'.json',
'.css', '.less',
'.html', '.htm',
'.xml',
'.zip',
'.gz', '.tgz', '.gzip',
'.mp3',
'.mp4',
'.avi',
];
fileSize
The default fileSize that multipart can accept is 10mb
. if you upload a large file, you should specify this config.
exports.multipart = {
fileSize: '50mb',
};
Custom Config
Developer can custom additional file extensions:
exports.multipart = {
fileExtensions: [
'.foo',
'.apk',
],
};
Can also override built-in whitelist, such as only allow png:
exports.multipart = {
whitelist: [
'.png',
],
};
Or by function:
exports.multipart = {
whitelist: (filename) => [ '.png' ].includes(path.extname(filename) || '')
};
Note: if define whitelist
, then fileExtensions
will be ignored.
Examples
More examples please follow:
file
mode: the easy way
If you don't know the Node.js Stream work, maybe you should use the file
mode to get started.
The usage very similar to bodyParser.
ctx.request.body
: Get all the multipart fields and values, except file
.ctx.request.files
: Contains all file
from the multipart request, it's an Array object.
WARNING: you should remove the temporary upload files after you use it,
the async ctx.cleanupRequestFiles()
method will be very helpful.
Enable file
mode on config
You need to set config.multipart.mode = 'file'
to enable file
mode:
exports.multipart = {
mode: 'file',
};
After file
mode enable, egg will remove the old temporary files(don't include today's files) on 04:30 AM
every day by default.
config.multipart = {
mode: 'file',
tmpdir: path.join(os.tmpdir(), 'egg-multipart-tmp', appInfo.name),
cleanSchedule: {
cron: '0 30 4 * * *',
disable: false,
},
};
Default will use the last field which has same name, if need the all fields value, please set allowArrayField
in config.
exports.multipart = {
mode: 'file',
allowArrayField: true,
};
Upload One File
<form method="POST" action="/upload?_csrf={{ ctx.csrf | safe }}" enctype="multipart/form-data">
title: <input name="title" />
file: <input name="file" type="file" />
<button type="submit">Upload</button>
</form>
Controller which hanlder POST /upload
:
const Controller = require('egg').Controller;
const fs = require('mz/fs');
module.exports = class extends Controller {
async upload() {
const { ctx } = this;
const file = ctx.request.files[0];
const name = 'egg-multipart-test/' + path.basename(file.filename);
let result;
try {
result = await ctx.oss.put(name, file.filepath);
} finally {
ctx.cleanupRequestFiles();
}
ctx.body = {
url: result.url,
requestBody: ctx.request.body,
};
}
};
Upload Multiple Files
<form method="POST" action="/upload?_csrf={{ ctx.csrf | safe }}" enctype="multipart/form-data">
title: <input name="title" />
file1: <input name="file1" type="file" />
file2: <input name="file2" type="file" />
<button type="submit">Upload</button>
</form>
Controller which hanlder POST /upload
:
const Controller = require('egg').Controller;
const fs = require('mz/fs');
module.exports = class extends Controller {
async upload() {
const { ctx } = this;
console.log(ctx.request.body);
console.log('got %d files', ctx.request.files.length);
for (const file of ctx.request.files) {
console.log('field: ' + file.fieldname);
console.log('filename: ' + file.filename);
console.log('encoding: ' + file.encoding);
console.log('mime: ' + file.mime);
console.log('tmp filepath: ' + file.filepath);
let result;
try {
result = await ctx.oss.put('egg-multipart-test/' + file.filename, file.filepath);
} finally {
ctx.cleanupRequestFiles([ file ]);
}
console.log(result);
}
}
};
stream
mode: the hard way
If you're well-known about know the Node.js Stream work, you should use the stream
mode.
Use with for await...of
<form method="POST" action="/upload?_csrf={{ ctx.csrf | safe }}" enctype="multipart/form-data">
title: <input name="title" />
file1: <input name="file1" type="file" />
file2: <input name="file2" type="file" />
<button type="submit">Upload</button>
</form>
Controller which hanlder POST /upload
:
const { Controller } = require('egg');
const fs = require('fs');
const stream = require('stream');
const util = require('util');
const { randomUUID } = require('crypto');
const pipeline = util.promisify(stream.pipeline);
module.exports = class UploadController extends Controller {
async upload() {
const parts = this.ctx.multipart();
const fields = {};
const files = {};
for await (const part of parts) {
if (Array.isArray(part)) {
console.log('field: ' + part[0]);
console.log('value: ' + part[1]);
} else {
const { filename, fieldname, encoding, mime } = part;
console.log('field: ' + fieldname);
console.log('filename: ' + filename);
console.log('encoding: ' + encoding);
console.log('mime: ' + mime);
const targetPath = path.join(os.tmpdir(), randomUUID() + path.extname(filename));
await pipeline(part, createWriteStream(targetPath));
}
}
this.ctx.body = 'ok';
}
};
Upload One File (DEPRECATED)
You can got upload stream by ctx.getFileStream*()
.
<form method="POST" action="/upload?_csrf={{ ctx.csrf | safe }}" enctype="multipart/form-data">
title: <input name="title" />
file: <input name="file" type="file" />
<button type="submit">Upload</button>
</form>
Controller which handler POST /upload
:
const path = require('path');
const sendToWormhole = require('stream-wormhole');
const Controller = require('egg').Controller;
module.exports = class extends Controller {
async upload() {
const { ctx } = this;
const stream = await ctx.getFileStream();
const name = 'egg-multipart-test/' + path.basename(stream.filename);
const result = await ctx.oss.put(name, stream);
ctx.body = {
url: result.url,
fields: stream.fields,
};
}
async uploadNotRequiredFile() {
const { ctx } = this;
const stream = await ctx.getFileStream({ requireFile: false });
let result;
if (stream.filename) {
const name = 'egg-multipart-test/' + path.basename(stream.filename);
const result = await ctx.oss.put(name, stream);
} else {
await sendToWormhole(stream);
}
ctx.body = {
url: result && result.url,
fields: stream.fields,
};
}
};
Upload Multiple Files (DEPRECATED)
<form method="POST" action="/upload?_csrf={{ ctx.csrf | safe }}" enctype="multipart/form-data">
title: <input name="title" />
file1: <input name="file1" type="file" />
file2: <input name="file2" type="file" />
<button type="submit">Upload</button>
</form>
Controller which hanlder POST /upload
:
const Controller = require('egg').Controller;
module.exports = class extends Controller {
async upload() {
const { ctx } = this;
const parts = ctx.multipart();
let part;
while ((part = await parts()) != null) {
if (part.length) {
console.log('field: ' + part[0]);
console.log('value: ' + part[1]);
console.log('valueTruncated: ' + part[2]);
console.log('fieldnameTruncated: ' + part[3]);
} else {
if (!part.filename) {
continue;
}
console.log('field: ' + part.fieldname);
console.log('filename: ' + part.filename);
console.log('encoding: ' + part.encoding);
console.log('mime: ' + part.mime);
const result = await ctx.oss.put('egg-multipart-test/' + part.filename, part);
console.log(result);
}
}
console.log('and we are done parsing the form!');
}
};
Support file
and stream
mode in the same time
If the default mode
is stream
, use the fileModeMatch
options to match the request urls switch to file
mode.
config.multipart = {
mode: 'stream',
fileModeMatch: /^\/upload_file$/,
};
NOTICE: fileModeMatch
options only work on stream
mode.
License
MIT