HTTP模块SuperAgent（轻量级ajaxAPI）

什么是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);