WEB前端开发

koa--基于Node.js平台的下一代web开发框架

2017-10-24  本文已影响0人  dravenxiaokai
本章内容主要参考官网
  • 简介
  • 应用
  • Context(上下文)
  • 请求(Request)
  • 响应(Response)

简介

koa 是由 Express 原班人马打造的,致力于成为一个更小、更富有表现力、更健壮的 Web 框架。使用 koa 编写 web 应用,通过组合不同的 generator,可以免除重复繁琐的回调函数嵌套,并极大地提升错误处理的效率。koa 不在内核方法中绑定任何中间件,它仅仅提供了一个轻量优雅的函数库,使得编写 Web 应用变得得心应手。

安装

Koa 目前需要 >=0.11.x版本的 node 环境。并需要在执行 node 的时候附带 --harmony 来引入 generators 。

$ npm install -g n
$ n 0.11.12
$ node --harmony my-koa-app.js

应用

// koa.js
const koa = require('koa')

var app = new koa()

app
    .use(function* () {
        this.body = {
            name: 'aaa'
        }
    })
    .listen(3000, 'localhost', () => {
        console.log('starting on port: ', 3000)
    })

中间件级联

下面的例子在页面中返回 "Hello World",然而当请求开始时,请求先经过 x-response-time 和 logging 中间件,并记录中间件执行起始时间。 然后将控制权交给 reponse 中间件。当中间件运行到 yield next 时,函数挂起并将控制前交给下一个中间件。当没有中间件执行 yield next 时,程序栈会逆序唤起被挂起的中间件来执行接下来的代码。

//koa1.js
var koa = require('koa');
var app = new koa();

// x-response-time

app.use(function *(next){
  var start = new Date;
  yield next;
  var ms = new Date - start;
  this.set('X-Response-Time', ms + 'ms');
});

// logger

app.use(function *(next){
  var start = new Date;
  yield next;
  var ms = new Date - start;
  console.log('%s %s - %s', this.method, this.url, ms);
});

// response

app.use(function *(){
  this.body = 'Hello World';
});

app.listen(3000);

配置

应用配置是 app 实例属性,目前支持的配置项如下:

app.name 应用名称(可选项)
app.env 默认为 NODE_ENV 或者 development
app.proxy 如果为 true,则解析 "Host" 的 header 域,并支持 X-Forwarded-Host
app.subdomainOffset 默认为2,表示 .subdomains 所忽略的字符偏移量。

app.listen(...)

app.listen(...) 实际上是以下代码的语法糖:

var http = require('http');
var koa = require('koa');
var app = new koa();
http.createServer(app.callback()).listen(3000);

这意味着您可以同时支持 HTTP 和 HTTPS,或者在多个端口监听同一个应用。

var http = require('http');
var koa = require('koa');
var app = new koa();
http.createServer(app.callback()).listen(3000);
http.createServer(app.callback()).listen(3001);
//listen.js
const koa = require('koa')

var app = new koa()

app.use(function* () {
    this.body = {
        name: 'aaa'
    }
})

app.listen(3000, 'localhost', () => {
    console.log('starting on port: ', 3000)
})
app.listen(3001, 'localhost', () => {
    console.log('starting on port: ', 3001)
})

app.use(function)

为应用添加指定的中间件,详情请看 Middleware

Context(上下文)

Koa Context 将 node 的 request 和 response 对象封装在一个单独的对象里面,其为编写 web 应用和 API 提供了很多有用的方法。

这些操作在 HTTP 服务器开发中经常使用,因此其被添加在上下文这一层,而不是更高层框架中,因此将迫使中间件需要重新实现这些常用方法。

context 在每个 request 请求中被创建,在中间件中作为接收器(receiver)来引用,或者通过 this 标识符来引用:

app.use(function *(){
  this; // is the Context
  this.request; // is a koa Request
  this.response; // is a koa Response
});

Koa 不支持 直接调用底层 res 进行响应处理。请避免使用以下 node 属性:

res.statusCode
res.writeHead()
res.write()
res.end()

app.keys=

设置签名Cookie密钥,该密钥会被传递给 KeyGrip。

app.keys = ['im a newer secret', 'i like turtle'];
app.keys = new KeyGrip(['im a newer secret', 'i like turtle'], 'sha256')

ctx.throw(msg, [status])

抛出包含 .status 属性的错误,默认为 500。该方法可以让 Koa 准确的响应处理状态。 Koa支持以下组合:

this.throw(403)
this.throw('name required', 400)
this.throw(400, 'name required')
this.throw('something exploded')

请求(Request)

Koa Request 对象是对 node 的 request 进一步抽象和封装,提供了日常 HTTP 服务器开发中一些有用的功能。

响应(Response)

Koa Response 对象是对 node 的 response 进一步抽象和封装,提供了日常 HTTP 服务器开发中一些有用的功能。

官方详细API

http://koajs.com

本章节内容所涉及源码

查看本章源码

上一篇 下一篇

猜你喜欢

热点阅读