Nodejs Request使用介紹

這篇就先介紹一個Node.js的模塊——request。有了這個模塊，http請求變的超簡單。

使用超簡單

Request使用超簡單，同時支持https和重定向。

var request = require('request');
request('http://www.google.com', function (error, response, body) {
 if (!error && response.statusCode == 200) {
 console.log(body) // 打印google首頁
}
})

流

任何響應均可以輸出到文件流。

request('http://google.com/doodle.png').pipe(fs.createWriteStream('doodle.png'))

反過來，也能夠將文件傳給PUT或POST請求。未提供header的狀況下，會檢測文件後綴名，在PUT請求中設置相應的content-type。

fs.createReadStream('file.json').pipe(request.put('http://mysite.com/obj.json'))

請求也能夠pipe給本身。這種狀況下會保留原content-type和content-length。

request.get('http://google.com/img.png').pipe(request.put('http://mysite.com/img.png'))

表單

request支持application/x-www-form-urlencoded和multipart/form-data實現表單上傳。

x-www-form-urlencoded很簡單：

request.post('http://service.com/upload', {form:{key:'value'}})

或者：

request.post('http://service.com/upload').form({key:'value'})

使用multipart/form-data不用操心設置header之類的雜事，request會幫你解決。

var r = request.post('http://service.com/upload')
var form = r.form()
form.append('my_field', 'my_value')
form.append('my_buffer', new Buffer([1, 2, 3]))
form.append('my_file', fs.createReadStream(path.join(__dirname, 'doodle.png'))
form.append('remote_file', request('http://google.com/doodle.png'))

HTTP認證

request.get('http://some.server.com/').auth('username', 'password', false);

或

request.get('http://some.server.com/', {
 'auth': {
 'user': 'username',
 'pass': 'password',
 'sendImmediately': false
}
});

sendImmediately，默認爲真，發送一個基本的認證header。設爲false以後，收到401會重試（服務器的401響應必須包含WWW-Authenticate指定認證方法）。

sendImmediately爲真時支持Digest認證。

OAuth登陸

// Twitter OAuth
var qs = require('querystring')
 , oauth =
 { callback: 'http://mysite.com/callback/'
 , consumer_key: CONSUMER_KEY
 , consumer_secret: CONSUMER_SECRET
}
 , url = 'https://api.twitter.com/oauth/request_token'
;
request.post({url:url, oauth:oauth}, function (e, r, body) {
 // Ideally, you would take the body in the response
 // and construct a URL that a user clicks on (like a sign in button).
 // The verifier is only available in the response after a user has
 // verified with twitter that they are authorizing your app.
 var access_token = qs.parse(body)
 , oauth =
 { consumer_key: CONSUMER_KEY
 , consumer_secret: CONSUMER_SECRET
 , token: access_token.oauth_token
 , verifier: access_token.oauth_verifier
}
 , url = 'https://api.twitter.com/oauth/access_token'
;
 request.post({url:url, oauth:oauth}, function (e, r, body) {
 var perm_token = qs.parse(body)
 , oauth =
 { consumer_key: CONSUMER_KEY
 , consumer_secret: CONSUMER_SECRET
 , token: perm_token.oauth_token
 , token_secret: perm_token.oauth_token_secret
}
 , url = 'https://api.twitter.com/1/users/show.json?'
 , params =
 { screen_name: perm_token.screen_name
 , user_id: perm_token.user_id
}
;
 url += qs.stringify(params)
 request.get({url:url, oauth:oauth, json:true}, function (e, r, user) {
console.log(user)
})
})
})

定製HTTP header

User-Agent之類能夠在options對象中設置。在下面的例子中，咱們調用github API找出某倉庫的收藏數和派生數。咱們使用了定製的User-Agent和https.

var request = require('request');

var options = {
 url: 'https://api.github.com/repos/mikeal/request',
 headers: {
 'User-Agent': 'request'
}
};

function callback(error, response, body) {
 if (!error && response.statusCode == 200) {
 var info = JSON.parse(body);
 console.log(info.stargazers_count +"Stars");
 console.log(info.forks_count +"Forks");
}
}

request(options, callback);

cookies

默認狀況下，cookies是禁用的。在defaults或options將jar設爲true，使後續的請求都使用cookie.

var request = request.defaults({jar: true})
request('http://www.google.com', function () {
request('http://images.google.com')
})

經過建立request.jar()的新實例，能夠使用定製的cookie，而不是request全局的cookie jar。

var j = request.jar()
var request = request.defaults({jar:j})
request('http://www.google.com', function () {
request('http://images.google.com')
})

或者

var j = request.jar()
var cookie = request.cookie('your_cookie_here')
j.setCookie(cookie, uri, function (err, cookie){})
request({url: 'http://www.google.com', jar: j}, function () {
request('http://images.google.com')
})

注意，setCookie至少須要三個參數，最後一個是回調函數。

項目主頁

request的GitHub主頁