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输出。另外它可以按照文件大小或者日期来生成本地日志文件,还可以使用邮件等形式发送日志。

用法:http://www.jianshu.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 环境变量。

你可能感兴趣的:(koa中间件记录)