egg-multipart是一个处理文件上传的插件，下面我根据自己理解分析下这个插件源码。
egg默认配置egg-multipart，在app.js会调用中间件处理，注意这是是讲插件的file模式
// src/app.js
app.coreLogger.info('[egg-multipart] will save temporary files to %j, cleanup job cron: %j',
options.tmpdir, options.cleanSchedule.cron);
// enable multipart middleware
app.config.coreMiddleware.push('multipart');
上面就是导入egg-multipart的入口代码，他会自动调用multipart插件，你可以参考官方文档
中间件的核心代码
module.exports = options => {
// normalize
const matchFn = options.fileModeMatch && pathMatching({ match: options.fileModeMatch });
return async function multipart(ctx, next) {
if (!ctx.is('multipart')) return next();
if (matchFn && !matchFn(ctx)) return next();
await ctx.saveRequestFiles();
return next();
};
};
其实就是调用 ctx.saveRequestFiles()这个方法
这个方法就是将传递的file文件
async saveRequestFiles(options) {
options = options || {};
const ctx = this;
const multipartOptions = {
autoFields: false,
};
if (options.defCharset) multipartOptions.defCharset = options.defCharset;
if (options.limits) multipartOptions.limits = options.limits;
if (options.checkFile) multipartOptions.checkFile = options.checkFile;
let storedir;
const requestBody = {};
const requestFiles = [];
const parts = ctx.multipart(multipartOptions);
let part;
do {
try {
part = await parts();
} catch (err) {
await ctx.cleanupRequestFiles(requestFiles);
throw err;
}
if (!part) break;
if (part.length) {
ctx.coreLogger.debug('[egg-multipart:storeMultipart] handle value part: %j', part);
const fieldnameTruncated = part[2];
const valueTruncated = part[3];
if (valueTruncated) {
await ctx.cleanupRequestFiles(requestFiles);
return await limit('Request_fieldSize_limit', 'Reach fieldSize limit');
}
if (fieldnameTruncated) {
await ctx.cleanupRequestFiles(requestFiles);
return await limit('Request_fieldNameSize_limit', 'Reach fieldNameSize limit');
}
// arrays are busboy fields
requestBody[part[0]] = part[1];
continue;
}
// otherwise, it's a stream
const meta = {
field: part.fieldname,
filename: part.filename,
encoding: part.encoding,
mime: part.mime,
};
// keep same property name as file stream
// https://github.com/cojs/busboy/blob/master/index.js#L114
meta.fieldname = meta.field;
meta.transferEncoding = meta.encoding;
meta.mimeType = meta.mime;
ctx.coreLogger.debug('[egg-multipart:storeMultipart] handle stream part: %j', meta);
// empty part, ignore it
if (!part.filename) {
await sendToWormhole(part);
continue;
}
if (!storedir) {
// ${tmpdir}/YYYY/MM/DD/HH
storedir = path.join(ctx.app.config.multipart.tmpdir, moment().format('YYYY/MM/DD/HH'));
const exists = await fs.exists(storedir);
if (!exists) {
await mkdirp(storedir);
}
}
const filepath = path.join(storedir, uuid.v4() + path.extname(meta.filename));
const target = fs.createWriteStream(filepath);
await pump(part, target);
// https://github.com/mscdex/busboy/blob/master/lib/types/multipart.js#L221
meta.filepath = filepath;
requestFiles.push(meta);
// https://github.com/mscdex/busboy/blob/master/lib/types/multipart.js#L221
if (part.truncated) {
await ctx.cleanupRequestFiles(requestFiles);
return await limit('Request_fileSize_limit', 'Reach fileSize limit');
}
} while (part != null);
ctx.request.body = requestBody;
ctx.request.files = requestFiles;
},
可以看出代码量非常小，但最主要过程是ctx.multipart方法创建一个实例，将上传文件存储在临时目录中，然后封装requestBody和requestFiles这个2个方法。所以只要搞明白ctx.multipart这个方法的实现，基本上你就明白egg-multipart是怎么处理上传文件。
const parse = require('co-busboy');
/**
* create multipart.parts instance, to get separated files.
* @function Context#multipart
* @param {Object} [options] - override default multipart configurations
* - {Boolean} options.autoFields
* - {String} options.defCharset
* - {Object} options.limits
* - {Function} options.checkFile
* @return {Yieldable} parts
*/
multipart(options) {
// multipart/form-data ctx.is() 检查传入请求是否包含 Content-Type 消息头字段， 并且包含任意的 mime type。
if (!this.is('multipart')) {
this.throw(400, 'Content-Type must be multipart/*');
}
// 避免重复处理
if (this[HAS_CONSUMED]) throw new TypeError('the multipart request can\'t be consumed twice');
this[HAS_CONSUMED] = true;
const parseOptions = Object.assign({}, this.app.config.multipartParseOptions);
options = options || {};
if (typeof options.autoFields === 'boolean') parseOptions.autoFields = options.autoFields;
if (options.defCharset) parseOptions.defCharset = options.defCharset;
if (options.checkFile) parseOptions.checkFile = options.checkFile;
// merge and create a new limits object
if (options.limits) parseOptions.limits = Object.assign({}, parseOptions.limits, options.limits);
return parse(this, parseOptions);
},
这里代码也非常简单，其实看到这里你就明白了，egg-multipart是封装co-busboy的插件。但在继续分析下去我没什么动力了，等有机会我看看co-busboy插件源码。
总结
整体来看，egg-multipart做事情都很简单，就封装了三个主要方法，当mode是file模式时，中间件多了一步调用await ctx.saveRequestFiles()方法，其实本事也是调用ctx.multipart方法去二次封装处理request.body 和 request.files。相信到这里你跟我一样有大概思路，但是啥也写不出来，哈哈哈。
