響應(Response)
Koa Response
對象是對 node 的 response 進一步抽象和封裝,提供了日常 HTTP 服務器開發中一些有用的功能。
response.header
Response header 對象。
response.socket
response.status
獲取 response status。不同於 node 在默認情況下 res.statusCode
為200,res.status
並沒有賦值。
response.status=
通過 數字狀態碼或者不區分大小寫的字符串來設置response status:
response.message
Get response status message. By default, response.message
is associated with response.status
.
response.message=
Set response status message to the given value.
response.length=
通過給定值設置 response Content-Length。
response.length
如果 Content-Length 作為數值存在,或者可以通過 res.body
來進行計算,則返回相應數值,否則返回 undefined
。
response.body
獲得 response body。
response.body=
設置 response body 為如下值:
string
writtenBuffer
writtenStream
pipedObject
json-stringifiednull
no content response
如果 res.status
沒有賦值,Koa會自動設置為 200
或 204
。
String
Content-Type 默認為 text/html 或者 text/plain,兩種默認 charset 均為 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)
獲取 response header 中字段值,field 不區分大小寫。
response.set(field, value)
ctx.set('Cache-Control', 'no-cache');
response.append(field, value)
ctx.append('Link', '<http://127.0.0.1/>');
res.set(fields)
使用對象同時設置 response header 中多個字段的值。
ctx.set({ 'Etag': '1234', 'Last-Modified': date });
res.remove(field)
移除 response header 中字段 filed
。
res.type
獲取 response Content-Type
,不包含像 "charset" 這樣的參數。
response.type=
通過 mime 類型的字符串或者文件擴展名設置 response Content-Type
response.is(types...)
const minify = require('html-minifier'); app.use(function * minifyHTML(next) { yield next; if (!ctx.response.is('html')) return; let body = ctx.body; if (!body || body.pipe) return; if (Buffer.isBuffer(body)) body = body.toString(); ctx.body = minify(body); });
res.redirect(url, [alt])
執行 [302] 重定向到對應 url
。
字符串 "back" 是一個特殊參數,其提供了 Referrer 支持。當沒有Referrer時,使用 alt
或者 /
代替。
ctx.redirect('back'); ctx.redirect('back', '/index.html'); ctx.redirect('/login'); ctx.redirect('http://google.com');
如果想要修改默認的 [302] 狀態,直接在重定向之前或者之后執行即可。如果要修改 body,需要在重定向之前執行。
ctx.status = 301; ctx.redirect('/cart'); ctx.body = 'Redirecting to shopping cart';
res.attachment([filename])
設置 "attachment" 的 Content-Disposition
,用於給客戶端發送信號來提示下載。filename 為可選參數,用於指定下載文件名。
res.headerSent
檢查 response header 是否已經發送,用於在發生錯誤時檢查客戶端是否被通知。
res.lastModified
如果存在 Last-Modified
,則以 Date
的形式返回。
res.lastModified=
以 UTC 格式設置 Last-Modified
。您可以使用 Date
或 date 字符串來進行設置。
this.response.lastModified = new Date();
res.etag=
設置 包含 "
s 的 ETag。注意沒有對應的 res.etag
來獲取其值。
this.response.etag = crypto.createHash('md5').update(this.body).digest('hex');
res.append(field, val)
在 header 的 field
后面 追加 val
。
res.vary(field)
相當於執行res.append('Vary', field)。