分布式爬虫完成并可以成功运行了,但是有个环节非常烦琐,那就是代码部署。
我们设想下面的几个场景。
- 如果采用上传文件的方式部署代码,我们首先将代码压缩,然后采用SFTP或FTP的方式将文件上传到服务器,之后再连接服务器将文件解压,每个服务器都需要这样配置。
- 如果采用Git同步的方式部署代码,我们可以先把代码Push到某个Git仓库里,然后再远程连接各台主机执行Pull操作,同步代码,每个服务器同样需要做一次操作。
如果代码突然有更新,那我们必须更新每个服务器,而且万一哪台主机的版本没控制好,这可能会影响整体的分布式爬取状况。
所以我们需要一个更方便的工具来部署Scrapy项目,如果可以省去一遍遍逐个登录服务器部署的操作,那将会方便很多。
本节我们就来看看提供分布式部署的工具Scrapyd。
一、了解Scrapyd
Scrapyd是一个运行Scrapy爬虫的服务程序,它提供一系列HTTP接口来帮助我们部署、启动、停止、删除爬虫程序。Scrapyd支持版本管理,同时还可以管理多个爬虫任务,利用它我们可以非常方便地完成Scrapy爬虫项目的部署任务调度。
二、准备工作
请确保本机或服务器已经正确安装好了Scrapyd。
三、访问Scrapyd
安装并运行Scrapyd之后,我们就可以访问服务器的6800端口,看到一个WebUI页面。例如我的服务器地址为120.27.34.25,那么我就可以在本地的浏览器中打开:http://120.27.34.25:6800,就可以看到Scrapyd的首页。这里可以替换成你的服务器地址,如下图所示
成功访问到此页面,则Scrapyd配置就没有问题。
四、Scrapyd的功能
Scrapyd提供了一系列HTTP接口来实现各种操作。在这里以Scrapyd所在的IP地址120.27.34.25为例,我们可以将接口的功能梳理一下。
1. daemonstatus.json
这个接口负责查看Scrapyd当前的服务和任务状态。我们可以用curl
命令来请求这个接口,命令如下:
curl http://139.217.26.30:6800/daemonstatus.json
我们就会得到如下结果:
代码语言:javascript复制{"status": "ok", "finished": 90, "running": 9, "node_name": "datacrawl-vm", "pending": 0}
返回结果是JSON字符串,status
是当前运行状态,finished
代表当前已经完成的Scrapy任务,running
代表正在运行的Scrapy任务,pending
代表等待被调度的Scrapyd任务,node_name
就是主机的名称。
2. addversion.json
这个接口主要是用来部署Scrapy项目用的。我们首先将项目打包成Egg文件,然后传入项目名称和部署版本。
我们可以用如下的方式实现项目部署:
代码语言:javascript复制curl http://120.27.34.25:6800/addversion.json -F project=wenbo -F version=first -F egg=@weibo.egg
在这里, -F
代表添加一个参数,同时我们还需要将项目打包成Egg文件放到本地。
发出请求之后,我们可以得到如下结果:
代码语言:javascript复制{"status": "ok", "spiders": 3}
这个结果表明部署成功,并且Spider的数量为3。
此部署方法可能比较烦琐,后文会介绍更方便的工具来实现项目的部署。
3. schedule.json
这个接口负责调度已部署好的Scrapy项目运行。
我们可以用如下接口实现任务调度:
代码语言:javascript复制curl http://120.27.34.25:6800/schedule.json -d project=weibo -d spider=weibocn
这里需要传入两个参数,project
即Scrapy项目名称,spider
即Spider名称。
返回结果如下:
代码语言:javascript复制{"status": "ok", "jobid": "6487ec79947edab326d6db28a2d86511e8247444"}
status
代表Scrapy项目启动情况,jobid
代表当前正在运行的爬取任务代号。
4. cancel.json
这个接口可以用来取消某个爬取任务。如果这个任务是pending
状态,那么它将会被移除;如果这个任务是running
状态,那么它将会被终止。
我们可以用下面的命令来取消任务的运行:
代码语言:javascript复制curl http://120.27.34.25:6800/cancel.json -d project=weibo -d job=6487ec79947edab326d6db28a2d86511e8247444
这里需要传入两个参数,project
即项目名称,job
即爬取任务代号。
返回结果如下:
代码语言:javascript复制{"status": "ok", "prevstate": "running"}
status
代表请求执行情况,prevstate
代表之前的运行状态。
5. listprojects.json
这个接口用来列出部署到Scrapyd服务上的所有项目描述。
我们可以用如下命令来获取Scrapyd服务器上的所有项目描述:
代码语言:javascript复制curl http://120.27.34.25:6800/listprojects.json
这里不需要传入任何参数。
返回结果如下:
代码语言:javascript复制{"status": "ok", "projects": ["weibo", "zhihu"]}
status
代表请求执行情况,projects
是项目名称列表。
6. listversions.json
这个接口用来获取某个项目的所有版本号,版本号是按序排列的,最后一个条目是最新的版本号。
我们可以用如下命令来获取项目的版本号:
代码语言:javascript复制curl http://120.27.34.25:6800/listversions.json?project=weibo
这里需要一个参数project
,即项目的名称。
返回结果如下:
代码语言:javascript复制{"status": "ok", "versions": ["v1", "v2"]}
status
代表请求执行情况,versions
是版本号列表。
7. listspiders.json
这个接口用来获取某个项目最新版本的所有Spider名称。
我们可以用如下命令来获取项目的Spider名称:
代码语言:javascript复制curl http://120.27.34.25:6800/listspiders.json?project=weibo
这里需要一个参数project
,即项目的名称。
返回结果如下:
代码语言:javascript复制{"status": "ok", "spiders": ["weibocn"]}
status
代表请求执行情况,spiders
是Spider名称列表。
8. listjobs.json
这个接口用来获取某个项目当前运行的所有任务详情。
我们可以用如下命令来获取所有任务详情:
代码语言:javascript复制curl http://120.27.34.25:6800/listjobs.json?project=weibo
这里需要一个参数project
,即项目的名称。
返回结果如下:
代码语言:javascript复制{"status": "ok",
"pending": [{"id": "78391cc0fcaf11e1b0090800272a6d06", "spider": "weibocn"}],
"running": [{"id": "422e608f9f28cef127b3d5ef93fe9399", "spider": "weibocn", "start_time": "2017-07-12 10:14:03.594664"}],
"finished": [{"id": "2f16646cfcaf11e1b0090800272a6d06", "spider": "weibocn", "start_time": "2017-07-12 10:14:03.594664", "end_time": "2017-07-12 10:24:03.594664"}]}
status
代表请求执行情况,pendings
代表当前正在等待的任务,running
代表当前正在运行的任务,finished
代表已经完成的任务。
9. delversion.json
这个接口用来删除项目的某个版本。
我们可以用如下命令来删除项目版本:
代码语言:javascript复制curl http://120.27.34.25:6800/delversion.json -d project=weibo -d version=v1
这里需要一个参数project
,即项目的名称,还需要一个参数version
,即项目的版本。
返回结果如下:
代码语言:javascript复制{"status": "ok"}
status
代表请求执行情况,这样就表示删除成功了。
10. delproject.json
这个接口用来删除某个项目。
我们可以用如下命令来删除某个项目:
代码语言:javascript复制curl http://120.27.34.25:6800/delproject.json -d project=weibo
这里需要一个参数project
,即项目的名称。
返回结果如下:
代码语言:javascript复制{"status": "ok"}
status
代表请求执行情况,这样就表示删除成功了。
以上接口是Scrapyd所有的接口。我们可以直接请求HTTP接口,即可控制项目的部署、启动、运行等操作。
五、Scrapyd API的使用
以上的这些接口可能使用起来还不是很方便。没关系,还有一个Scrapyd API库对这些接口做了一层封装,其安装方式可以参考第1章的内容。
下面我们来看看Scrapyd API的使用方法。Scrapyd API的核心原理和HTTP接口请求方式并无二致,只不过Python封装后的库使用起来更加便捷。
我们可以用如下方式建立一个Scrapyd API对象:
代码语言:javascript复制from scrapyd_api import ScrapydAPI
scrapyd = ScrapydAPI('http://120.27.34.25:6800')
调用它的方法来实现对应接口的操作,例如部署的操作可以使用如下方式:
代码语言:javascript复制egg = open('weibo.egg', 'rb')
scrapyd.add_version('weibo', 'v1', egg)
这样我们就可以将项目打包为Egg文件,然后把本地打包的的Egg项目部署到远程Scrapyd。
另外,Scrapyd API还实现了所有Scrapyd提供的API接口,名称都是相同的,参数也是相同的。
例如,调用list_projects()
方法即可列出Scrapyd中所有已部署的项目:
scrapyd.list_projects()
['weibo', 'zhihu']
还有其他的方法在此不一一列举了,名称和参数都是相同的。更加详细的操作可以参考官方文档:http://python-scrapyd-api.readthedocs.io/。
六、结语
本节介绍了Scrapyd及Scrapyd API的相关用法,我们可以通过它来部署项目,并通过HTTP接口控制任务的运行。不过部署过程有一点不方便,项目需要先打包Egg文件然后再上传,这样比较烦琐。在下一节,我们介绍一个更加方便的工具来完成部署过程。