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)函数和中间件的人提供便利。

你可能感兴趣的:(Koa2的Context对象)