1.簡書
koa是由Express原班人馬打造反粥,致力于成為一個(gè)更小、更富有表現(xiàn)力尤蒿、更健壯的Web框架讳侨。使用koa編寫web應(yīng)用,通過組合不同的generator,可以免除重復(fù)繁瑣的回調(diào)函數(shù)嵌套,并極大地提升錯(cuò)誤處理的效率铆帽。koa不在內(nèi)核方法中綁定任何中間件爹橱,它僅僅提供了一個(gè)輕量優(yōu)雅的函數(shù)庫,使得編寫Web應(yīng)用變得得心應(yīng)手窄做。
2.安裝
Koa目前需要>=0.11.x版本的node環(huán)境愧驱。并需要在執(zhí)行node的時(shí)候附帶--harmony來引入generators慰技。如果您安裝了較舊版本的node,您可以安裝n(node版本控制器)组砚,來快速安裝0.11.x
$ npm install -g n
$ n 0.11.12
$ node --harmony my-koa-app.js
3.應(yīng)用
Koa 應(yīng)用是一個(gè)包含一系列中間件 generator 函數(shù)的對(duì)象吻商。 這些中間件函數(shù)基于 request 請(qǐng)求以一個(gè)類似于棧的結(jié)構(gòu)組成并依次執(zhí)行。 Koa 類似于其他中間件系統(tǒng)(比如 Ruby's Rack 盆偿、Connect 等)今野, 然而 Koa 的核心設(shè)計(jì)思路是為中間件層提供高級(jí)語法糖封裝,以增強(qiáng)其互用性和健壯性,并使得編寫中間件變得相當(dāng)有趣光稼。
Koa 包含了像 content-negotiation(內(nèi)容協(xié)商)、cache freshness(緩存刷新)董济、proxy support(代理支持)和 redirection(重定向)等常用任務(wù)方法。 與提供龐大的函數(shù)支持不同,Koa只包含很小的一部分驯杜,因?yàn)镵oa并不綁定任何中間件。
任何教程都是從 hello world 開始的,Koa也不例外_var koa = require('koa');
var app = koa();
app.use(function *(){
this.body = 'Hello World';
});
app.listen(3000);
4.中間件級(jí)聯(lián)
Koa 的中間件通過一種更加傳統(tǒng)(您也許會(huì)很熟悉)的方式進(jìn)行級(jí)聯(lián),摒棄了以往 node 頻繁的回調(diào)函數(shù)造成的復(fù)雜代碼邏輯逃延。 我們通過 generators 來實(shí)現(xiàn)“真正”的中間件奄侠。 Connect 簡單地將控制權(quán)交給一系列函數(shù)來處理逢勾,直到函數(shù)返回攒菠。 與之不同,當(dāng)執(zhí)行到 yield next 語句時(shí)离赫,Koa 暫停了該中間件,繼續(xù)執(zhí)行下一個(gè)符合請(qǐng)求的中間件('downstrem'),然后控制權(quán)再逐級(jí)返回給上層中間件('upstream')筋帖。
下面的例子在頁面中返回 "Hello World"察净,然而當(dāng)請(qǐng)求開始時(shí)雷猪,請(qǐng)求先經(jīng)過 x-response-time 和 logging 中間件共屈,并記錄中間件執(zhí)行起始時(shí)間。 然后將控制權(quán)交給 reponse 中間件。當(dāng)中間件運(yùn)行到 yield next 時(shí)牍帚,函數(shù)掛起并將控制前交給下一個(gè)中間件。當(dāng)沒有中間件執(zhí)行 yield next 時(shí)健爬,程序棧會(huì)逆序喚起被掛起的中間件來執(zhí)行接下來的代碼久脯。var koa = require('koa');
var app = koa();
// x-response-time
app.use(function *(next){
var start = new Date;
yield next;
var ms = new Date - start;
this.set('X-Response-Time', ms + 'ms');
});
// logger
app.use(function *(next){
var start = new Date;
yield next;
var ms = new Date - start;
console.log('%s %s - %s', this.method, this.url, ms);
});
// response
app.use(function *(){
this.body = 'Hello World';
});
app.listen(3000);
5.配置
應(yīng)用配置是 app 實(shí)例屬性,目前支持的配置項(xiàng)如下:
- app.name 應(yīng)用名稱(可選項(xiàng))
- app.env 默認(rèn)為 NODE_ENV 或者 development
- app.proxy 如果為 true蛆挫,則解析 "Host" 的 header 域,并支持 X-Forwarded-Host
- app.subdomainOffset 默認(rèn)為2骑素,表示 .subdomains 所忽略的字符偏移量塔粒。
app.listen(...)
Koa 應(yīng)用并非是一個(gè) 1-to-1 表征關(guān)系的 HTTP 服務(wù)器。 一個(gè)或多個(gè)Koa應(yīng)用可以被掛載到一起組成一個(gè)包含單一 HTTP 服務(wù)器的大型應(yīng)用群筐摘。
如下為一個(gè)綁定3000端口的簡單 Koa 應(yīng)用卒茬,其創(chuàng)建并返回了一個(gè) HTTP 服務(wù)器,為 Server#listen() 傳遞指定參數(shù)
var koa = require('koa');
var app = koa();
app.listen(3000);
app.listen(...) 實(shí)際上是以下代碼的語法糖:
ar http = require('http');
var koa = require('koa');
var app = koa();
http.createServer(app.callback()).listen(3000);
這意味著您可以同時(shí)支持 HTTPS 和 HTTPS咖熟,或者在多個(gè)端口監(jiān)聽同一個(gè)應(yīng)用圃酵。
var http = require('http');
var koa = require('koa');
var app = koa();
http.createServer(app.callback()).listen(3000);
http.createServer(app.callback()).listen(3001);
app.callback()
返回一個(gè)適合 http.createServer() 方法的回調(diào)函數(shù)用來處理請(qǐng)求。 您也可以使用這個(gè)回調(diào)函數(shù)將您的app掛載在 Connect/Express 應(yīng)用上馍管。
app.use(function)
為應(yīng)用添加指定的中間件
app.keys=
設(shè)置簽名Cookie密鑰郭赐,該密鑰會(huì)被傳遞給 [KeyGrip]
當(dāng)然,您也可以自己生成 KeyGrip 實(shí)例:app.keys = ['im a newer secret', 'i like turtle'];
app.keys = new KeyGrip(['im a newer secret', 'i like turtle'], 'sha256');
在進(jìn)行cookie簽名時(shí)确沸,只有設(shè)置 signed 為 true 的時(shí)候捌锭,才會(huì)使用密鑰進(jìn)行加密:this.cookies.set('name', 'tobi', { signed: true });
錯(cuò)誤處理
默認(rèn)情況下Koa會(huì)將所有錯(cuò)誤信息輸出到 stderr,除非 NODE_ENV 是 "test"罗捎。為了實(shí)現(xiàn)自定義錯(cuò)誤處理邏輯(比如 centralized logging)观谦,您可以添加 "error" 事件監(jiān)聽器。
app.on('error', function(err){
log.error('server error', err);
});
如果錯(cuò)誤發(fā)生在 請(qǐng)求/響應(yīng) 環(huán)節(jié)桨菜,并且其不能夠響應(yīng)客戶端時(shí)豁状,Contenxt 實(shí)例也會(huì)被傳遞到 error 事件監(jiān)聽器的回調(diào)函數(shù)里。
app.on('error', function(err, ctx){
log.error('server error', err, ctx);
});
當(dāng)發(fā)生錯(cuò)誤但仍能夠響應(yīng)客戶端時(shí)(比如沒有數(shù)據(jù)寫到socket中)倒得,Koa會(huì)返回一個(gè)500錯(cuò)誤(Internal Server Error)泻红。
無論哪種情況,Koa都會(huì)生成一個(gè)應(yīng)用級(jí)別的錯(cuò)誤信息霞掺,以便實(shí)現(xiàn)日志記錄等目的承桥。
Context(上下文)
Koa Context 將 node 的 request 和 response 對(duì)象封裝在一個(gè)單獨(dú)的對(duì)象里面,其為編寫 web 應(yīng)用和 API 提供了很多有用的方法根悼。
這些操作在 HTTP 服務(wù)器開發(fā)中經(jīng)常使用凶异,因此其被添加在上下文這一層,而不是更高層框架中挤巡,因此將迫使中間件需要重新實(shí)現(xiàn)這些常用方法剩彬。
context 在每個(gè) request 請(qǐng)求中被創(chuàng)建,在中間件中作為接收器(receiver)來引用矿卑,或者通過 this 標(biāo)識(shí)符來引用:
app.use(function *(){
this; // is the Context
this.request; // is a koa Request
this.response; // is a koa Response
});
許多 context 的訪問器和方法為了便于訪問和調(diào)用喉恋,簡單的委托給他們的 ctx.request 和 ctx.response 所對(duì)應(yīng)的等價(jià)方法, 比如說 ctx.type 和 ctx.length 代理了 response 對(duì)象中對(duì)應(yīng)的方法,ctx.path 和 ctx.method 代理了 request 對(duì)象中對(duì)應(yīng)的方法轻黑。
API
Context 詳細(xì)的方法和訪問器糊肤。
ctx.req
Node 的 request 對(duì)象。
ctx.res
Node 的 response 對(duì)象氓鄙。
Koa 不支持 直接調(diào)用底層 res 進(jìn)行響應(yīng)處理馆揉。請(qǐng)避免使用以下 node 屬性:
- res.statusCode
- res.writeHead()
- res.write()
- res.end()
ctx.request
Koa 的 Request 對(duì)象。
ctx.response
Koa 的 Response 對(duì)象抖拦。
ctx.app
應(yīng)用實(shí)例引用升酣。
ctx.cookies.get(name, [options])
獲得 cookie 中名為 name 的值,options 為可選參數(shù):
- 'signed': 如果為 true态罪,表示請(qǐng)求時(shí) cookie 需要進(jìn)行簽名噩茄。
注意:Koa 使用了 Express 的 cookies 模塊,options 參數(shù)只是簡單地直接進(jìn)行傳遞复颈。
ctx.cookies.set(name, value, [options])
設(shè)置 cookie 中名為 name 的值绩聘,options 為可選參數(shù):
- signed: 是否要做簽名
- expires: cookie 有效期時(shí)間
- path: cookie 的路徑,默認(rèn)為 /'
- domain: cookie 的域
- secure: false 表示 cookie 通過 HTTP 協(xié)議發(fā)送耗啦,true 表示 cookie 通過 HTTPS 發(fā)送凿菩。
- httpOnly: true 表示 cookie 只能通過 HTTP 協(xié)議發(fā)送
注意:Koa 使用了 Express 的 cookies 模塊,options 參數(shù)只是簡單地直接進(jìn)行傳遞芹彬。
ctx.throw(msg, [status])
拋出包含 .status 屬性的錯(cuò)誤,默認(rèn)為 500叉庐。該方法可以讓 Koa 準(zhǔn)確的響應(yīng)處理狀態(tài)舒帮。 Koa支持以下組合:
this.throw(403)
this.throw('name required', 400)
this.throw(400, 'name required')
this.throw('something exploded')
this.throw('name required', 400) 等價(jià)于:
var err = new Error('name required');
err.status = 400;
throw err;
注意:這些用戶級(jí)錯(cuò)誤被標(biāo)記為 err.expose,其意味著這些消息被準(zhǔn)確描述為對(duì)客戶端的響應(yīng)陡叠,而并非使用在您不想泄露失敗細(xì)節(jié)的場(chǎng)景中玩郊。
ctx.respond
為了避免使用 Koa 的內(nèi)置響應(yīng)處理功能,您可以直接賦值 this.repond = false;枉阵。如果您不想讓 Koa 來幫助您處理 reponse译红,而是直接操作原生 res 對(duì)象,那么請(qǐng)使用這種方法兴溜。
注意: 這種方式是不被 Koa 支持的侦厚。其可能會(huì)破壞 Koa 中間件和 Koa 本身的一些功能。其只作為一種 hack 的方式拙徽,并只對(duì)那些想要在 Koa 方法和中間件中使用傳統(tǒng) fn(req, res) 方法的人來說會(huì)帶來便利刨沦。
Request aliases
以下訪問器和別名與 Request 等價(jià):
- ctx.header
- ctx.method
- ctx.method=
- ctx.url
- ctx.url=
- ctx.originalUrl
- 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 aliases
以下訪問器和別名與 Response 等價(jià):
- ctx.body
- ctx.body=
- ctx.status
- ctx.status=
- ctx.length=
- ctx.length
- ctx.type=
- ctx.type
- ctx.headerSent
- ctx.redirect()
- ctx.attachment()
- ctx.set()
- ctx.remove()
- ctx.lastModified=
- ctx.etag=
請(qǐng)求(Request)
Koa Request 對(duì)象是對(duì) node 的 request 進(jìn)一步抽象和封裝,提供了日常 HTTP 服務(wù)器開發(fā)中一些有用的功能膘怕。
API
req.header
請(qǐng)求頭對(duì)象
req.method
請(qǐng)求方法
req.method=
設(shè)置請(qǐng)求方法想诅,在實(shí)現(xiàn)中間件時(shí)非常有用,比如 methodOverride()。
req.length
以數(shù)字的形式返回 request 的內(nèi)容長度(Content-Length)来破,或者返回 undefined篮灼。
req.url
獲得請(qǐng)求url地址。
req.url=
設(shè)置請(qǐng)求地址徘禁,用于重寫url地址時(shí)诅诱。
req.originalUrl
獲取請(qǐng)求原始地址。
req.path
獲取請(qǐng)求路徑名晌坤。
req.path=
設(shè)置請(qǐng)求路徑名逢艘,并保留請(qǐng)求參數(shù)(就是url中?后面的部分)。
req.querystring
獲取查詢參數(shù)字符串(url中?后面的部分)骤菠,不包含 ?
req.querystring=
設(shè)置查詢參數(shù)它改。
req.search
獲取查詢參數(shù)字符串,包含 ?商乎。
req.search=
設(shè)置查詢參數(shù)字符串央拖。
req.host
獲取 host (hostname:port)。 當(dāng) app.proxy 設(shè)置為 true 時(shí)鹉戚,支持 X-Forwarded-Host鲜戒。
req.hostname
獲取 hostname。當(dāng) app.proxy 設(shè)置為 true 時(shí)抹凳,支持 X-Forwarded-Host
req.type
獲取請(qǐng)求 Content-Type遏餐,不包含像 "charset" 這樣的參數(shù)。
var ct = this.request.type;
// => "image/png"
req.charset
獲取請(qǐng)求 charset赢底,沒有則返回 undefined:
this.request.charset
// => "utf-8"
req.query
將查詢參數(shù)字符串進(jìn)行解析并以對(duì)象的形式返回失都,如果沒有查詢參數(shù)字字符串則返回一個(gè)空對(duì)象。
注意:該方法不支持嵌套解析幸冻。
比如 "color=blue&size=small":
{
color: 'blue',
size: 'small'
}
req.query=
根據(jù)給定的對(duì)象設(shè)置查詢參數(shù)字符串粹庞。
注意:該方法不支持嵌套對(duì)象。
this.query = { next: '/login' };
req.fresh
檢查請(qǐng)求緩存是否 "fresh"(內(nèi)容沒有發(fā)生變化)洽损。該方法用于在 If-None-Match / ETag, If-Modified-Since 和 Last-Modified 中進(jìn)行緩存協(xié)調(diào)庞溜。當(dāng)在 response headers 中設(shè)置一個(gè)或多個(gè)上述參數(shù)后,該方法應(yīng)該被使用碑定。
this.set('ETag', '123');
// cache is ok
if (this.fresh) {
this.status = 304;
return;
}
// cache is stale
// fetch new data
this.body = yield db.find('something');
req.stale
與 req.fresh 相反流码。
req.protocol
返回請(qǐng)求協(xié)議,"https" 或者 "http"延刘。 當(dāng) app.proxy 設(shè)置為 true 時(shí)旅掂,支持 X-Forwarded-Host。
req.secure
簡化版 this.protocol == "https"访娶,用來檢查請(qǐng)求是否通過 TLS 發(fā)送商虐。
req.ip
請(qǐng)求遠(yuǎn)程地址觉阅。 當(dāng) app.proxy 設(shè)置為 true 時(shí),支持 X-Forwarded-Host秘车。
req.ips
當(dāng) X-Forwarded-For 存在并且 app.proxy 有效典勇,將會(huì)返回一個(gè)有序(從 upstream 到 downstream)ip 數(shù)組。 否則返回一個(gè)空數(shù)組叮趴。
req.subdomains
以數(shù)組形式返回子域名割笙。
子域名是在host中逗號(hào)分隔的主域名前面的部分。默認(rèn)情況下眯亦,應(yīng)用的域名假設(shè)為host中最后兩部分伤溉。其可通過設(shè)置 app.subdomainOffset 進(jìn)行更改
舉例來說,如果域名是 "tobi.ferrets.example.com":
如果沒有設(shè)置 app.subdomainOffset妻率,其 subdomains 為 ["ferrets", "tobi"]乱顾。 如果設(shè)置 app.subdomainOffset 為3,其 subdomains 為 ["tobi"]宫静。
req.is(type)
檢查請(qǐng)求所包含的 "Content-Type" 是否為給定的 type 值走净。 如果沒有 request body,返回 undefined孤里。 如果沒有 content type伏伯,或者匹配失敗,返回 false捌袜。 否則返回匹配的 content-type说搅。
// With Content-Type: text/html; charset=utf-8
this.is('html'); // => 'html'
this.is('text/html'); // => 'text/html'
this.is('text/', 'text/html'); // => 'text/html'
// When Content-Type is application/json
this.is('json', 'urlencoded'); // => 'json'
this.is('application/json'); // => 'application/json'
this.is('html', 'application/'); // => 'application/json'
this.is('html'); // => false
比如說您希望保證只有圖片發(fā)送給指定路由:
if (this.is('image/*')) {
// process
} else {
this.throw(415, 'images only!');
}
Content Negotiation
Koa request
對(duì)象包含 content negotiation 功能(由 accepts 和 negotiator 提供):
- req.accepts(types)
- req.acceptsEncodings(types)
- req.acceptsCharsets(charsets)
- req.acceptsLanguages(langs)
如果沒有提供 types,將會(huì)返回所有的可接受類型虏等。
如果提供多種 types弄唧,將會(huì)返回最佳匹配類型。如果沒有匹配上博其,則返回 false套才,您應(yīng)該給客戶端返回 406 "Not Acceptable"迂猴。
為了防止缺少 accept headers 而導(dǎo)致可以接受任意類型慕淡,將會(huì)返回第一種類型。因此沸毁,您提供的類型順序非常重要峰髓。
req.accepts(types)
檢查給定的類型 types(s) 是否可被接受,當(dāng)為 true 時(shí)返回最佳匹配息尺,否則返回 false携兵。type 的值可以是一個(gè)或者多個(gè) mime 類型字符串。 比如 "application/json" 擴(kuò)展名為 "json"搂誉,或者數(shù)組 ["json", "html", "text/plain"]徐紧。
// Accept: text/html
this.accepts('html');
// => "html"
// Accept: text/*, application/json
this.accepts('html');
// => "html"
this.accepts('text/html');
// => "text/html"
this.accepts('json', 'text');
// => "json"
this.accepts('application/json');
// => "application/json"
// Accept: text/*, application/json
this.accepts('image/png');
this.accepts('png');
// => false
// Accept: text/*;q=.5, application/json
this.accepts(['html', 'json']);
this.accepts('html', 'json');
// => "json"
// No Accept header
this.accepts('html', 'json');
// => "html"
this.accepts('json', 'html');
// => "json"
this.accepts() 可以被調(diào)用多次,或者使用 switch:
switch (this.accepts('json', 'html', 'text')) {
case 'json': break;
case 'html': break;
case 'text': break;
default: this.throw(406, 'json, html, or text only');
}
req.acceptsEncodings(encodings)
檢查 encodings 是否可以被接受,當(dāng)為 true 時(shí)返回最佳匹配并级,否則返回 false拂檩。 注意:您應(yīng)該在 encodings 中包含 identity。
// Accept-Encoding: gzip
this.acceptsEncodings('gzip', 'deflate', 'identity');
// => "gzip"
this.acceptsEncodings(['gzip', 'deflate', 'identity']);
// => "gzip"
當(dāng)沒有傳遞參數(shù)時(shí)嘲碧,返回包含所有可接受的 encodings 的數(shù)組:
// Accept-Encoding: gzip, deflate
this.acceptsEncodings();
// => ["gzip", "deflate", "identity"]
注意:如果客戶端直接發(fā)送 identity;q=0 時(shí)稻励,identity encoding(表示no encoding) 可以不被接受。雖然這是一個(gè)邊界情況愈涩,您仍然應(yīng)該處理這種情況望抽。
req.acceptsCharsets(charsets)
檢查 charsets 是否可以被接受,如果為 true 則返回最佳匹配履婉, 否則返回 false煤篙。
// Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5
this.acceptsCharsets('utf-8', 'utf-7');
// => "utf-8"
this.acceptsCharsets(['utf-7', 'utf-8']);
// => "utf-8
當(dāng)沒有傳遞參數(shù)時(shí), 返回包含所有可接受的 charsets 的數(shù)組:
// Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5
this.acceptsCharsets();
// => ["utf-8", "utf-7", "iso-8859-1"]
req.acceptsLanguages(langs)
檢查 langs 是否可以被接受谐鼎,如果為 true 則返回最佳匹配舰蟆,否則返回 false。
// Accept-Language: en;q=0.8, es, pt
this.acceptsLanguages('es', 'en');
// => "es"
this.acceptsLanguages(['en', 'es']);
// => "es"
當(dāng)沒有傳遞參數(shù)時(shí)狸棍,返回包含所有可接受的 langs 的數(shù)組:
// Accept-Language: en;q=0.8, es, pt
this.acceptsLanguages();
// => ["es", "pt", "en"]
req.idempotent
檢查請(qǐng)求是否為冪等(idempotent)身害。
req.socket
返回請(qǐng)求的socket。
req.get(field)
返回請(qǐng)求 header 中對(duì)應(yīng) field 的值草戈。
響應(yīng)(Response)
Koa Response 對(duì)象是對(duì) node 的 response 進(jìn)一步抽象和封裝塌鸯,提供了日常 HTTP 服務(wù)器開發(fā)中一些有用的功能
API
res.header
Response header 對(duì)象。
res.socket
Request socket唐片。
res.status
獲取 response status丙猬。不同于 node 在默認(rèn)情況下 res.statusCode 為200,res.status 并沒有賦值
res.statusString
Response status 字符串
res.status=
通過 數(shù)字狀態(tài)碼或者不區(qū)分大小寫的字符串來設(shè)置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"
注意:不用擔(dān)心記不住這些字符串费韭,如果您設(shè)置錯(cuò)誤茧球,會(huì)有異常拋出,并列出該狀態(tài)碼表來幫助您進(jìn)行更正星持。
res.length=
通過給定值設(shè)置 response Content-Length
res.length
如果 Content-Length 作為數(shù)值存在抢埋,或者可以通過 res.body 來進(jìn)行計(jì)算,則返回相應(yīng)數(shù)值督暂,否則返回 undefined揪垄。
res.body
獲得 response body。
res.body=
設(shè)置 response body 為如下值:
- string written
- Buffer written
- Stream piped
- Object json-stringified
- null no content response
如果 res.status 沒有賦值逻翁,Koa會(huì)自動(dòng)設(shè)置為 200 或 204饥努。
String
Content-Type 默認(rèn)為 text/html 或者 text/plain,兩種默認(rèn) charset 均為 utf-8八回。 Content-Length 同時(shí)會(huì)被設(shè)置酷愧。
Buffer
Content-Type 默認(rèn)為 application/octet-stream驾诈,Content-Length同時(shí)被設(shè)置。
Stream
Content-Type 默認(rèn)為 application/octet-stream
Object
Content-Type 默認(rèn)為 application/json溶浴。
res.get(field)
獲取 response header 中字段值翘鸭,field 不區(qū)分大小寫。
var etag = this.get('ETag');
res.set(field, value)
設(shè)置 response header 字段 field 的值為 value
this.set('Cache-Control', 'no-cache');
res.set(fields)
使用對(duì)象同時(shí)設(shè)置 response header 中多個(gè)字段的值戳葵。
this.set({
'Etag': '1234',
'Last-Modified': date
});
res.remove(field)
移除 response header 中字段 filed就乓。
res.type
獲取 response Content-Type,不包含像 "charset" 這樣的參數(shù)拱烁。
var ct = this.type;
// => "image/png"
res.type=
通過 mime 類型的字符串或者文件擴(kuò)展名設(shè)置 response Content-Type
this.type = 'text/plain; charset=utf-8';
this.type = 'image/png';
this.type = '.png';
this.type = 'png';
注意:當(dāng)可以根據(jù) res.type 確定一個(gè)合適的 charset 時(shí)生蚁,charset 會(huì)自動(dòng)被賦值。 比如 res.type = 'html' 時(shí)戏自,charset 將會(huì)默認(rèn)設(shè)置為 "utf-8"邦投。然而當(dāng)完整定義為 res.type = 'text/html'時(shí),charset 不會(huì)自動(dòng)設(shè)置擅笔。
res.redirect(url, [alt])
執(zhí)行 [302] 重定向到對(duì)應(yīng) url志衣。
字符串 "back" 是一個(gè)特殊參數(shù),其提供了 Referrer 支持猛们。當(dāng)沒有Referrer時(shí)念脯,使用 alt 或者 / 代替。
this.redirect('back');
this.redirect('back', '/index.html');
this.redirect('/login');
this.redirect('http://google.com');
如果想要修改默認(rèn)的 [302] 狀態(tài)弯淘,直接在重定向之前或者之后執(zhí)行即可绿店。如果要修改 body,需要在重定向之前執(zhí)行庐橙。
this.status = 301;
this.redirect('/cart');
this.body = 'Redirecting to shopping cart';
res.attachment([filename])
設(shè)置 "attachment" 的 Content-Disposition假勿,用于給客戶端發(fā)送信號(hào)來提示下載。filename 為可選參數(shù)态鳖,用于指定下載文件名转培。
res.headerSent
檢查 response header 是否已經(jīng)發(fā)送,用于在發(fā)生錯(cuò)誤時(shí)檢查客戶端是否被通知浆竭。
res.lastModified
如果存在 Last-Modified浸须,則以 Date 的形式返回。
res.lastModified=
以 UTC 格式設(shè)置 Last-Modified兆蕉。您可以使用 Date 或 date 字符串來進(jìn)行設(shè)置羽戒。
this.response.lastModified = new Date();
res.etag=
設(shè)置 包含 "s 的 ETag缤沦。注意沒有對(duì)應(yīng)的 res.etag 來獲取其值虎韵。
this.response.etag = crypto.createHash('md5').update(this.body).digest('hex');
res.append(field, val)
在 header 的 field 后面 追加 val。
res.vary(field)
相當(dāng)于執(zhí)行res.append('Vary', field)缸废。