cp from : https://blog.csdn.net/gebitan505/article/details/58585846
superagent是nodejs里一個非常方便的客戶端請求代理模塊，當你想處理get,post,put,delete,head請求時,你就應該想起該用它了:)
SuperAgent
superagent 是一個輕量的,漸進式的ajax api,可讀性好,學習曲線低,內部依賴nodejs原生的請求api,適用於nodejs環境下.
一個簡單的post請求，並設置請求頭信息的例子
request .post('/api/pet') .send({ name: 'Manny', species: 'cat' }) .set('X-API-Key', 'foobar') .set('Accept', 'application/json') .end(function(res){ if (res.ok) { alert('yay got ' + JSON.stringify(res.body)); } else { alert('Oh no! error ' + res.text); } });測試文檔
這個鏈接文檔，是用Mocha’s文檔自動輸出的,下面提供了這個測試文檔對應的源文件
請求基礎
一個請求的初始化可以用請求對象里合適的方法來執行，然后調用end()來發送請求,下面是一個簡單的get請求
request .get('/search') .end(function(res){ });請求方法也可以通過參數傳遞:
request('GET', '/search').end(callback);node客戶端也允許提供絕對路徑:
request .get('http://example.com/search') .end(function(res){ });delete,head,post,put和別的http動作都可以使用,來換個方法看看:
request .head('/favicon.ico') .end(function(res){ });delete是一個特列,因為它是系統保留的關鍵字,所以應該用.del()這個名字:
request .del('/user/1') .end(function(res){ });http請求默認的方法為get,所以就像你看到的,下面的這個例子也是可用的:
request('/search', function(res){ });設置頭字段
設置頭字段非常簡單，只需調用.set()方法，傳遞一個名稱和值就行:
request .get('/search') .set('API-Key', 'foobar') .set('Accept', 'application/json') .end(callback);你也可以直接傳遞一個對象進去，這樣一次就可以修改多個頭字段:
request .get('/search') .set({ 'API-Key': 'foobar', Accept: 'application/json' }) .end(callback);Get請求
當使用get請求傳遞查詢字符串的時候，用.query()方法,傳遞一個對象就可以,下面的代碼將產生一個/search?query=Manny&range=1..5&order=desc請求:
request .get('/search') .query({ query: 'Manny' }) .query({ range: '1..5' }) .query({ order: 'desc' }) .end(function(res){ });或者傳一個單獨的大對象:
request .get('/search') .query({ query: 'Manny', range: '1..5', order: 'desc' }) .end(function(res){ });.query()方法也允許傳遞字符串:
request .get('/querystring') .query('search=Manny&range=1..5') .end(function(res){ });或者字符串拼接:
request .get('/querystring') .query('search=Manny') .query('range=1..5') .end(function(res){ });POST/PUT請求
一個典型的json post請求看起來就像下面的那樣，設置一個合適的Content-type頭字段，然后寫入一些數據，在這個例子里只是json字符串:
request.post('/user') .set('Content-Type', 'application/json') .send('{"name":"tj","pet":"tobi"}') .end(callback)因為json非常通用，所以就作為默認的Content-type,下面的例子跟上面的一樣:
request.post('/user') .send({ name: 'tj', pet: 'tobi' }) .end(callback)或者調用多次.send()方法:
request.post('/user') .send({ name: 'tj' }) .send({ pet: 'tobi' }) .end(callback)默認發送字符串，將設置Content-type為application/x-www-form-urlencoded,多次調用將會通過&來連接，這里的結果為name=tj&pet=tobi:
request.post('/user') .send('name=tj') .send('pet=tobi') .end(callback);superagent的請求數據格式化是可以擴展的，不過默認支持form和json兩種格式,想發送數據以application/x-www-form-urlencoded類型的話，則可以簡單的調用.type()方法傳遞form參數就行，這里默認是json,下面的請求將會postname=tj&pet=tobi內容:
request.post('/user') .type('form') .send({ name: 'tj' }) .send({ pet: 'tobi' }) .end(callback)注意:form是form-data和urlencoded的別名,為了向后兼容
設置Content-Type
常見的方案是使用.set()方法:
request.post('/user') .set('Content-Type', 'application/json')一個簡便的方法是調用.type()方法，傳遞一個規范的MIME名稱，包括type/subtype,或者一個簡單的后綴就像xml,json,png這樣，例如:
request.post('/user') .type('application/json') request.post('/user') .type('json') request.post('/user') .type('png')設置接受類型
跟.type()簡便方法一樣，這里也可以調用.accept()方法來設置接受類型，這個值將會被request.types所引用，支持傳遞一個規范的MIME名稱，包括type/subtype,或者一個簡單的后綴就像xml,json,png這樣,例如:
request.get('/user') .accept('application/json') request.get('/user') .accept('json') request.get('/user') .accept('png')查詢字符串
當用.send(obj)方法來發送一個post請求，並且希望傳遞一些查詢字符串，可以調用.query()方法,比如向?format=json&dest=/login發送post請求:
request .post('/') .query({ format: 'json' }) .query({ dest: '/login' }) .send({ post: 'data', here: 'wahoo' }) .end(callback);解析響應內容
superagent會解析一些常用的格式給請求者，當前支持application/x-www-form-urlencoded,application/json,multipart/form-data.
JSON/Urlencoded
res.body是解析后的內容對象,比如一個請求響應'{"user":{"name":"tobi"}}'字符串,res.body.user.name將會返回tobi,同樣的，x-www-form-urlencoded格式的user[name]=tobi解析完的值，也是一樣的.
Multipart
nodejs客戶端通過Formidable模塊來支持multipart/form-data類型,當解析一個multipart響應時,res.files屬性就可以用.假設一個請求響應下面的數據:
--whoop Content-Disposition: attachment; name="image"; filename="tobi.png" Content-Type: image/png ... data here ... --whoop Content-Disposition: form-data; name="name" Content-Type: text/plain Tobi --whoop--你將可以獲取到res.body.name名為’Tobi’,res.files.image為一個file對象,包括一個磁盤文件路徑，文件名稱，還有其它的文件屬性.
響應屬性
響應一般會提供很多有用的標識以及屬性,都在response對象里，按照respone.text,解析后的response.body,頭字段，一些標識的順序來排列.
Response text
res.text包含未解析前的響應內容，一般只在mime類型能夠匹配text/,json,x-www-form-urlencoding的情況下，默認為nodejs客戶端提供,這是為了節省內存.因為當響應以文件或者圖片大內容的情況下影響性能.
Response body
跟請求數據自動序列化一樣，響應數據也會自動的解析，當為一個Content-Type定義一個解析器后，就能自動解析，默認解析包含application/json和application/x-www-form-urlencoded,可以通過訪問res.body來訪問解析對象.
Response header fields
res.header包含解析之后的響應頭數據,鍵值都是node處理成小寫字母形式，比如res.header['content-length'].
Response Content-Type
Content-Type響應頭字段是一個特列，服務器提供res.type來訪問它，默認res.charset是空的,如果有的話，則自動填充，例如Content-Type值為text/html; charset=utf8,則res.type為text/html,res.charst為utf8.
Response status
響應狀態標識可以用來判斷請求是否成功，除此之外，可以用superagent來構建理想的restful服務器,這些標識目前定義為:
var type = status / 100 | 0; // status / class res.status = status; res.statusType = type; // basics res.info = 1 == type; res.ok = 2 == type; res.clientError = 4 == type; res.serverError = 5 == type; res.error = 4 == type || 5 == type; // sugar res.accepted = 202 == status; res.noContent = 204 == status || 1223 == status; res.badRequest = 400 == status; res.unauthorized = 401 == status; res.notAcceptable = 406 == status; res.notFound = 404 == status; res.forbidden = 403 == status;中止請求
可以通過req.abort()來中止請求.
請求超時
可以通過req.timeout()來定義超時時間,然后當超時錯誤發生時，為了區別於別的錯誤,err.timeout屬性被定義為超時時間,注意,當超時錯誤發生后，后續的請求都會被重定向.不是每個請求.
基礎驗證
nodejs客戶端可以通過兩種方式來達到驗證的目的,第一個是傳遞一個像這樣的url,user:pass:
request.get('http://tobi:learnboost[@local](/user/local)').end(callback);第二種是調用.auth()方法:
request .get('http://local') .auth('tobo', 'learnboost') .end(callback);跟隨重定向
默認是向上跟隨5個重定向，不過可以通過調用.res.redirects(n)來設置個數:
request .get('/some.png') .redirects(2) .end(callback);管道數據
nodejs客戶端允許使用一個請求流來輸送數據,比如請求一個文件作為輸出流:
var request = require('superagent') , fs = require('fs'); var stream = fs.createReadStream('path/to/my.json'); var req = request.post('/somewhere'); req.type('json'); stream.pipe(req);或者輸送一個響應流到文件中:
var request = require('superagent') , fs = require('fs'); var stream = fs.createWriteStream('path/to/my.json'); var req = request.get('/some.json'); req.pipe(stream);復合請求
superagent用來構建復合請求非常不錯,提供了低級和高級的api方法.
低級的api是使用多個部分來表現一個文件或者字段，.part()方法返回一個新的部分,提供了跟request本身相似的api方法.
var req = request.post('/upload'); req.part() .set('Content-Type', 'image/png') .set('Content-Disposition', 'attachment; filename="myimage.png"') .write('some image data') .write('some more image data'); req.part() .set('Content-Disposition', 'form-data; name="name"') .set('Content-Type', 'text/plain') .write('tobi'); req.end(callback);附加文件
上面提及的高級api方法，可以通用.attach(name, [path], [filename])和.field(name, value)這兩種形式來調用.添加多個附件也比較簡單，只需要給附件提供自定義的文件名稱,同樣的基礎名稱也要提供.
request .post('/upload') .attach('avatar', 'path/to/tobi.png', 'user.png') .attach('image', 'path/to/loki.png') .attach('file', 'path/to/jane.png') .end(callback);字段值
跟html的字段很像,你可以調用.field(name,value)方法來設置字段,假設你想上傳一個圖片的時候帶上自己的名稱和郵箱，那么你可以像下面寫的那樣:
request .post('/upload') .field('user[name]', 'Tobi') .field('user[email]', 'tobi[@learnboost](/user/learnboost).com') .attach('image', 'path/to/tobi.png') .end(callback);壓縮
nodejs客戶端本身就提供了壓縮響應內容，所以你不需要做任何其它事情.
緩沖響應
為了強迫緩沖res.text這樣的響應內容,可以調用req.buffer()方法,想取消默認的文本緩沖響應像text/plain,text/html這樣的，可以調用req.buffer(false)方法
當緩沖res.buffered標識提供了，那么就可以在一個回調函數里處理緩沖和沒緩沖的響應.
跨域資源共享
.withCredentials()方法可以激活發送原始cookie的能力,不過只有在Access-Control-Allow-Origin不是一個通配符(*),並且Access-Control-Allow-Credentials為’true’的情況下才行.
request .get('http://localhost:4001/') .withCredentials() .end(function(res){ assert(200 == res.status); assert('tobi' == res.text); next(); })異常處理
當發送錯誤時，superagent首先會檢查回調函數的參數數量,當err參數提供的話，參數就是兩個,如下:
request .post('/upload') .attach('image', 'path/to/tobi.png') .end(function(err, res){ });當省略了回調函數,或者回調只有一個參數的話,可以添加error事件的處理.
request .post('/upload') .attach('image', 'path/to/tobi.png') .on('error', handle) .end(function(res){ });注意:superagent默認情況下,對響應4xx和5xx的認為不是錯誤,例如當響應返回一個500或者403的時候,這些狀態信息可以通過res.error,res.status和其它的響應屬性來查看,但是沒有任務的錯誤對象會傳遞到回調函數里或者emit一個error事件.正常的error事件只會發生在網絡錯誤,解析錯誤等.
當產生一個4xx或者5xx的http錯誤響應,res.error提供了一個錯誤信息的對象，你可以通過檢查這個來做某些事情.
if (res.error) { alert('oh no ' + res.error.message); } else { alert('got ' + res.status + ' response'); }譯者序
superagent是一個非常實用的http代理模塊,推薦大家使用.