koa指的是一個類似Express的基於Node實現的web框架，致力於成為web應用和API開發領域中的一個更小、更富有表現力、更健壯的基石。 Koa並沒有捆綁任何中間件，而是提供了一套優雅的方法，幫助用戶快速而愉快地編寫服務端應用程式。
本教學操作環境：windows7系統、nodejs 12.19.0&&koa2.0版、Dell G3電腦。
Koa是一個類似Express的Web開發框架，創辦人也是同一個人。它的主要特點是，使用了ES6的Generator函數，進行了架構的重新設計。也就是說，Koa的原理和內部結構很像Express，但是語法和內部結構進行了升級。
Koa 是一個新的 web 框架，由 Express 幕後的原班人馬打造， 致力於成為 web 應用和 API 開發領域中的一個更小、更富有表現力、更健壯的基石。透過利用 async 函數，Koa 幫你丟棄回呼函數，並有力地增強錯誤處理。 Koa 並沒有捆綁任何中間件， 而是提供了一套優雅的方法，幫助您快速而愉快地編寫服務端應用程式。
官方faq有這樣一個問題：」為什麼koa不是Express 4.0？“，回答是這樣的：”Koa與Express有很大差異，整個設計都是不同的，所以如果將Express 3.0按照這種寫法升級到4.0，就意味著重寫整個程式。所以，我們覺得創造一個新的庫，是更合適的做法。「
##1 Koa應用
一個
Koa應用程式就是一個物件，包含了一個middleware數組，這個陣列由一組Generator函數組成。這些函數負責對HTTP請求進行各種加工，例如產生快取、指定代理、請求重定向等等。
var koa = require('koa');
var app = koa();
app.use(function *(){
this.body = 'Hello World';
});
app.listen(3000);登入後複製
2 中間件
Koa的中間件很像Express的中間件，也是對HTTP請求進行處理的函數，但必須是一個Generator函數。 而且，Koa的中間件是一個
級聯式（Cascading）的結構，也就是說，屬於是層層調用，第一個中間件調用第二個中間件，第二個呼叫第三個，以此類推。 上游的中間件必須等到下游的中間件回傳結果，才會繼續執行，這點很像遞迴。 中間件透過目前應用的
use方法註冊。
app.use(function* (next){
var start = new Date; // （1）
yield next; // （2）
var ms = new Date - start; // （3）
console.log('%s %s - %s', this.method, this.url, ms); // （4）
});登入後複製
上面程式碼中，
app.use方法的參數就是中間件，它是一個Generator函數， 最大的特性就是function指令與參數之間，必須有一個星號，表示下一個中間件。
Generator函數內部使用yield指令，將程式的執行權轉交給下一個中間件，即yield next，要等到下一個中介軟體返回結果，才會繼續往下執行。
上面程式碼中，第一個中介軟體呼叫第二個中間件saveResults，它們都會向this.body寫入內容。最後，this.body的輸出如下。
header
Results Saved!
footer
登入後複製
只要有一個中間件缺少
yield next語句，後面的中間件都不會執行，這一點要引起注意。
app.use(function *(next){
console.log('>> one');
yield next;
console.log('<< one');
});
app.use(function *(next){
console.log('>> two');
this.body = 'two';
console.log('<< two');
});
app.use(function *(next){
console.log('>> three');
yield next;
console.log('<< three');
});登入後複製
上面程式碼中，因為第二個中間件少了
yield next語句，第三個中間件並不會執行。 如果想跳過一個中間件，可以直接在該中間件的第一行語句寫上return yield next。
app.use(function* (next) {
if (skip) return yield next;
})登入後複製
由於Koa要求中間件唯一的參數就是next，導致如果要傳入其他參數，必須另外寫一個回傳Generator函數的函數。
function logger(format) {
return function *(next){
var str = format
.replace(':method', this.method)
.replace(':url', this.url);
console.log(str);
yield next;
}
}
app.use(logger(':method :url'));登入後複製
上面程式碼中，真正的中間件是logger函數的回傳值，而logger函數是可以接受參數的。
3 多个中间件的合并
由于中间件的参数统一为next（意为下一个中间件），因此可以使用.call(this, next)，将多个中间件进行合并。
function *random(next) {
if ('/random' == this.path) {
this.body = Math.floor(Math.random()*10);
} else {
yield next;
}
};
function *backwards(next) {
if ('/backwards' == this.path) {
this.body = 'sdrawkcab';
} else {
yield next;
}
}
function *pi(next) {
if ('/pi' == this.path) {
this.body = String(Math.PI);
} else {
yield next;
}
}
function *all(next) {
yield random.call(this, backwards.call(this, pi.call(this, next)));
}
app.use(all);登入後複製
上面代码中，中间件all内部，就是依次调用random、backwards、pi，后一个中间件就是前一个中间件的参数。
Koa内部使用koa-compose模块，进行同样的操作，下面是它的源码。
function compose(middleware){
return function *(next){
if (!next) next = noop();
var i = middleware.length;
while (i--) {
next = middleware[i].call(this, next);
}
yield *next;
}
}
function *noop(){}登入後複製
上面代码中，middleware是中间件数组。前一个中间件的参数是后一个中间件，依次类推。如果最后一个中间件没有next参数，则传入一个空函数。
4 路由
可以通过this.path属性，判断用户请求的路径，从而起到路由作用。
app.use(function* (next) {
if (this.path === '/') {
this.body = 'we are at home!';
}
})
// 等同于
app.use(function* (next) {
if (this.path !== '/') return yield next;
this.body = 'we are at home!';
})登入後複製
下面是多路径的例子。
let koa = require('koa')
let app = koa()
// normal route
app.use(function* (next) {
if (this.path !== '/') {
return yield next
}
this.body = 'hello world'
});
// /404 route
app.use(function* (next) {
if (this.path !== '/404') {
return yield next;
}
this.body = 'page not found'
});
// /500 route
app.use(function* (next) {
if (this.path !== '/500') {
return yield next;
}
this.body = 'internal server error'
});
app.listen(8080)登入後複製
上面代码中，每一个中间件负责一个路径，如果路径不符合，就传递给下一个中间件。
复杂的路由需要安装koa-router插件。
var app = require('koa')();
var Router = require('koa-router');
var myRouter = new Router();
myRouter.get('/', function *(next) {
this.response.body = 'Hello World!';
});
app.use(myRouter.routes());
app.listen(3000);登入後複製
上面代码对根路径设置路由。
Koa-router实例提供一系列动词方法，即一种HTTP动词对应一种方法。典型的动词方法有以下五种。
- router.get()
- router.post()
- router.put()
- router.del()
- router.patch()
这些动词方法可以接受两个参数，第一个是路径模式，第二个是对应的控制器方法（中间件），定义用户请求该路径时服务器行为。
router.get('/', function *(next) {
this.body = 'Hello World!';
});登入後複製
上面代码中，router.get方法的第一个参数是根路径，第二个参数是对应的函数方法。
注意，路径匹配的时候，不会把查询字符串考虑在内。比如，/index?param=xyz匹配路径/index。
有些路径模式比较复杂，Koa-router允许为路径模式起别名。
起名时，别名要添加为动词方法的第一个参数，这时动词方法变成接受三个参数。
router.get('user', '/users/:id', function *(next) {
// ...
});登入後複製
上面代码中，路径模式\users\:id的名字就是user。路径的名称，可以用来引用对应的具体路径，比如url方法可以根据路径名称，结合给定的参数，生成具体的路径。
router.url('user', 3);
// => "/users/3"
router.url('user', { id: 3 });
// => "/users/3"登入後複製
上面代码中，user就是路径模式的名称，对应具体路径/users/:id。url方法的第二个参数3，表示给定id的值是3，因此最后生成的路径是/users/3。
Koa-router允许为路径统一添加前缀。
var router = new Router({
prefix: '/users'
});
router.get('/', ...); // 等同于"/users"
router.get('/:id', ...); // 等同于"/users/:id"登入後複製
路径的参数通过this.params属性获取，该属性返回一个对象，所有路径参数都是该对象的成员。
// 访问 /programming/how-to-node
router.get('/:category/:title', function *(next) {
console.log(this.params);
// => { category: 'programming', title: 'how-to-node' }
});
param方法可以针对命名参数，设置验证条件。
router
.get('/users/:user', function *(next) {
this.body = this.user;
})
.param('user', function *(id, next) {
var users = [ '0号用户', '1号用户', '2号用户'];
this.user = users[id];
if (!this.user) return this.status = 404;
yield next;
})登入後複製
上面代码中，如果/users/:user的参数user对应的不是有效用户（比如访问/users/3），param方法注册的中间件会查到，就会返回404错误。
redirect方法会将某个路径的请求，重定向到另一个路径，并返回301状态码。
router.redirect('/login', 'sign-in');
// 等同于
router.all('/login', function *() {
this.redirect('/sign-in');
this.status = 301;
});登入後複製
redirect方法的第一个参数是请求来源，第二个参数是目的地，两者都可以用路径模式的别名代替。
5 context对象
- 中间件当中的
this表示上下文对象context，代表一次HTTP请求和回应，即一次访问/回应的所有信息，都可以从上下文对象获得。 - context对象封装了request和response对象，并且提供了一些辅助方法。每次HTTP请求，就会创建一个新的context对象。
app.use(function *(){
this; // is the Context
this.request; // is a koa Request
this.response; // is a koa Response
});登入後複製
context对象的很多方法，其实是定义在ctx.request对象或ctx.response对象上面
比如，ctx.type和ctx.length对应于ctx.response.type和ctx.response.length，ctx.path和ctx.method对应于ctx.request.path和ctx.request.method。
context对象的全局属性。
- request：指向Request对象
- response：指向Response对象
- req：指向Node的request对象
- req：指向Node的response对象
- app：指向App对象
- state：用于在中间件传递信息。
this.state.user = yield User.find(id);
登入後複製
上面代码中，user属性存放在this.state对象上面，可以被另一个中间件读取。
context对象的全局方法。
- throw()：抛出错误，直接决定了HTTP回应的状态码。
- assert()：如果一个表达式为false，则抛出一个错误。
this.throw(403);
this.throw('name required', 400);
this.throw('something exploded');
this.throw(400, 'name required');
// 等同于
var err = new Error('name required');
err.status = 400;
throw err;
登入後複製
6 错误处理机制
Koa提供内置的错误处理机制，任何中间件抛出的错误都会被捕捉到，引发向客户端返回一个500错误，而不会导致进程停止，因此也就不需要forever这样的模块重启进程。
app.use(function *() {
throw new Error();
});登入後複製
上面代码中，中间件内部抛出一个错误，并不会导致Koa应用挂掉。Koa内置的错误处理机制，会捕捉到这个错误。
当然，也可以额外部署自己的错误处理机制。
app.use(function *() {
try {
yield saveResults();
} catch (err) {
this.throw(400, '数据无效');
}
});登入後複製
上面代码自行部署了try...catch代码块，一旦产生错误，就用this.throw方法抛出。该方法可以将指定的状态码和错误信息，返回给客户端。
对于未捕获错误，可以设置error事件的监听函数。
app.on('error', function(err){
log.error('server error', err);
});登入後複製
error事件的监听函数还可以接受上下文对象，作为第二个参数。
app.on('error', function(err, ctx){
log.error('server error', err, ctx);
});登入後複製
如果一个错误没有被捕获，koa会向客户端返回一个500错误“Internal Server Error”。
this.throw方法用于向客户端抛出一个错误。
this.throw(403);
this.throw('name required', 400);
this.throw(400, 'name required');
this.throw('something exploded');
this.throw('name required', 400)
// 等同于
var err = new Error('name required');
err.status = 400;
throw err;
this.throw方法的两个参数，一个是错误码，另一个是报错信息。如果省略状态码，默认是500错误。
this.assert方法用于在中间件之中断言，用法类似于Node的assert模块。
this.assert(this.user, 401, 'User not found. Please login!');
登入後複製
上面代码中，如果this.user属性不存在，会抛出一个401错误。
由于中间件是层级式调用，所以可以把try { yield next }当成第一个中间件。
app.use(function *(next) {
try {
yield next;
} catch (err) {
this.status = err.status || 500;
this.body = err.message;
this.app.emit('error', err, this);
}
});
app.use(function *(next) {
throw new Error('some error');
})登入後複製
7 cookie
cookie的读取和设置。
this.cookies.get('view');
this.cookies.set('view', n);
登入後複製
get和set方法都可以接受第三个参数，表示配置参数。其中的signed参数，用于指定cookie是否加密。
如果指定加密的话，必须用app.keys指定加密短语。
app.keys = ['secret1', 'secret2'];
this.cookies.set('name', '张三', { signed: true });登入後複製
this.cookie的配置对象的属性如下。
signed：cookie是否加密。expires：cookie何时过期path：cookie的路径，默认是“/”。domain：cookie的域名。secure：cookie是否只有https请求下才发送。httpOnly：是否只有服务器可以取到cookie，默认为true。
8 session
var session = require('koa-session');
var koa = require('koa');
var app = koa();
app.keys = ['some secret hurr'];
app.use(session(app));
app.use(function *(){
var n = this.session.views || 0;
this.session.views = ++n;
this.body = n + ' views';
})
app.listen(3000);
console.log('listening on port 3000');登入後複製
【推荐学习：《nodejs 教程》】
以上是nodejs中的koa是什麼的詳細內容。更多資訊請關注PHP中文網其他相關文章！
