什麼是SuperAgent ？

superagent它是一個強大並且可讀性很好的輕量級ajaxAPI，是一個關於HTTP方面的一個庫，可運用於node.

var superagent = require('superagent');

    superagent
        .post('/api')
        .send({
            'key': 'value'
        })
        .set('header_key', 'header_value')
        .end(function(err, res) {
            if (err) {
                //產生錯誤執行語句
            } else {
                //執行語句
            }
        })
 

如何安裝SuperAgent ？

$  npm  install  superagent    - - save 

如何應用SuperAgent ? 

在不同的應用場景,在傳送請求的時候,會選擇一個正確的請求方式,然後通過.end()函式來得到請求後的返回結果。

 superagent
        .get('/api')
        .end(function(req,res){
            //do something
        })

superagent('GET','/api')
        .end(function(req,res){
            //do something
        })
 

SuperAgent裡面設定請求頭的方式為：通過使用set()方法設定。

superagent
      .get('/api')
      .set('Referer','https://www.baidu.com')
      .set('Accept','image/01.jpg')
      .end(function(req,res){
          //執行程式碼
      })

superagent
      .get('/api')
      .set({
          'Referer','https://www.baidu.com',
          'Accept','image/01.jpg'
      })
      .end(function(req,res){
          //執行程式碼
      })
 

GET請求方式

superagent
     .get(/api)
     .query({name:'An'})
     .query({age:20})
     .query({sex:'male'})
     .end(cb)

superagent
     .get(/api)
     .query({name:'An',age:20,sex:'male'})
     .end(cb)

superagent
     .get(/api)
     .query('name=An&age=20&sex=male')
     .end(cb)

superagent
         .get(/api)
         .query('name=An')
         .query('age=20')
         .query('sex=male')
         .end(cb)

HEAD請求

head請求也可以通過query()的方式進行傳遞引數。

POST/PUT請求

 superagent
     .post('/api')
     .set('Accept','application/json')
     .send('{"name":"An","age":20,"sex":"male"}')
     .end(cb)

superagent
     .post('/api')
     .send({name:"An",age:20,sex:"male"})
     .end(cb)

superagent
     .post('/api')
     .send({name:"An"})
     .send({age:20})
     .sex({sex:'male'})
     .end(cb)

設定Content-Type的兩種快速方式

1、type()方法

 superagent
     .post('/api')
     .type('application/json')
     .type('png')

2、accept()方法

superagent
     .post('/api')
     .accept('application/json')
     .accept('png')

分析處理response body

superagent可以幫你解析返回的資料,當前支援三種類型的資料application/x-www-form-urlencoded application/json 和multipart/form-data

1、JSON/Urlencoded 

解析後的資料會以物件的形式存在,可以通過res.body來得到。

 '{"name":"An"}' //JSON String
  //解析 ==>
  {
      name:"An"   //JSON Object
  }

2、Multipart

這種格式的資料的處理，superagent是通過Formidable模組，它是主要處理檔案上傳的模組，大家可以去了解下，也是Node裡面十分常用的模組，也很簡單易上手。上傳的檔案的資訊可以在res.files去檢視。

Response的屬性

• res.text包含為被解析的響應資料

• res.body上文提到了，包含解析的資料，但是目前只支援三種格式

• res.header響應頭,是一個Object

• res.type & res.charset 型別和編碼格式

• res.status狀態碼

終止請求 req.abort() 暫停請求 req.timeout(ms) ms表示毫秒為單位的時間 

可以通過pipe管道流入流出資料

我想大家都知道node裡面有個核心特性就是stream，如果不知道的，可以參考:nodejs中流(stream)的理解,例如：

var fs = require('fs');
 var request = require('superagent');
 var postJson = fs.createReadStream('./postDataJson');
 var req= request.post('/api');
 req.accept('json');
 stream.pipe(req);

var fs = require('fs');
 var request = require('superagent');
 var getData = fs.createWriteStream('./getData');
 var res= request.get('/api');
 res.pipe(getData);

新增多個附件

superagent也提供了一些高階的API，如果你想新增多個附件可以使用attach(name,[path],[filename]),其中你可以通過filename來自定義上傳後文件的檔名

request
     .post('/upload')
     .attach('avator','/path/a.png','An.png')
     .attach('photo','/path/b.png')
     .end(cb)

複合請求

superagent也支援複合請求,比如你想上傳一個帶有你的姓名和郵箱的圖片，那可以通過field(name,value)方法

request
        .post('/upload')
        .field('name','An')
        .field('age':20)
        .attach('avator','/path/a.png','An.png')
        .end(cb)

錯誤處理

有時候我們可能會因為不同的原因得到4XX或者5XX的錯誤，這個時候我們確實是可以從end(function(err,res){...})裡的err得到錯誤資訊,比如er.status錯誤的狀態碼啥的，但是有些時候我們想去處理這些錯誤，重新發送一個別的請求啥的，那麼這個時候我們可以通過on('error',handleFn)去處理了。

request
     .post('/api')
     .send(data)
     .on('error',handleFn)
     .end(cb);