IT序号网

koa入门知识解答

lxf 2021年05月25日 程序员 146 0

创建koa2工程

首先初始化项目

npm init -y 项目名称

安装koa

$ npm i koa

我们创建一个目录hello-koa并作为工程目录用VS Code打开。然后,我们创建app.js,输入以下代码:

// 导入koa,和koa 1.x不同,在koa2中,我们导入的是一个class,因此用大写的Koa表示: 
const Koa = require('koa'); 
 
// 创建一个Koa对象表示web app本身: 
const app = new Koa(); 
 
// 对于任何请求,app将调用该异步函数处理请求: 
app.use(async (ctx, next) => { 
    await next(); 
    ctx.response.type = 'text/html'; 
    ctx.response.body = '<h1>Hello, koa2!</h1>'; 
}); 
 
// 在端口3000监听: 
app.listen(3000); 
console.log('app started at port 3000...');

对于每一个http请求,koa将调用我们传入的异步函数来处理:

async (ctx, next) => { 
    await next(); 
    // 设置response的Content-Type: 
    ctx.response.type = 'text/html'; 
    // 设置response的内容: 
    ctx.response.body = '<h1>Hello, koa2!</h1>'; 
}

其中,参数ctx是由koa传入的封装了request和response的变量,我们可以通过它访问request和response,next是koa传入的将要处理的下一个异步函数。

上面的异步函数中,我们首先用await next();处理下一个异步函数,然后,设置response的Content-Type和内容。

async标记的函数称为异步函数,在异步函数中,可以用await调用另一个异步函数,这两个关键字将在ES7中引入。

 

打开浏览器,输入http://localhost:3000,即可看到效果:

还可以直接用命令node app.js在命令行启动程序,或者用npm start启动。npm start命令会让npm执行定义在package.json文件中的start对应命令:

"scripts": { 
    "start": "node app.js" 
} 

koa middleware

让我们再仔细看看koa的执行逻辑。核心代码是:

app.use(async (ctx, next) => { 
    await next(); 
    ctx.response.type = 'text/html'; 
    ctx.response.body = '<h1>Hello, koa2!</h1>'; 
}); 

每收到一个http请求,koa就会调用通过app.use()注册的async函数,并传入ctxnext参数。

我们可以对ctx操作,并设置返回内容。但是为什么要调用await next()

原因是koa把很多async函数组成一个处理链,每个async函数都可以做一些自己的事情,然后用await next()来调用下一个async函数。我们把每个async函数称为middleware,这些middleware可以组合起来,完成很多有用的功能。

例如,可以用以下3个middleware组成处理链,依次打印日志,记录处理时间,输出HTML:

app.use(async (ctx, next) => { 
    console.log(`${ctx.request.method} ${ctx.request.url}`); // 打印URL 
    await next(); // 调用下一个middleware
console.log('请求处理完毕');
}); 
 
app.use(async (ctx, next) => { 
    const start = new Date().getTime(); // 当前时间 
    await next(); // 调用下一个middleware 
    const ms = new Date().getTime() - start; // 耗费时间 
    console.log(`Time: ${ms}ms`); // 打印耗费时间 
}); 
 
app.use(async (ctx, next) => { 
    await next(); 
    ctx.response.type = 'text/html'; 
    ctx.response.body = '<h1>Hello, koa2!</h1>'; 
});

请求结果:

middleware的顺序很重要,也就是调用app.use()的顺序决定了middleware的顺序。

此外,如果一个middleware没有调用await next(),会怎么办?答案是后续的middleware将不再执行了。这种情况也很常见,例如,一个检测用户权限的middleware可以决定是否继续处理请求,还是直接返回403错误:

app.use(async (ctx, next) => { 
    if (await checkUserPermission(ctx)) { 
        await next(); 
    } else { 
        ctx.response.status = 403; } }); 

理解了middleware,我们就已经会用koa了!

最后注意ctx对象有一些简写的方法,例如ctx.url相当于ctx.request.urlctx.type相当于ctx.response.type

更多别名

Request 别名

以下访问器和 Request 别名等效:

  • ctx.header
  • ctx.headers
  • ctx.method
  • ctx.method=
  • ctx.url
  • ctx.url=
  • ctx.originalUrl
  • ctx.origin
  • ctx.href
  • ctx.path
  • ctx.path=
  • ctx.query
  • ctx.query=
  • ctx.querystring
  • ctx.querystring=
  • ctx.host
  • ctx.hostname
  • ctx.fresh
  • ctx.stale
  • ctx.socket
  • ctx.protocol
  • ctx.secure
  • ctx.ip
  • ctx.ips
  • ctx.subdomains
  • ctx.is()
  • ctx.accepts()
  • ctx.acceptsEncodings()
  • ctx.acceptsCharsets()
  • ctx.acceptsLanguages()
  • ctx.get()

Response 别名

以下访问器和 Response 别名等效:

  • ctx.body
  • ctx.body=
  • ctx.status
  • ctx.status=
  • ctx.message
  • ctx.message=
  • ctx.length=
  • ctx.length
  • ctx.type=
  • ctx.type
  • ctx.headerSent
  • ctx.redirect()
  • ctx.attachment()
  • ctx.set()
  • ctx.append()
  • ctx.remove()
  • ctx.lastModified=
  • ctx.etag=


发布评论
IT序号网

微信公众号号:IT虾米 (左侧二维码扫一扫)欢迎添加!

Mac OS X ifconfig命令解释知识解答
你是第一个吃螃蟹的人
发表评论

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。