官方文档
文章来自:Request —— 让 Node.js http请求变得超简单
先前一直比较关注前端的东西,对后端了解较少。不过一直对Node.js比较感兴趣,去年12月还去参加了阿里的CNODE交流聚会。
以后希望通过这里的博客分享一些学习Node.js的笔记。一方面总结了自己的学习心得,另一方面也可以和大家一起分享交流。
嗯,大概就是这样子。
这篇就先介绍一个Node.js的模块——request。有了这个模块,http请求变的超简单。
安装request模块
在项目的node_module文件夹下执行以下命令
npm install request --save
简单请求
在nodejs的开发中,有时需要后台去调用其他服务器的接口,这个时候,就需要发送HTTP请求了。有一个简单的工具可以用,Simplified HTTP request client,可以比较方便的模拟请求。
使用get请求
var request = require('request');
request('http://www.baidu.com', function (error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body) // Show the HTML for the baidu homepage.
}
})
post请求
var request = require("request");
var express = require("express");
var app = express();
app.post("/index", (req, res) => {
request({
url: "http://www.linyimin.club:10010/getService",
method: "POST",
json: true,
headers: {
"content-type": "application/json",
},
body: JSON.stringify(req.body)
}, function(error, response, body) {
if (error) {
console.log('------------------------------------');
console.log(error);
res.send(error);
res.end();
console.log('------------------------------------');
}else{
console.log('------------------------------------');
console.log(body);
console.log('------------------------------------');
res.send(JSON.stringify(body));
res.end();
}
});
})
app.listen(3000);
Request使用超简单,同时支持https和重定向。
流
任何响应都可以输出到文件流。
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
至少需要三个参数,最后一个是回调函数。