koa-bodyparser源码解析

介绍

A body parser for koa, based on co-body. support json, form and text type body.

意思是koa的body解析器，基于co-body，支持json，form，text类型的请求体。

demo:

var Koa = require('koa');
var bodyParser = require('koa-bodyparser');
 
var app = new Koa();
app.use(bodyParser());
 
app.use(async ctx => {
  // the parsed body will store in ctx.request.body
  // if nothing was parsed, body will be an empty object {}
  ctx.body = ctx.request.body;
});

源码 koa-bodyparser 4.3.0

'use strict';
const parse = require('co-body');
const copy = require('copy-to');

/**
 * @param [Object] opts
 *   - {String} jsonLimit default '1mb'
 *   - {String} formLimit default '56kb'
 *   - {string} encoding default 'utf-8'
 *   - {Object} extendTypes
 */

module.exports = function (opts) {
  opts = opts || {};
  const { detectJSON } = opts;
  const { onerror } = opts;

  // 获取可用类型，以及各类型可用的布尔值
  const enableTypes = opts.enableTypes || ['json', 'form'];
  const enableForm = checkEnable(enableTypes, 'form');
  const enableJson = checkEnable(enableTypes, 'json');
  const enableText = checkEnable(enableTypes, 'text');
  const enableXml = checkEnable(enableTypes, 'xml');

  opts.detectJSON = undefined;
  opts.onerror = undefined;

  // 使 co-body 返回 raw body
  opts.returnRawBody = true;

  // 默认的 json 类型
  const jsonTypes = [
    'application/json',
    'application/json-patch+json',
    'application/vnd.api+json',
    'application/csp-report'
  ];

  // 默认的 form 类型
  const formTypes = ['application/x-www-form-urlencoded'];

  // 默认的 text 类型
  const textTypes = ['text/plain'];

  // 默认的 xml 类型
  const xmlTypes = ['text/xml', 'application/xml'];

  // 格式化成对应类型的参数
  const jsonOpts = formatOptions(opts, 'json');
  const formOpts = formatOptions(opts, 'form');
  const textOpts = formatOptions(opts, 'text');
  const xmlOpts = formatOptions(opts, 'xml');

  // 这里通过参数扩展自定义的type类型
  const extendTypes = opts.extendTypes || {};
  extendType(jsonTypes, extendTypes.json);
  extendType(formTypes, extendTypes.form);
  extendType(textTypes, extendTypes.text);
  extendType(xmlTypes, extendTypes.xml);

  // 返回中间件
  return async function bodyParser(ctx, next) {
    // 如果请求体为空或禁用则跳出
    if (ctx.request.body !== undefined || ctx.disableBodyParser)
      return await next();
    try {
      const res = await parseBody(ctx);
      ctx.request.body = 'parsed' in res ? res.parsed : {};
      if (ctx.request.rawBody === undefined) ctx.request.rawBody = res.raw;
    } catch (err) {
      if (onerror) {
        // 自定义错误处理函数
        onerror(err, ctx);
      } else {
        throw err;
      }
    }

    await next();
  };

  // 使用co-body的parse转换请求内容
  async function parseBody(ctx) {
    if (
      enableJson &&
      ((detectJSON && detectJSON(ctx)) || ctx.request.is(jsonTypes))
    ) {
      return await parse.json(ctx, jsonOpts);
    }

    if (enableForm && ctx.request.is(formTypes)) {
      return await parse.form(ctx, formOpts);
    }

    if (enableText && ctx.request.is(textTypes)) {
      return (await parse.text(ctx, textOpts)) || '';
    }

    if (enableXml && ctx.request.is(xmlTypes)) {
      return (await parse.text(ctx, xmlOpts)) || '';
    }

    return {};
  }
};

function formatOptions(opts, type) {
  const res = {};
  // 将opts复制到res中并返回
  copy(opts).to(res);
  res.limit = opts[type + 'Limit'];
  return res;
}

function extendType(original, extend) {
  if (extend) {
    if (!Array.isArray(extend)) {
      extend = [extend];
    }

    extend.forEach(function (extend) {
      original.push(extend);
    });
  }
}

function checkEnable(types, type) {
  return types.includes(type);
}

request的is判断：

is (type, ...types) {
  return typeis(this.req, type, ...types)
},

​ 可以看到这边bodyparser确实没有过多的逻辑，主要是使用co-body这个库去处理对应类型的数据。

参考链接：

打赏