Node.js Crawler 封装 Promise 支持以优化异步爬取
本文介绍如何为 Node.js 的 node-crawler 库添加 Promise 支持。通过继承 Crawler 类并重写 queue 方法,将原有的回调函数模式转换为返回 Promise 对象的模式,从而简化多任务同步爬取的代码结构,提升开发效率。
背景与现状分析
背景
近期在团队内部开展爬虫相关开发工作。起初计划自行构建基础工具,但经社区推荐后,最终选用了 node-crawler 库。经过实际使用验证,该库能够满足大部分常规需求。然而,其原生 API 未提供 Promise 支持,且缺乏同步爬取与同步处理的能力。若不引入 Promise 机制,代码编写方式将显得不够简洁优雅,因此需要对现有库进行封装,以提供 Promise 接口。
现状
当前版本的 node-crawler 使用方法不支持 Promise 链式调用。以下直接展示 npm 官方文档中的典型使用示例:
const Crawler = require("crawler")
// 实例化
const c = new Crawler({
// ... 可以传入一些配置
callback : function (error, res, done) {
// 请求回调,实例化的时候传入的 callback 是作为默认 callback 的,后续每次抓取如果没有传入 callback,那么都会调用默认 callback
done();
}
})
// 爬取
c.queue([{
uri: 'http://parishackers.org/',
jQuery: false,
// The global callback won't be called
callback: function (error, res, done) {
if(error){
console.log(error);
}else{
console.log('Grabbed', res.body.length, 'bytes');
}
done();
}
}])
这种基于回调函数的调用方式,在处理多个爬虫任务同步执行时显得非常不友好,容易导致回调地狱,降低代码可读性和维护性。
Promise 化改造方案
改造思路
期望的理想使用方式应支持链式调用与错误处理,具体表现为:
const Crawler = require('crawler')
const c = new Crawler({
// 一些默认配置
})
c
.queue({
uri: 'xxx'
})
.then(res => {
// 抓取成功
})
.catch(err => {
// 抓取失败
})
具体的改造方案如下:
// utils/crawler.js
const Crawler = require('crawler')
const defaultOptions = {
jQuery: false,
rateLimit: fetchRateLimit,
retries: 0,
timeout: fetchTimeout,
}
module.exports = class PromiseifyCrawler extends Crawler {
// namespace 是为了后续抓取结果统一上报时候进行区分
constructor(namespace = 'unknow', options = {}) {
if (typeof namespace === 'object') {
options = namespace
namespace = 'unknow'
}
options = merge({}, defaultOptions, options)
const cb = options.callback
options.callback = (err, res, done) => {
typeof cb === 'function' && cb(err, res, noop)
process.nextTick(done)
// 在这里可以自定义抓取成功还是失败
// 我这里直接设置的是如果 http code 不是 200 就视为错误
// 而且在这里也可以做一些抓取成功失败的统计
if (err || res.statusCode !== 200) {
if (!err) err = new Error(`${res.statusCode}-${res.statusMessage}`)
err.options = res.options
err.options.npolisReject(err)
} else {
res.options.npolisResolve(res)
}
}
options.headers = Object.assign({}, options.headers, {
'X-Requested-With': 'XMLHttpRequest',
})
super(options)
}
queue(options = {}) {
// 每次抓取都是一个新的 promise
return new Promise((resolve, reject) => {
// 然后在 options 里挂载上 resolve 和 reject
// 这样在全局 callback 上就可以用到了
options.npolisResolve = resolve
options.npolisReject = reject
const pr = options.preRequest
options.preRequest = (options, done) => {
typeof pr === 'function' && pr(options, noop)
// 在这里也可以做一些通用的抓取前的处理
done()
}
super.queue(options)
})
}
// direct api 同理
}
// 使用
const Crawler = require('./utils/crawler')
const crawler = new Crawler('示例爬虫 namespace')
crawler
.queue({
uri: 'xxx',
preRequest: options => log('开始抓取'),
})
.then(res => {
log('爬取成功')
return res
})
.catch(err => {
log('爬取失败')
throw err
})
promise 化后,多个爬取任务同步爬取写法就友好多了:
// 抓取任务1
const fetchTask1 = () => crawler.queue({/* 配置 */}).then(res => handle(res))
// 抓取任务2
const fetchTask2 = () => crawler.queue({/* 配置 */}).then(res => handle(res))
const fetch = () => {
return Promise.all([
fetchTask1(),
fetchTask2(),
])
}
fetch()
通过上述步骤,即完成了对 node-crawler 的 Promise 化改造。
以上为本文的全部内容,希望能为读者的学习提供有益参考,同时也欢迎大家继续支持本站。
macOS卸载Node.js指南:区分Homebrew与pkg安装包的处理方式
2026-11-05 11:28:12
JS逆向入门:浏览器Console调试与Node.js环境搭建指南
2026-11-05 10:57:15
Node.js 大版本升级需要注意哪些破坏性变更
2026-11-03 20:35:44
Node.js官网LTS版与Current版有什么区别
2026-11-03 19:33:49
Windows彻底卸载Node.js:清理AppData残留与PATH环境变量
2026-11-03 19:15:35
