koa中间件记录

一、koa的错误处理
  1. koa-onerror
    koa有error事件,当发生错误,可以通过error事件,对错误统一处理。
var Koa = require('koa');
var app = Koa();
app.on('error', function(err,ctx){
    console.log(err);
});   
app.listen(3000);

上面这段代码在如果捕获到错误,页面会打印出 “Internal Server Error” (这是Koa对错误的默认处理)。这个错误我们在综合监控系统中也经常见到,那么我们显然无法根据这条日志得到什么信息。

TypeError: Cannot read property 'split' of undefined
at Object.Home.index (d:\test\route\home.js:143:31)
at GeneratorFunctionPrototype.next (native)
at Object.dispatch (d:\test\node_modules\koa-router\lib\router.js:97:44)
at GeneratorFunctionPrototype.next (native)

这些错误信息是怎么报出来的的呢,其实是Koa-onerror 中间件,它优化错误信息,根据这些错误信息就能更好的捕获到错误。

var onerror = require('Koa-onerror');
    onerror(app);
二、koa日志
  1. koa-logger
app.use(require('koa-logger'));
  1. log4js
    log4js提供了多个日志等级分类,同时也能替代console.log输出。另外它可以按照文件大小或者日期来生成本地日志文件,还可以使用邮件等形式发送日志。

用法://www.greatytc.com/p/6b816c609669(version<2.0)

三、请求数据解析

1、koa-bodyparser

用来解析body,比如通过post来传递表单、json或上传文件,数据不容易获取,通过koa-bodyparser解析之后,在koa中this.body就能获取到数据。

支持json,form,text类型

用法:

const bodyparser = require('koa-bodyparser');
app.use(bodyparser({
  enableTypes:['json', 'form', 'text']
}))

参数:

  • disableBodyParser,可以动态设置不转换
app.use(async (ctx, next) => {
  if (ctx.path === '/disable') ctx.disableBodyParser = true;
  await next();
});
app.use(bodyparser());
  • onerror,用户化设置转换出错时的处理
app.use(bodyparser({
  onerror: function (err, ctx) {
    ctx.throw('body parse error', 422);
  }
}));

2、koa-multer

解析multipart/form-data类型

const multer = require('koa-multer');
app.user(multer());
四、路由处理

1、koa-router
① 基本用法:

var router = require('koa-router')();
router.get('/', function(ctx, next){
  ...
});

app
  .use(router.routes())
  .use(router.allowedMethods());

② router.get/post/put/del/all

router
  .get('/', function (ctx, next) {
        ctx.body = 'Hello World!';
  })
  .post('/users', function (ctx, next) {
  })
  .put('/users/:id', function (ctx, next) {
  })
  .del('/users/:id', function (ctx, next) {
  })
  .all('/users/:id', function (ctx, next) {
  });

③ 多个中间件

router.get(
  '/users/:id',
  function (ctx, next) {
    return User.findOne(ctx.params.id).then(function(user) {
      ctx.user = user;
      return next();
    });
  },
  function (ctx) {
    console.log(ctx.user);
    // => { id: 17, name: "Alex" }
  }
);
五、其他

1、koa-json
美观的输出JSON response的Koa中间件
有两种使用方式:
一种是总是返回美化了的json数据:

const json = require('koa-json');
app.use(json());

另一种是默认不进行美化,但是当地址栏传入pretty参数的时候,则返回的结果是进行了美化的。

app.use(json({ pretty: false, param: 'pretty' }));

2、koa-static
用于koa的静态文件指定映射路径。

const staticServe = require('koa-static');
app.use(staticServe(root, opts));

参数:
① root:静态文件的根目录
② opts:

  • maxage
    浏览器缓存的最大时间(max-age),单位是milliseconds(毫秒)。默认为0
  • hidden
    允许传送隐藏文件,默认为false
  • index
    Default file name, defaults to ‘index.html’
  • defer
    If true, serves after yield next, allowing any downstream middleware to respond first.
  • gzip
    当client支持 gzip 而且被请求的文件也有一个以 .gz 为扩展名的文件的时候,自动以所请求文件对应的 .gz 文件进行返回。默认为true
  • extensions
    Try to match extensions from passed array to search for file when no extension 是合格的 in URL. First found is served. (defaults to false)

3、koa-views
用于指定视图的渲染模板类型

app.use(views(__dirname + '/views', {
    extension: 'jade',
    map: {
        html: 'underscore'
    },
    engineSource: {
        foo: () => Promise.resolve('bar')
    },
    options: {
        helpers: {
            uppercase: (str) => str.toUpperCase()
        },
        partials: {
            subTitle: './my-partial' // requires ./my-partial.hbs
        }
    }
}));

参数:
① root,指明view文件的绝对路径(注意这里不能用相对路径);
② opt,这里面又包含着四个配置项:

  • extension,用于指明view文件的默认后缀名。
  • map,指明后缀名为某种类型的文件采用何种引擎进行处理。如上例中即指明后缀为.html的文件使用underscore引擎进行处理。
  • engineSource,指明后缀名为某类型的文件采用某engine source来进行处理,替换掉默认的engine source —— consolidate。上例中表示所有以.foo为后缀的文件会被返回’bar’。
  • options,这是传入helpers和partials的地方,这些options会被传入到view engine中。

开启koa-views的debug模式:
在启动koa服务的时候添加一个 DEBUG=koa-views 环境变量。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,311评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,339评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,671评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,252评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,253评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,031评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,340评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,973评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,466评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,937评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,039评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,701评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,254评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,259评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,497评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,786评论 2 345

推荐阅读更多精彩内容