Powered by GitBook

koajs

响应

Koa Response 对象是 node 普通 request 对象之上的抽象, 提供了日常 HTTP server 中有用的功能.

API

response.header

响应 header 对象.

response.socket

请求socket.

response.status

返回响应状态. 默认 res.status 没有值, 而不是像 node 的 res.statusCode 默认为 200.

response.status=

使用状态码或不区分大小写的字符串设置响应状态:

  • 100 "continue"
  • 101 "switching protocols"
  • 102 "processing"
  • 200 "ok"
  • 201 "created"
  • 202 "accepted"
  • 203 "non-authoritative information"
  • 204 "no content"
  • 205 "reset content"
  • 206 "partial content"
  • 207 "multi-status"
  • 300 "multiple choices"
  • 301 "moved permanently"
  • 302 "moved temporarily"
  • 303 "see other"
  • 304 "not modified"
  • 305 "use proxy"
  • 307 "temporary redirect"
  • 400 "bad request"
  • 401 "unauthorized"
  • 402 "payment required"
  • 403 "forbidden"
  • 404 "not found"
  • 405 "method not allowed"
  • 406 "not acceptable"
  • 407 "proxy authentication required"
  • 408 "request time-out"
  • 409 "conflict"
  • 410 "gone"
  • 411 "length required"
  • 412 "precondition failed"
  • 413 "request entity too large"
  • 414 "request-uri too large"
  • 415 "unsupported media type"
  • 416 "requested range not satisfiable"
  • 417 "expectation failed"
  • 418 "i'm a teapot"
  • 422 "unprocessable entity"
  • 423 "locked"
  • 424 "failed dependency"
  • 425 "unordered collection"
  • 426 "upgrade required"
  • 428 "precondition required"
  • 429 "too many requests"
  • 431 "request header fields too large"
  • 500 "internal server error"
  • 501 "not implemented"
  • 502 "bad gateway"
  • 503 "service unavailable"
  • 504 "gateway time-out"
  • 505 "http version not supported"
  • 506 "variant also negotiates"
  • 507 "insufficient storage"
  • 509 "bandwidth limit exceeded"
  • 510 "not extended"
  • 511 "network authentication required"

注意: 不用担心没法记住这些状态码, 如果设置错误, 会有异常抛出, 并列出该状态码表, 从而帮助修改.

response.message

获取响应状态消息. 默认, response.message与response.status关联.

response.message=

设置响应状态消息为给定值.

response.length=

设置响应 Content-Length.

response.length

如果 Content-Length 存在返回相应数值, 或通过 res.body 计算得出, 否则返回 undefined.

response.body

返回响应内容.

response.body=

设置响应内容为如下值:

  • string written
  • Buffer written
  • Stream piped
  • Object json-stringified
  • null no content response

如果 res.status 没有设置, Koa 会自动设定 status 为 200 或 204.

String

Content-Type 默认设置为 text/html 或 text/plain, 两个的编码都是 utf-8. Content-Length 同样会被设置.

Buffer

Content-Type 默认设置为 application/octet-stream, 并设置 Content-Length.

Stream

Content-Type 默认设置为 application/octet-stream.

Object

Content-Type 默认设置为 application/json.

response.get(field)

获取响应头部字段值, field 区分大小写.

var etag = this.get('ETag');

response.set(field, value)

设置响应头部字段 field 为 value:

this.set('Cache-Control', 'no-cache');

response.set(fields)

使用对象同时设置多个响应头 fields:

this.set({
  'Etag': '1234',
  'Last-Modified': date
});

res.remove(field)

删除头部 field 字段.

response.type

获取响应 Content-Type 字段, 不包含参数如 "charset".

var ct = this.type;
// => "image/png"

response.type=

通过 mime 字符串或文件扩展名设置响应 Content-Type.

this.type = 'text/plain; charset=utf-8';
this.type = 'image/png';
this.type = '.png';
this.type = 'png';

注意: 当合适的 charset 可以确定, 会自动设置, 例如 res.type = 'html' 会自动设置为 "utf-8", 但是如果设置完整时, charset 不会自动设定, 如 res.type = 'text/html'.

response.is(types...)

跟 this.request.is() 非常相似. 检查响应 type 是否是提供的 types 之一. 该方法在开发修改响应内容的中间件时非常有用

例如这是一个压缩 html 响应的中间件, 他不会处理 streams 类型.

var minify = require('html-minifier');

app.use(function *minifyHTML(next){
  yield next;

  if (!this.response.is('html')) return;

  var body = this.body;
  if (!body || body.pipe) return;

  if (Buffer.isBuffer(body)) body = body.toString();
  this.body = minify(body);
});

response.redirect(url, [alt])

执行 [302] 重定向到 url.

字符 "back" 是一种特殊用法, 能提供 Referrer支持, 当没有 Referrer时 使用alt 或 "/"

this.redirect('back');
this.redirect('back', '/index.html');
this.redirect('/login');
this.redirect('http://google.com');

如果想要修改默认状态 302, 直接在重定向之前或之后设定 status, 如果想修改 body , 需要 在重定向之后执行:

this.status = 301;
this.redirect('/cart');
this.body = 'Redirecting to shopping cart';

response.attachment([filename])

设置 "attachment" 的 Content-Disposition 用于给客户端发送信号, 提示下载. 下载文件的名字可以通过参数设置.

response.headerSent

检查响应头是否已经发送. 在有错误时检查 client 是否被通知时有用.

response.lastModified

如果响应头部包含 Last-Modified, 返回 Date.

response.lastModified=

将 Last-Modified 头部设置为正确的 UTC string. 可以使用 Date 或 date 字符串设置.

this.response.lastModified = new Date();

response.etag=

设置响应的 ETag (包括 wrapped "). 注意没有对应的 res.etag 获取器.

this.response.etag = crypto.createHash('md5').update(this.body).digest('hex');

response.vary(field)

Vary on field.