面向对象的分布式爬虫框架XXL-CRAWLER

2017-11-03  本文已影响0人  许雪里

《面向对象的分布式爬虫框架XXL-CRAWLER》

一、简介

1.1 概述

XXL-CRAWLER 是一个面向对象的分布式爬虫框架。一行代码开发一个分布式爬虫，拥有"多线程、异步、IP动态代理、分布式、JS渲染"等特性；

1.2 特性

1.4 下载

文档地址

源码仓库地址

源码仓库地址 Release Download
https://github.com/xuxueli/xxl-crawler Download
https://gitee.com/xuxueli0323/xxl-crawler Download

技术交流

1.5 环境

二、快速入门

爬虫示例参考

(爬虫示例代码位于 /test 目录下)

第一步：引入Maven依赖

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-crawler</artifactId>
    <version>${最新稳定版}</version>
</dependency>

第二步：定义 "PageVo/页面数据对象"（可选）

在此推荐两款工具，可以直观迅速的获取页面元素的Jquery cssQuery表达式。

// PageSelect 注解：从页面中抽取出一个或多个VO对象；
@PageSelect(cssQuery = "body")
public static class PageVo {

    @PageFieldSelect(cssQuery = ".blog-heading .title")
    private String title;

    @PageFieldSelect(cssQuery = "#read")
    private int read;

    @PageFieldSelect(cssQuery = ".comment-content")
    private List<String> comment;

    // set get
}

第三步：创建爬虫

XxlCrawler crawler = new XxlCrawler.Builder()
    .setUrls("https://my.oschina.net/xuxueli/blog")
    .setWhiteUrlRegexs("https://my\\.oschina\\.net/xuxueli/blog/\\d+")
    .setThreadCount(3)
    .setPageParser(new PageParser<PageVo>() {
        @Override
        public void parse(Document html, Element pageVoElement, PageVo pageVo) {
            // 解析封装 PageVo 对象
            String pageUrl = html.baseUri();
            System.out.println(pageUrl + "：" + pageVo.toString());
        }
    })
    .build();

第四步：启动爬虫

crawler.start(true);

三、总体设计

架构图

输入图片说明

3.1 功能定位

XXL-CRAWLER 是一个灵活高效、面向对象的Web爬虫框架。采用模块化设计，各个模块可灵活进行自定义和扩展。

借助 XXL-CRAWLER，一行代码开发一个分布式爬虫。

3.2 核心概念

概念 说明
XxlCrawler 爬虫对象，维护爬虫信息
PageVo 页面数据对象，一张Web页面可抽取一个或多个PageVo
PageLoader 页面加载器，负责加载页面数据，支持灵活的自定义和扩展
PageParser 页面解析器，绑定泛型PageVO后将会自动抽取页面数据对象，同时支持运行时调整请求参数信息

3.3 爬虫对象：XxlCrawler

功能：爬虫对象，维护爬虫信息，可选属性如下。

方法 说明
setUrls 待爬的URL列表
setAllowSpread 允许扩散爬取，将会以现有URL为起点扩散爬取整站
setWhiteUrlRegexs URL白名单正则，非空时进行URL白名单过滤页面
setIfPost 请求方式：true=POST请求、false=GET请求
setUserAgent UserAgent
setParamMap 请求参数
setCookieMap 请求Cookie
setTimeoutMillis 超时时间，毫秒
setPauseMillis 停顿时间，爬虫线程处理完页面之后进行主动停顿，避免过于频繁被拦截；
setProxyMaker 代理生成器，支持设置代理IP，同时支持调整代理池实现动态代理；
setThreadCount 爬虫并发线程数
setPageParser 页面解析器
setPageLoader 页面加载器，默认提供 "JsoupPageParser" 和 "HtmlUnitPageLoader" 两种实现；
setRunData 设置运行时数据模型，默认提供LocalRunData单机模型，支持扩展实现分布式模型；
start 运行爬虫，可通过入参控制同步或异步方式运行
stop 终止爬虫

3.4 核心注解：PageSelect

功能：描述页面数据对象，通过该注解从页面抽取PageVo数据信息，可选属性如下。

PageSelect 说明
cssQuery CSS选择器, 如 "#body"

3.5 核心注解：PageFieldSelect

功能：描述页面数据对象的属性信息，通过该注解从页面抽取PageVo的属性信息，可选属性如下。
（支持基础数据类型 T ，包括 List<T>）

PageFieldSelect 说明
cssQuery CSS选择器, 如 "#title"
selectType jquery 数据抽取方式，如 ".html()/.text()/.val()/.attr()"等
selectVal jquery 数据抽取参数，SelectType=ATTR 时有效，如 ".attr("abs:src")"
datePattern 时间格式化，日期类型数据有效

3.6 多线程

以线程池方式并行运行，提供对应API（可参考"章节3.3"）调整线程池大小，提高运行效率；

3.7 异步

支持同步、异步两种方式启动运行。

3.8 动态代理

ProxyMaker（代理生成器）：实现代理支持的组件。支持设置代理IP，同时支持调整代理池实现动态代理；

系统已经提供了两种策略实现；

3.9、PageParser

PageParser（页面解析器）：绑定泛型PageVO后将会自动抽取页面数据对象，同时支持运行时调整请求参数信息；

内部方法 说明
public void preLoad(PageLoadInfo pageLoadInfo) 可选实现，发起页面请求之前触发调用，可基于此运行时调整请求参数；
public void postLoad(Document html) 可选实现，发起页面请求之后触发调用，可基于此运行时调整页面数据；
public abstract void parse(Document html, Element pageVoElement, T pageVo) 必须实现，页面抽离封装每个PageVO之后触发调用，可基于此处理PageVO文档或数据；

3.10、分布式支持 & RunData

支持自定义RunData(运行时数据模型)并结合Redis或DB共享运行数据来实现分布式爬虫。默认提供LocalRunData实现单机版爬虫。

RunData抽象方法 说明
public abstract boolean addUrl(String link); 新增一个待采集的URL，接口需要做URL去重，爬虫线程将会获取到并进行处理；
public abstract String getUrl(); 获取一个待采集的URL，并且将它从"待采集URL池"中移除，并且添加到"已采集URL池"中；
public abstract int getUrlNum(); 获取待采集URL数量；

3.11、JS动态渲染 & PageLoader

页面数据通过 "PageLoader" 组件加载，默认使用以下两种实现：

得益于模块化结构设计，可自由扩展其他 "PageLoader" 实现，如 "Selenium" 方式等；

注意：

四、版本更新日志

版本 V1.0.0，新特性[2017-09-13]

版本 V1.1.0，新特性[2017-11-08]

版本 V1.2.0，新特性[2017-12-14]

版本 V1.2.1，新特性[2018-02-07]

版本 V1.2.2，新特性[迭代中]

TODO LIST

五、其他

5.1 项目贡献

欢迎参与项目贡献！比如提交PR修复一个bug，或者新建 Issue 讨论新特性或者变更。

5.2 用户接入登记

更多接入的公司，欢迎在 登记地址 登记，登记仅仅为了产品推广。

5.3 开源协议和版权

产品开源免费，并且将持续提供免费的社区技术支持。个人或企业内部可自由的接入和使用。

捐赠

无论金额多少都足够表达您这份心意，非常感谢 ：） 前往捐赠

上一篇下一篇

猜你喜欢

热点阅读