使用 nodejs 写爬虫(一): 经常使用模块和 js 语法

经常使用模块

经常使用模块有如下几个:

1. fs-extra
2. superagent
3. cheerio
4. log4js
5. sequelize
6. chalk
7. puppeteer

fs-extra

使用 async/await 的前提是必须将接口封装成 promise, 看一个简单的例子:

const sleep = (milliseconds) => {
    return new Promise((resolve, reject) => {
        setTimeout(() => resolve(), milliseconds)
    })
}

const main = async  () => {
    await sleep(5000);
    console.log('5秒后...');
}

main();
复制代码

经过在 async 函数中使用 await + promise 的方式来组织异步代码就像是同步代码通常，很是的天然和有助于咱们分析代码的执行流程。

在 node 中， fs 模块是一个很经常使用的操做文件的 native 模块，fs (file system) 模块提供了和文件系统相关的一些同步和异步的 api, 有时候使用同步 api 很是有必要，好比你要在一个本身写的模块中的在访问文件后导出一些接口时，这个时候用同步的 api 就很实用。看个例子：

const path = require('path');
const fs = require('fs-extra');
const { log4js } = require('../../config/log4jsConfig');
const log = log4js.getLogger('qupingce');

const createModels = () => {
    const models = {};
    const fileNames = fs.readdirSync(path.resolve(__dirname, '.'));

    fileNames
        .filter(fileName => fileName !== 'index.js')
        .map(fileName => fileName.slice(0, -3))
        .forEach(modelName => {
            log.info(`Sequelize define model ${modelName}!`);
            models[modelName] = require(path.resolve(__dirname, `./${modelName}.js`));
        })
    return models;
}

module.exports = createModels();
复制代码

这个模块访问了当前目录下全部的 model 模块并导出 models, 若是是使用异步接口也就是 fs.readdir, 这样的话你在别的模块导入这个模块是获取不到 models 的， 缘由是 require 是同步操做，而接口是异步的，同步代码没法当即得到异步操做的结果。

为了充分发挥 node 异步的优点，咱们仍是应该尽可能使用异步接口。

咱们彻底可使用 fs-extra 模块来代替 fs 模块, 相似的模块还有 mz。fs-extra 包含了全部的 fs 模块的接口，还对每一个异步接口提供了promise 支持，更棒的是 fs-extra 还提供了一些其它的实用文件操做函数， 好比删除移动文件的操做。更详细的介绍请查看官方仓库 fs-extra。

superagent

superagent 是一个 node 的 http client, 能够类比 java 中的 httpclient 和 okhttp, python 中的 requests。可让咱们模拟 http 请求。superagent 这个库有不少实用的特色。

1. superagent 会根据 response 的 content-type 自动序列化，经过 response.body 就能够获取到序列化后的返回内容
2. 这个库会自动缓存和发送 cookies, 不须要咱们手动管理 cookies
3. 再来就是它的 api 是链式调用风格的，调用起来很爽，不过使用的时候要注意调用顺序
4. 它的异步 api 都是返回 promise的。

很是方便有木有😋。官方文档就是很长的一页，目录清晰，很容易就搜索到你须要的内容。最后，superagent 还支持插件集成，好比你须要在超时后自动重发，可使用 superagent-retry。更多插件能够去 npm 官网上搜索关键字 superagent-。更多详情查看官方文档superagent

// 官方文档的一个调用示例 
request
   .post('/api/pet')
   .send({ name: 'Manny', species: 'cat' })
   .set('X-API-Key', 'foobar')
   .set('Accept', 'application/json')
   .then(res => {
      alert('yay got ' + JSON.stringify(res.body));
   });
复制代码

cheerio

写过爬虫的人都知道, 咱们常常会有解析 html 的需求, 从网页源代码中爬取信息应该是最基础的爬虫手段了。python 中有 beautifulsoup, java 中有 jsoup, node 中有 cheerio。

cheerio 是为服务器端设计的，给你近乎完整的 jquery 体验。使用 cheerio 来解析 html 获取元素，调用方式和 jquery 操做 dom 元素用法彻底一致。并且还提供了一些方便的接口, 好比获取 html, 看一个例子:

const cheerio = require('cheerio')
const $ = cheerio.load('<h2 class="title">Hello world</h2>')

$('h2.title').text('Hello there!')
$('h2').addClass('welcome')

$.html()
//=> <h2 class="title welcome">Hello there!</h2>
复制代码

官方仓库: cheerio

log4js

log4j 是一个为 node 设计的日志模块。 场景简单状况下能够考虑使用 debug 模块。 log4js 比较符合我对日志库的需求，其实他俩定位也不同，debug 模块是为调试而设计的，log4js 则是一个日志库，确定得提供文件输出和分级等常规功能。

log4js 模块看名字有点向 java 中颇有名的日志库 log4j 看齐的节奏。log4j 有如下特色:

1. 能够自定义 appender(输出目标)，lo4js 甚至提供了输出到邮件等目标的 appender
2. 经过组合不一样的 appender, 能够实现不一样目的的 logger(日志器)
3. 提供了日志分级功能，官方的 FAQ 中提到了若是要对 appender 实现级别过滤，可使用 logLevelFilter
4. 提供了滚动日志和自定义输出格式

下面经过我最近一个爬虫项目的配置文件来感觉如下这个库的特色:

const log4js = require('log4js');
const path = require('path');
const fs = require('fs-extra');

const infoFilePath = path.resolve(__dirname, '../out/log/info.log');
const errorFilePath = path.resolve(__dirname, '../out/log/error.log');
log4js.configure({
    appenders: {
        dateFile: {
            type: 'dateFile',
            filename: infoFilePath,
            pattern: 'yyyy-MM-dd',
            compress: false
        },
        errorDateFile: {
            type: 'dateFile',
            filename: errorFilePath,
            pattern: 'yyyy-MM-dd',
            compress: false,
        },
        justErrorsToFile: {
            type: 'logLevelFilter',
            appender: 'errorDateFile',
            level: 'error'
        },
        out: {
            type: 'console'
        }
    },
    categories: {
        default: {
            appenders: ['out'],
            level: 'trace'
        },
        qupingce: {
            appenders: ['out', 'dateFile', 'justErrorsToFile'],
            level: 'trace'
        }
    }
});


const clear = async () => {
    const files = await fs.readdir(path.resolve(__dirname, '../out/log'));
    for (const fileName of files) {
        fs.remove(path.resolve(__dirname, `../out/log/${fileName}`));
    }
}


module.exports = {
    log4js,
    clear
}
复制代码

sequelize

写项目咱们每每会有持久化的需求，简单的场景可使用 JSON 保存数据，若是数据量比较大还要便于管理，那么咱们就要考虑用数据库了。若是是操做 mysql 和 sqllite 建议使用 sequelize, 若是是 mongodb, 我更推荐用专门为 mongodb 设计的 mongoose

sequelize 有几点我以为仍是有点不太好，好比默认生成 id (primary key), createdAt 和 updatedAt。

抛开一些自做主张的小毛病，sequelize 设计的仍是很好的。内置的操做符，hooks, 还有 validators 颇有意思。sequelize 还提供了 promise 和 typescript 支持。若是是使用 typescript 开发项目，还有另一个很好的 orm 选择 : typeorm。更多内容能够查看官方文档: sequelize

chalk

chalk 中文意思是粉笔的意思，这个模块是 node 颇有特点和实用的一个模块，它能够为你输出的内容添加颜色， 下划线， 背景色等装饰。当咱们写项目的时候每每须要记录一些步骤和事件，好比打开数据库连接，发出 http 请求等。咱们能够适当使用 chalk 来突出某些内容，例如请求的 url 加上下划线。

const logRequest = (response, isDetailed = false) => {
    const URL = chalk.underline.yellow(response.request.url);
    const basicInfo = `${response.request.method} Status: ${response.status} Content-Type: ${response.type} URL=${URL}`;
    if (!isDetailed) {
        logger.info(basicInfo);
    } else {
        const detailInfo = `${basicInfo}\ntext: ${response.text}`;
        logger.info(detailInfo);
    }
};
复制代码

调用上面的 logRequest效果:

更多内容查看官方仓库chalk

puppeteer

若是这个库没据说过，你可能据说过 selenium。puppeteer 是 Google Chrome 团队开源的一个经过 devtools 协议操纵 chrome 或者Chromium 的 node 模块。Google 出品，质量有所保证。这个模块提供了一些高级的 api, 默认状况下，这个库操纵的浏览器用户是看不到界面的，也就是所谓的无头(headless)浏览器。固然能够经过配置一些参数来启动有界面的模式。在 chrome 中还有一些专门录制 puppeteer 操做的扩展, 好比Puppeteer Recorder。使用这个库咱们能够用来抓取一些经过 js 渲染而不是直接存在于页面源代码中的信息。好比 spa 页面，页面内容都是 js 渲染出来的。这个时候 puppeteer 就为咱们解决了这个问题，咱们能够调用 puppeteer 在页面某个标签出现时获取到页面当时的渲染出来的 html。事实上，每每不少比较困难的爬虫解决的最终法宝就是操纵浏览器。

前置的 js 语法

async/await

首先要提的就是 async/await, 由于 node 在很早的时候(node 8 LTS)就已经支持 async/await, 如今写后端项目没理由不用 async/await了。使用 async/await 可让咱们从回调炼狱的困境中解脱出来。这里主要提一下关于使用async/await 时可能会碰到的问题

使用 async/await 怎样并发？

来看一段测试代码:

const sleep = (milliseconds) => {
    return new Promise((resolve, reject) => {
        setTimeout(() => resolve(), milliseconds)
    })
}

const test1 = async () => {
    for (let i = 0, max = 3; i < max; i++) {
        await sleep(1000);
    }
}

const test2 = async () => {
    Array.from({length: 3}).forEach(async () => {
        await sleep(1000);
    });
}

const main = async  () => {
    console.time('测试 for 循环使用 await');
    await test1();
    console.timeEnd('测试 for 循环使用 await');

    console.time('测试 forEach 调用 async 函数')
    await test2();
    console.timeEnd('测试 forEach 调用 async 函数')
}

main();
复制代码

运行结果是:

测试 for 循环使用 await: 3003.905ms
测试 forEach 调用 async 函数: 0.372ms
复制代码

我想可能会有些人会认为测试 forEach 的结果会是 1 秒左右，事实上测试2等同于如下代码:

const test2 = async () => {
    // Array.from({length: 3}).forEach(async () => {
    // await sleep(1000);
    // });
    
    Array.from({length: 3}).forEach(() => {
       sleep(1000);
    });
}

复制代码

从上面的运行结果也能够看出直接在 for 循环中使用 await + promise, 这样等同于同步调用, 因此耗时是 3 秒左右。若是要并发则应该直接调用 promise, 由于 forEach 是不会帮你 await 的，因此等价于上面的代码，三个任务直接异步并发了。

处理多个异步任务

上面的代码还有一个问题，那就是测试2中并无等待三个任务都执行完就直接结束了，有时候咱们须要等待多个并发任务结束以后再执行后续任务。其实很简单，利用下 Promise 提供的几个工具函数就能够了。

const sleep = (milliseconds, id='') => {
    return new Promise((resolve, reject) => {
        setTimeout(() => {
            console.log(`任务${id}执行结束`)
            resolve(id);
        }, milliseconds)
    })
}


const test2 = async () => {
    const tasks = Array.from({length: 3}).map((ele, index) => sleep(1000, index));
    const resultArray = await Promise.all(tasks);
    console.log({ resultArray} )
    console.log('全部任务执行结束');
}

const main = async  () => {
    console.time('使用 Promise.all 处理多个并发任务')
    await test2();
    console.timeEnd('使用 Promise.all 处理多个并发任务')
}

main()

复制代码

运行结果:

任务0执行结束
任务1执行结束
任务2执行结束
{ resultArray: [ 0, 1, 2 ] }
全部任务执行结束
使用 Promise.all 处理多个并发任务: 1018.628ms

复制代码

除了 Promise.all, Promise 还有 race 等接口，不过最经常使用应该就是 all 和 race 了。

正则表达式

正则表达式是处理字符串强有力的工具。核心是匹配，由此衍生出提取，查找， 替换的等操做。

有时候咱们经过 cheerio 中获取到某个标签内的文本时，咱们须要提取其中的部分信息，这个时候正则表达式就该上场了。正则表达式的相关语法这里就不详细说明了， 入门推荐看廖雪峰的正则表达式教程。来看个实例:

// 服务器返回的 img url 是: /GetFile/getUploadImg?fileName=9b1cc22c74bc44c8af78b46e0ca4c352.png
// 如今我只想提取文件名，后缀名也不要
const imgUrl = '/GetFile/getUploadImg?fileName=9b1cc22c74bc44c8af78b46e0ca4c352.png';
const imgReg = /\/GetFile\/getUploadImg\?fileName=(.+)\..+/;
const imgName = imgUrl.match(imgReg)[1];
console.log(imgName); // => 9b1cc22c74bc44c8af78b46e0ca4c352

复制代码

暂时先介绍到这里了，后续有更多内容会继续补充。

本文为原创内容，首发于我的博客, 转载请注明出处。若是有问题欢迎邮件骚扰 ytj2713151713@gmail.com。