Koa2的Context对象

Context

Koa Context将节点的请求和响应对象封装到单个对象中,该对象为编写Web应用程序和API提供了许多有用的方法。这些操作在HTTP服务器开发中经常使用,它们被添加在此级别而不是更高级别的框架中,这迫使中间件重新实现此功能。

每个请求都会创建一个Context,并在中间件中作为接收者或ctx标识符引用,如下面的代码片段所示:

app.use(async ctx => {
  ctx; // is the Context
  ctx.request; // is a Koa Request
  ctx.response; // is a Koa Response
});

为方便起见,许多上下文的访问器和方法与委托给它们的ctx.requestctx.response是相同的。

例如,ctx.typectx.length委托给Respone对象,ctx.typeresponse.type相同,ctx.lengthresponse.length相同。
ctx.pathctx.method委托给Request对象,同理。

API

ctx.req

Node的请求对象。

ctx.res

Node的相应对象。

Koa的响应处理是不能被传递的。请避免使用以下的Node属性/方法:

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

ctx.request

Koa请求对象

ctx.response

Koa响应对象

ctx.state

这是适合你给中间件或者前端页面传递信息的命名空间。

ctx.state.user = await User.find(id);

ctx.app

应用实例引用

ctx.cookies.get(name, [options])

ctx.cookies.set(name, value, [options])

  • maxAge
  • signed
  • expires
  • path 默认是 '/'
  • domain
  • secure
  • httpOnly 默认是 true
  • overwrite,一个布尔值,指示是否覆盖以前设置的同名cookie(默认为false)。如果是这样,则在设置此cookie时,将在Set-Cookie标头中过滤掉在相同请求期间设置的具有相同名称(无论路径或域)的所有cookie。

ctx.throw([status], [msg], [properties])

Helper方法抛出一个错误,其中.status属性默认为500,这将允许Koa做出适当的响应。允许以下组合:

ctx.throw(400);
ctx.throw(400, 'name required');
ctx.throw(400, 'name required', { user: user });

例如ctx.throw(400, 'name required')与下面相等:

const err = new Error('name required');
err.status = 400;
err.expose = true;
throw err;

请注意,这些是用户级错误,并使用err.expose标记,这意味着消息适用于客户端响应,这通常不是错误消息的情况,因为您不希望泄漏故障详细信息。

您可以选择传递一个属性对象,该对象按原样合并到错误中,对于装饰向上游请求者报告的机器友好错误很有用。

Koa使用http-errors创建错误。

ctx.assert(value, [status], [msg], [properties])

当value不存在的时候抛出一个错误,与.throw()类似。与Node的assert()方法类似。

ctx.assert(ctx.state.user, 401, 'User not found. Please login!');

Koa使用http-assert进行断言。

ctx.respond

要绕过Koa的内置响应处理,您可以显式设置ctx.respond = false;。如果要写入原始res对象而不是让Koa为您处理响应,请使用此选项。

请注意,Koa不支持使用此功能。这可能会破坏Koa中间件和Koa本身的预期功能。此功能只是为那些希望在Koa中使用传统fn(req,res)函数和中间件的人提供便利。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,425评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,058评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,186评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,848评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,249评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,554评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,830评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,536评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,239评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,505评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,004评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,346评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,999评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,060评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,821评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,574评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,480评论 2 267

推荐阅读更多精彩内容

  • 1.简书 koa是由Express原班人马打造,致力于成为一个更小、更富有表现力、更健壮的Web框架。使用koa编...
    不去解释阅读 2,622评论 0 11
  • 原文链接:http://www.jianshu.com/p/6b816c609669 前传 出于兴趣最近开始研究k...
    悬笔e绝阅读 7,112评论 1 11
  • Koa 学习 历史 Express Express是第一代最流行的web框架,它对Node.js的http进行了封...
    Junting阅读 2,756评论 0 0
  • Koa 必须使用 7.6 以上的版本。如果你的版本低于这个要求,就要先升级 Node。 基本用法 Koa 提供一个...
    Gukson666阅读 2,407评论 0 1
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,099评论 18 139