《使用 eventproxy 控制并发》

目标

建立一个 lesson4 项目,在其中编写代码。

代码的入口是 app.js,当调用 node app.js 时,它会输出 CNode(https://cnodejs.org/ ) 社区首页的所有主题的标题,链接和第一条评论,以 json 的格式。

输出示例:

  1. [
  2. {
  3. "title": "【公告】发招聘帖的同学留意一下这里",
  4. "href": "http://cnodejs.org/topic/541ed2d05e28155f24676a12",
  5. "comment1": "呵呵呵呵"
  6. },
  7. {
  8. "title": "发布一款 Sublime Text 下的 JavaScript 语法高亮插件",
  9. "href": "http://cnodejs.org/topic/54207e2efffeb6de3d61f68f",
  10. "comment1": "沙发!"
  11. }
  12. ]

挑战

以上文目标为基础,输出 comment1 的作者,以及他在 cnode 社区的积分值。

示例:

  1. [
  2. {
  3. "title": "【公告】发招聘帖的同学留意一下这里",
  4. "href": "http://cnodejs.org/topic/541ed2d05e28155f24676a12",
  5. "comment1": "呵呵呵呵",
  6. "author1": "auser",
  7. "score1": 80
  8. },
  9. ...
  10. ]

知识点

  1. 体会 Node.js 的 callback hell 之美
  2. 学习使用 eventproxy 这一利器控制并发

课程内容

注意,cnodejs.org 网站有并发连接数的限制,所以当请求发送太快的时候会导致返回值为空或报错。建议一次抓取3个主题即可。文中的40只是为了方便讲解

这一章我们来到了 Node.js 最牛逼的地方——异步并发的内容了。

上一课我们介绍了如何使用 superagent 和 cheerio 来取主页内容,那只需要发起一次 http get 请求就能办到。但这次,我们需要取出每个主题的第一条评论,这就要求我们对每个主题的链接发起请求,并用 cheerio 去取出其中的第一条评论。

CNode 目前每一页有 40 个主题,于是我们就需要发起 1 + 40 个请求,来达到我们这一课的目标。

后者的 40 个请求,我们并发地发起:),而且不会遇到多线程啊锁什么的,Node.js 的并发模型跟多线程不同,抛却那些观念。更具体一点的话,比如异步到底为何异步,Node.js 为何单线程却能并发这类走近科学的问题,我就不打算讲了。对于这方面有兴趣的同学,强烈推荐 @朴灵 的 《九浅一深Node.js》: http://book.douban.com/subject/25768396/

有些逼格比较高的朋友可能听说过 promise 和 generator 这类概念。不过我呢,只会讲 callback,主要原因是我个人只喜欢 callback。

这次课程我们需要用到三个库:superagent cheerio eventproxy(https://github.com/JacksonTian/eventproxy )

手脚架的工作各位自己来,我们一步一步来一起写出这个程序。

首先 app.js 应该长这样

  1. var eventproxy = require('eventproxy');
  2. var superagent = require('superagent');
  3. var cheerio = require('cheerio');
  4. // url 模块是 Node.js 标准库里面的
  5. // http://nodejs.org/api/url.html
  6. var url = require('url');
  7. var cnodeUrl = 'https://cnodejs.org/';
  8. superagent.get(cnodeUrl)
  9. .end(function (err, res) {
  10. if (err) {
  11. return console.error(err);
  12. }
  13. var topicUrls = [];
  14. var $ = cheerio.load(res.text);
  15. // 获取首页所有的链接
  16. $('#topic_list .topic_title').each(function (idx, element) {
  17. var $element = $(element);
  18. // $element.attr('href') 本来的样子是 /topic/542acd7d5d28233425538b04
  19. // 我们用 url.resolve 来自动推断出完整 url,变成
  20. // https://cnodejs.org/topic/542acd7d5d28233425538b04 的形式
  21. // 具体请看 http://nodejs.org/api/url.html#url_url_resolve_from_to 的示例
  22. var href = url.resolve(cnodeUrl, $element.attr('href'));
  23. topicUrls.push(href);
  24. });
  25. console.log(topicUrls);
  26. });

运行 node app.js

输出如下图:

《使用 eventproxy 控制并发》 - 图1

OK,这时候我们已经得到所有 url 的地址了,接下来,我们把这些地址都抓取一遍,就完成了,Node.js 就是这么简单。

抓取之前,还是得介绍一下 eventproxy 这个库。

用 js 写过异步的同学应该都知道,如果你要并发异步获取两三个地址的数据,并且要在获取到数据之后,对这些数据一起进行利用的话,常规的写法是自己维护一个计数器。

先定义一个 var count = 0,然后每次抓取成功以后,就 count++。如果你是要抓取三个源的数据,由于你根本不知道这些异步操作到底谁先完成,那么每次当抓取成功的时候,就判断一下 count === 3。当值为真时,使用另一个函数继续完成操作。

而 eventproxy 就起到了这个计数器的作用,它来帮你管理到底这些异步操作是否完成,完成之后,它会自动调用你提供的处理函数,并将抓取到的数据当参数传过来。

假设我们不使用 eventproxy 也不使用计数器时,抓取三个源的写法是这样的:

  1. // 参考 jquery 的 $.get 的方法
  2. $.get("http://data1_source", function (data1) {
  3. // something
  4. $.get("http://data2_source", function (data2) {
  5. // something
  6. $.get("http://data3_source", function (data3) {
  7. // something
  8. var html = fuck(data1, data2, data3);
  9. render(html);
  10. });
  11. });
  12. });

上述的代码大家都写过吧。先获取 data1,获取完成之后获取 data2,然后再获取 data3,然后 fuck 它们,进行输出。

但大家应该也想到了,其实这三个源的数据,是可以并行去获取的,data2 的获取并不依赖 data1 的完成,data3 同理也不依赖 data2。

于是我们用计数器来写,会写成这样:

  1. (function () {
  2. var count = 0;
  3. var result = {};
  4. $.get('http://data1_source', function (data) {
  5. result.data1 = data;
  6. count++;
  7. handle();
  8. });
  9. $.get('http://data2_source', function (data) {
  10. result.data2 = data;
  11. count++;
  12. handle();
  13. });
  14. $.get('http://data3_source', function (data) {
  15. result.data3 = data;
  16. count++;
  17. handle();
  18. });
  19. function handle() {
  20. if (count === 3) {
  21. var html = fuck(result.data1, result.data2, result.data3);
  22. render(html);
  23. }
  24. }
  25. })();

丑的一逼,也不算丑,主要我写代码好看。

如果我们用 eventproxy,写出来是这样的:

  1. var ep = new eventproxy();
  2. ep.all('data1_event', 'data2_event', 'data3_event', function (data1, data2, data3) {
  3. var html = fuck(data1, data2, data3);
  4. render(html);
  5. });
  6. $.get('http://data1_source', function (data) {
  7. ep.emit('data1_event', data);
  8. });
  9. $.get('http://data2_source', function (data) {
  10. ep.emit('data2_event', data);
  11. });
  12. $.get('http://data3_source', function (data) {
  13. ep.emit('data3_event', data);
  14. });

好看多了是吧,也就是个高等计数器嘛。

ep.all('data1_event', 'data2_event', 'data3_event', function (data1, data2, data3) {});

这一句,监听了三个事件,分别是 data1_event, data2_event, data3_event,每次当一个源的数据抓取完成时,就通过 ep.emit() 来告诉 ep 自己,某某事件已经完成了。

当三个事件未同时完成时,ep.emit() 调用之后不会做任何事;当三个事件都完成的时候,就会调用末尾的那个回调函数,来对它们进行统一处理。

eventproxy 提供了不少其他场景所需的 API,但最最常用的用法就是以上的这种,即:

  1. var ep = new eventproxy(); 得到一个 eventproxy 实例。
  2. 告诉它你要监听哪些事件,并给它一个回调函数。ep.all('event1', 'event2', function (result1, result2) {})
  3. 在适当的时候 ep.emit('event_name', eventData)

eventproxy 这套处理异步并发的思路,我一直觉得就像是汇编里面的 goto 语句一样,程序逻辑在代码中随处跳跃。本来代码已经执行到 100 行了,突然 80 行的那个回调函数又开始工作了。如果你异步逻辑复杂点的话,80 行的这个函数完成之后,又激活了 60 行的另外一个函数。并发和嵌套的问题虽然解决了,但老祖宗们消灭了几十年的 goto 语句又回来了。

至于这套思想糟糕不糟糕,我个人倒是觉得还是不糟糕,用熟了看起来蛮清晰的。不过 js 这门渣渣语言本来就乱嘛,什么变量提升(http://www.cnblogs.com/damonlan/archive/2012/07/01/2553425.html )啊,没有 main 函数啊,变量作用域啊,数据类型常常简单得只有数字、字符串、哈希、数组啊,这一系列的问题,都不是事儿。

编程语言美丑啥的,咱心中有佛就好。

回到正题,之前我们已经得到了一个长度为 40 的 topicUrls 数组,里面包含了每条主题的链接。那么意味着,我们接下来要发出 40 个并发请求。我们需要用到 eventproxy 的 #after API。

大家自行学习一下这个 API 吧:https://github.com/JacksonTian/eventproxy#%E9%87%8D%E5%A4%8D%E5%BC%82%E6%AD%A5%E5%8D%8F%E4%BD%9C

我代码就直接贴了哈。

  1. // 得到 topicUrls 之后
  2. // 得到一个 eventproxy 的实例
  3. var ep = new eventproxy();
  4. // 命令 ep 重复监听 topicUrls.length 次(在这里也就是 40 次) `topic_html` 事件再行动
  5. ep.after('topic_html', topicUrls.length, function (topics) {
  6. // topics 是个数组,包含了 40 次 ep.emit('topic_html', pair) 中的那 40 个 pair
  7. // 开始行动
  8. topics = topics.map(function (topicPair) {
  9. // 接下来都是 jquery 的用法了
  10. var topicUrl = topicPair[0];
  11. var topicHtml = topicPair[1];
  12. var $ = cheerio.load(topicHtml);
  13. return ({
  14. title: $('.topic_full_title').text().trim(),
  15. href: topicUrl,
  16. comment1: $('.reply_content').eq(0).text().trim(),
  17. });
  18. });
  19. console.log('final:');
  20. console.log(topics);
  21. });
  22. topicUrls.forEach(function (topicUrl) {
  23. superagent.get(topicUrl)
  24. .end(function (err, res) {
  25. console.log('fetch ' + topicUrl + ' successful');
  26. ep.emit('topic_html', [topicUrl, res.text]);
  27. });
  28. });

输出长这样:

《使用 eventproxy 控制并发》 - 图2

完整的代码请查看 lesson4 目录下的 app.js 文件