Koa基本用法总结|原理篇
30 秒速记
- 核心判断:服务端框架把请求、响应和中间件组合成可控制的处理链,核心是调用顺序与错误传播
- 原理主线:围绕 「一、基本用法」、「二、路由」、「三、中间件」 建立输入、状态变化与输出之间的因果关系
- 文章范围:系统总结了Koa框架的基本用法,包括如何搭建HTTP服务、使用Context对象处理请求与响应、设置返回内容类型等核心知识,适合Node.js开发者快速上手和理解Koa原理。
- 边界与代价:
Koa洋葱模型依赖await next(),遗漏等待或重复写响应会破坏上下游时序 - 工程落地:中间件应明确是否继续、何时回收资源、错误由谁处理,并用请求级上下文隔离状态
Koa 的基本用法,是通过 Context 读写请求和响应,再用中间件把处理逻辑串成洋葱式执行链。 路由、静态资源、表单和文件上传通常交给对应中间件,业务代码只需修改 ctx.body、状态码或响应类型。异步中间件要写成 async,并用 await next() 保证下游完成后再执行回程逻辑。错误处理一般放在最外层统一捕获,同时可监听 error 事件记录异常。
这篇文章不要按 API 清单来背。先用上面的 Mind Map 建立全局结构,再通过交互 DEMO 观察正常路径和边界路径如何改变状态;阅读正文时重点核对每一步的输入、负责执行的参与者、产生的中间状态以及最终可观察结果。遇到版本敏感结论,要把“历史实现”“当前行为”和“工程兼容策略”分开说明;遇到性能或架构取舍,则用实际指标、失败现象和验证手段支撑判断。
版本校准: Node.js 的事件循环阶段名称相对稳定,但定时器、微任务和底层 libuv 行为会随主版本变化。回答时必须先报运行版本,再用最小脚本验证顺序;不要把浏览器事件循环或某个旧版本输出当作所有 Node.js 版本的固定结论。
Koa 就是一种简单好用的 Web 框架。它的特点是优雅、简洁、表达力强、自由度高
# 一、基本用法
# 1.1 架设 HTTP 服务
只要三行代码,就可以用
Koa架设一个HTTP服务。
const Koa = require('koa');
const app = new Koa();
app.listen(3000);
打开浏览器,访问
http://127.0.0.1:3000。你会看到页面显示"Not Found",表示没有发现任何内容。这是因为我们并没有告诉Koa应该显示什么内容
# 1.2 Context 对象
Koa提供一个Context对象,表示一次对话的上下文(包括HTTP请求和HTTP回复)。通过加工这个对象,就可以控制返回给用户的内容
Context.response.body属性就是发送给用户的内容
const Koa = require("koa");
const app = new Koa();
app.use(ctx => { //处理请求的中间件
ctx.response.body = "hello world";
}).listen(3000);
上面代码中,
main函数用来设置ctx.response.body。然后,使用app.use方法加载main函数
ctx.response代表HTTP Response。同样地,ctx.request代表HTTP Request
# 1.3 HTTP Response 的类型
Koa默认的返回类型是text/plain,如果想返回其他类型的内容,可以先用ctx.request.accepts判断一下,客户端希望接受什么数据(根据HTTP Request的Accept字段),然后使用ctx.response.type指定返回类型
const Koa = require("koa");
const app = new Koa();
app.use(ctx => {
if (ctx.request.accepts('xml')) {
ctx.response.type = 'xml';
ctx.response.body = '<data>Hello World</data>';
} else if (ctx.request.accepts('json')) {
ctx.response.type = 'json';
ctx.response.body = { data: 'Hello World' };
} else if (ctx.request.accepts('html')) {
ctx.response.type = 'html';
ctx.response.body = '<p>Hello World</p>';
} else {
ctx.response.type = 'text';
ctx.response.body = 'Hello World';
}
}).listen(3000);
# 1.4 网页模板
实际开发中,返回给用户的网页往往都写成模板文件。我们可以让 Koa 先读取模板文件,然后将这个模板返回给用户
const Koa = require("koa");
const app = new Koa();
const fs = require('fs');
app.use(ctx => {
ctx.response.type = 'html';
ctx.response.body = fs.createReadStream('./demos/template.html');
}).listen(3000);
# 二、路由
网站一般都有多个页面。通过
ctx.request.path可以获取用户请求的路径,由此实现简单的路由
const Koa = require("koa");
const app = new Koa();
const fs = require('fs');
app.use(ctx => {
if (ctx.request.path !== '/') {
ctx.response.type = 'html';
ctx.response.body = '<a href="/">Index Page1</a>';
} else {
ctx.response.body = 'Hello World';
}
}).listen(3000);
# 2.1 koa-route 模块
原生路由用起来不太方便,我们可以使用封装好的
koa-route模块
const Koa = require("koa");
const app = new Koa();
const fs = require('fs');
const route = require('koa-route');
const main = route.get("/", ctx => {
ctx.response.type = 'html';
ctx.response.body = '<a href="/">Index Page1</a>';
})
const about = route.get("/about", ctx => {
ctx.response.body = 'Hello World';
})
app.use(main);
app.use(about);
app.listen(3000);
# 2.2 静态资源
如果网站提供静态资源(图片、字体、样式表、脚本…),为它们一个个写路由就很麻烦,也没必要。
koa-static模块封装了这部分的请求
// 访问 http://localhost:3000/test.json
const Koa = require("koa");
const app = new Koa();
const path = require('path');
const serve = require('koa-static');
const main = serve(path.join(__dirname, "../public/"));
app.use(main);
app.listen(3000);
# 2.3 重定向
有些场合,服务器需要重定向(
redirect)访问请求。比如,用户登陆以后,将他重定向到登陆前的页面。ctx.response.redirect()方法可以发出一个302跳转,将用户导向另一个路由
const Koa = require("koa");
const app = new Koa();
const route = require("koa-route");
const redirect = route.get("/redirect", ctx => {
ctx.response.redirect('/');
ctx.response.body = '<a href="/">Index Page</a>';
})
const main = route.get("/", ctx => {
ctx.response.body = "hello world";
});
app.use(main);
app.use(redirect);
app.listen(3000);
# 三、中间件
# 3.1 Logger 功能
Koa 的最大特色,也是最重要的一个设计,就是中间件(middleware)。为了理解中间件,我们先看一下 Logger (打印日志)功能的实现
# 3.2 中间件的概念
“中间件”(middleware),它处在 HTTP Request 和 HTTP Response 中间,用来实现某种中间功能。app.use()用来加载中间件
- 基本上,Koa 所有的功能都是通过中间件实现的,前面例子里面的main也是中间件
- 每个中间件默认接受两个参数,第一个参数是 Context 对象,第二个参数是next函数。只要调用next函数,就可以把执行权转交给下一个中间件
# 3.3 中间件栈
多个中间件会形成一个栈结构(
middle stack),以"先进后出"(first-in-last-out)的顺序执行
- 最外层的中间件首先执行。
- 调用next函数,把执行权交给下一个中间件。
- …
- 最内层的中间件最后执行。
- 执行结束后,把执行权交回上一层的中间件。
- …
- 最外层的中间件收回执行权之后,执行next函数后面的代码
const Koa = require('koa');
const app = new Koa();
const one = (ctx, next) => {
console.log('>> one');
next();
console.log('<< one');
}
const two = (ctx, next) => {
console.log('>> two');
next();
console.log('<< two');
}
const three = (ctx, next) => {
console.log('>> three');
next();
console.log('<< three');
}
app.use(one);
app.use(two);
app.use(three);
app.listen(3000);
>> one
>> two
>> three
<< three
<< two
<< one
如果中间件内部没有调用
next函数,那么执行权就不会传递下去
# 3.4 异步中间件
如果有异步操作(比如读取数据库),中间件就必须写成
async函数
