崔庆才python3爬虫-13章 Scrapy框架的使用-Spider Middleware的用法和Item Pipeline

Spider Middleware的用法

Spider Middleware是介入到Scrapy的 Spider处理机制的钩子框架。我们首先来看看它的架构，如图13-1所示。
当Downloader生成Response之后，Response会被发送给Spider,在发送给Spider之前，Response会首先经过Spider Middleware处理，当 Spider处理生成Item和Request之后, Item和 Request还会经
过Spider Middleware 的处理。

Spider Middleware有如下三个作用。
□ 我们可以在Downloader生成的Response发送给 Spider之前，也就是在Response发送给Spider之前对 Response进行处理。
□ 我们可以在Spider生成的Request发送给Scheduler之前，也就是在 Request发送给 Scheduler之前对 Request进行处理。
□ 我们可以在Spider生成的Item发送给Item Pipeline之前，也就是在 Item发送给Item Pipeline之前对 Item 进行处理。

使用说明

需要说明的是，Scrapy其实已经提供了许多Spider Middleware, 它们被 SPIDER_MIDDLEWARES_BASE这个变量所定义。
SPIDER_MIDDLEWARES_BASE 变量的内容如下：
{
'scrapy.spidermiddlewares.httperror.HttpErrorMiddleware': 50,
'scrapy.spidermiddlewares.offsite.OffsiteMiddleware': 500,
'scrapy.spidermiddlewares.referer.RefererMiddleware': 700,
'scrapy.spidermiddlewares.urllength.UrlLengthMiddleware': 800,
'scrapy.spidermiddlewares.depth.DepthMiddleware': 900,
}

和Downloader Middleware一样，Spider Middleware首先加入到 SPIDER_MIDDLEWARES设置中，该设置会和Scrapy中 SPIDER_MIDDLEWARES_BASE定义的Spider Middleware合并。然后根据键值的数字优先级排序 ，得到一个有序列表。第一个Middleware是最靠近引擎的，最后一个Middleware是最靠近Spider的〉

核心方法

Scrapy内置的Spider Middleware为Scrapy提供了基础的功能。如果我们想要扩展其功能，只需要实现某几个方法即可。
每个Spider Middleware都定义了以下一个或多个方法的类，核心方法有如下4个。
□ process_spider_input(response, spider)
□ process_spider_output(response, resuIt, spider)
□ process_spider_exception(response, exception, spider)
□ process_start_requests(start_requests, spider)

1	只需要实现其中一个方法就可以定义一个Spider Middlewareo 下面我们来看看这4 个方法的详细用法。

process_spider_input(response, spider)

当Response被Spider Middleware处理时，process_spider_input()方法被调用。

process_spider_input()方法的参数有如下两个。
□ response,是Response对象，即被处理的 Response
□ spider,是Spider对象，即该Response对应的Spider

□ process_spider_input()应该返回None或者抛出一个异常。
如果它返回None, Scrapy将会继续处理该Response, 调用所有其他的Spider Middleware,直到Spider处理该Response
□ 如果它抛出一个异常， Scrapy将不会调用任何其他Spider Middleware的process_spider_input()方法，而调用Request的 errback()方法。 errback的输出将会被重新输入到中间件中，使用
process_spider_output()方法来处理，当其抛出异常时则调用 process_spider_exception()来处理。

process_spider_output(response, result, spider)

当Spider处理Response返回结果时，process_spider_output()方法被调用。
□ process_spider_output()方法的参数有如下三个。
  response,是 Response对象，即生成该输出的Response
  result, 包含Request或Item对象的可迭代对象，即Spider返回的结果。
  spider,是 Spider对象，即其结果对应的Spider。

process_spider_output()必须返回包含Request或 Item对象的可迭代对象。

process_spider_exception(response, exception, spider)

当Spider或Spider Middleware的process_spider_input()方法抛出异常时，process_spider_exception()方法被调用。

process_spider_exception()方法的参数有如下三个。
□ response,是Response对象，即异常被抛出时被处理的Response
□ exception,是Exception对象，即被抛出的异常。
□ spider,是 Spider对象，即抛出该异常的Spider

process_spider_exception()必须要么返回None,要么返回一个包含Response或Item对象的可迭代对象。

  如果它返回None, Scrapy将继续处理该异常，调用其他Spider Middleware中的process_spider_exception()方法，直到所有Spider Middleware都被调用。
  如果它返回一个可迭代对象，则其他Spider Middleware的 process_spider_output()方法被调用，其他的process_spider_exception()不会被调用。

process_start_reqeusts(start.requests, spider)

process_start_requests()方法以Spider启动的Request为参数被调用，执行的过程类似于process_spider_output(),只不过它没有相关联的Response,并且必须返回Request

process_start_requests()方法的参数有如下两个。
□ start_requests,是包含Request 的可迭代对象，即Start Requests
□ spider,是 Spider对象，即Start Requests所属的Spider

process_start_requests()必须返回另一个包含Request对象的可迭代对象。

1
2

本节介绍了Spider Middleware 的基本原理和自定义Spider Middleware 的方法。 Spider Middleware
使用的频率不如Downloader Middleware的高，在必要的情况下它可以用来方便数据的处理。

Item Pipeline

Item Pipeline是项目管道。在前面我们已经了解了Item Pipeline的基本用法，本节我们再作详细了解它的用法。

首先我们看看Item Pipeline在 Scrapy中的架构，如图13-1所示。
图中的最左侧即为Item Pipeline,它的调用发生在Spider产生Item之后。当 Spider解析完Response之后，Item就会传递到Item Pipeline,被定义的 Item Pipeline组件会顺次调用，完成一连串的处理过程，比如数据清洗、存储等。

Item Pipeline的主要功能有如下4点 。
□ 清理HTML数据。
□ 验证爬取数据，检查爬取字段。
□ 查重并丢弃重复内容。
□ 将爬取结果保存到数据库。

核心方法

我们可以自定义Item Pipeline,只需要实现指定的方法，其中必须要实现的一个方法是 ：
process_item(item, spider)

另外还有如下几个比较实用的方法。
□ open_spider(spider)
□ close_spider(spider)
□ from_crawler(cls, crawler)

下面我们详细介绍这几个方法的用法。

process_item(item, spider)

process_item()是必须要实现的方法，被定义的Item Pipeline会默认调用这个方法对Item进行处理比如，我们可以进行数据处理或者将数据写入到数据库等操作。(它必须返回Item类型的值或者抛出一个Dropitem异常。)

process_item()方法的参数有如下两个。
□ item ,是 Item对象，即被处理的Item。
□ spider,是 Spider对象，即生成该 Item的Spider

process_item()方法的返回类型归纳如下。
□ 如果它返回的是Item对象，那么此Item会被低优先级的Item Pipeline的 process_item()方法处理，直到所有的方法被调用完毕。
□如果它抛出的是Dropitem异常，那么此Item会被丢弃, 不再进行处理。

open_spider(self, spider)

1	open_spider()方法是在Spider开启的时候被自动调用的。在这里我们可以做一些初始化操作，如开启数据库连接等。其中，参数spider就是被开启的Spider对象。

close_spider(spider)

1	close_spider()方法是在Spider关闭的时候自动调用的。在这里我们可以做一些收尾工作，如关闭数据库连接等。其中，参数spider就是被关闭的Spider对象

from_crawler(cls, crawler)

from_crawler()方法是一个类方法，用@classmethod标识，是一种依赖注入的方式。它的参数是crawler,通过crawler对象，我们可以拿到Scrapy的所有核心组件，如全局配置的每个信息，然后创建一个Pipeline实例。参数cls就是 Class,最后返回一个Class实例。

实战

1
2
3

我们以爬取360摄影美图为例，来分别实现MongoDB存储、MySQL存储、Image图片存储的三个Pipeline

请确保已经安装好MongoDB和MySQL数据库，安装好Python的PyMongo、PyMySQL、Scrapy框架，如没有安装可以参考第1章的安装说明。

我们这次爬取的目标网站为：https://image.so.com。打开此页面，切换到摄影页面，网页中呈现了许许多多的摄影美图。我们打开浏览器开发者工具，过滤器切换到XHR选项，然后下拉页面，可以看到下面就会呈现许多Ajax请求

返回格式是JSON
其中list字段就是一张张图片的详情信息，包含了30张图片的ID、名称、链接、缩略图等信息。另外观察Ajax请求的参数信息，有一个参数sn一直在变化，这个参数很明显就是偏移量。当sn为30时，返回的是前30张图片，sn为60时，返回的就是第31-60张图片。另外,ch参数是摄影类别，listtype是排序方式，temp参数可以忽略。

所以我们抓取时只需要改变sn的数值就好了。
下面我们用Scrapy来实现图片的抓取，将图片的信息保存到MongoDB、MySQL,同时将图片存储到本地。

创建项目

首先新建一个项目，命令如下所示：
scrapy startproject images36O

接下来新建一个Spider,命令如下所示：
scrapy genspider images images.so.com
这样我们就成功创建了一个Spidero

构造请求

接下来定义爬取的页数。比如爬取50页、每页30张,也就是1500张图片，我们可以
先在settings.py里面定义一个变量MAX_PAGE,添加如下定义：
MAX_PAGE = 50

定义start_requests()方法，用来生成50次请求，如下所示：
def start_requests(self):
	data = {'ch': 'photography', 'listtype': 'new'}
	base_url = 'https://image.so.com/zj ?'
	for page in range(l, self.settings.get('MAX_PAGE') + 1):
		data['sn'] = page * 30
		params = urlencode(datm)
		url = base_url + params
		yield Request(url, self.parse)

在这里我们首先定义了初始的两个参数，sn参数是遍历循环生成的。然后利用 urlencode()方法将字典转化为URL的GET参数，构造出完整的URL ,构造并生成Request。

还需要引入scrapy.Request和 urllib.parse模块，如下所示：
from scrapy import Spider, Request
from urllib.parse import urlencode

再修改settings.py中 的 ROBOTSTXT_OBEY变量，将其设置为False,否则无法抓取，如下所示：
ROBOTSTXT_OBEY = False

运行爬虫，即可以看到链接都请求成功，执行命令如下所示：
scrapy crawl images

所有请求的状态码都是200 ,这就证明图片信息爬取成功

提取信息

首先定义一个Item,叫作Imageltem,如下所示：
from scrapy import Item, Field
class ImageItem(Item):
	collection = table = 'images'
	id = Field()
	url = Field()
	title = Field()
	thumb = Field()

在这里我们定义了4个字段，包括图片的ID、链接、标 题、缩略图。另外还有两个属性collection和table, 都定义为images字符串，分别代表MongoDB存储 的Collection名称和MySQL存储的表名称。

接下来我们提取Spider里有关信息，将parse()方法改写为如下所示：
def parse(self, response):
	result = json.loads(response.text)
	for image in result.get('list'):
		item = Imageltem()
		item['id'] = image.get(1imageid')
		item[ 'url' ] = image.get(,qhimg_u:r].,)
		item['title'] = image.get('group_title')
		item[' thumb'] = image, ge t(，qhimg_thumb_u:rT)
		yield item

首先解析JSON,遍历其list字段，取出一个个图片信息，然后再对Imageltem赋值，生成Item对象。
                               
这样我们就完成了信息的提取。

存储信息

MONGODB

首先确保MongoDB已经正常安装并且正常运行。
我们用一个MongoPipeline将信息保存到MongoDB, 在pipelines.py里添加如下类的实现：
import pymongo
class MongoPipeline(object):
	def _init_(self, mongo_uri, mongo_db):
		self.mongo_uri = mongo_uri
		self.mongo_db = mongo_db
	@classmethod
	def from_crawler(cls, crawler):
		return cls(
mongo_uri=crawler.settings.get('MONGO_URI'),
mongo_db=crawler.settings.get('MONGO_DB')
)
    def open_spider(self, spider):
		self.client = pymongo.MongoClient(self.mongo_uri)
		self.db = self.client[self.mongo_db]
	def process_item(self, item, spider):
		self.db[item.collection].insert(dict(item))
		return item
	def close_spider(self, spider):
		self.client.close()

这里需要用到两个变量，MONGO_URI和MONGO_DB,即存储到MongoDB的链接地址和数据库名称。

我们在settings.py里添加这两个变量, 如下所示：
MONGO_URI = 'localhost'
MONGODB = 'images36O'

这样一个保存到MongoDB的 Pipeline的就创建好了。这里最主要的方法是process_item()方法,直接调用Collection对象的insert()方法即可完成数据的插入，最后返回Item 对象。

MySQL

首先确保MySQL已经正确安装并且正常运行。
新建一个数据库，名字还是images360, SQL语句如下所示：
CREATE DATABASE images36O DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci

新建一个数据表，包含id 、u rl、title、thumb四个字段，SQL语句如下所示：
CREATE TABLE images (id VARCHAR(255) PRIMARY KEY, url VARCHAR(255) NULL, title VARCHAR(255) NULL ,
thumb VARCHAR(255) NULL)

执行完SQL语句之后，我们就成功创建好了数据表。接下来就可以往表里存储数据了。

接下来我们实现一个MySOLPipeline,代码如下所示：
import pymysql
class MysqlPipeline():
	def _init_(self, host, database, user, password, port):
        self.host = host
        self.database = database
        self.user = user
        self.password = password
        self.port = port
	@classmethod
	def from_crawler(cls, crawler):
		return cls(
host=crawler.settings.get('MYSOL_HOST'),
database=crawler.settings.get('MYSOL_DATABASE'),
user=crawler.settings.get('MYSOL_USER'),
password=crawler.settings.get('MYSOL_PASSWORD'),
port=crawler.settings.get('MYSOL_PORT'),
)
	def open_spider(self, spider):
		self.db = pymysql.connect(self.host, self.user, 	self.password, self.database, charset='utf8',
port=self.port)
		self.cursor = self.db.cursor()
	def close_spider(self, spider):
		self.db.close()
	def process_item(self, item, spider):
		data = dict(item)
		keys = ', '.join(data.keys())
		values = ', '.join(['%s'] * len(data))
		sql = 'insert into %s (%s) values (%s)' % (item.table, keys, values)
		self.cursor.execute(sql, tuple(data.values()))
		self.db.commit()
		return item

Image Pipeline

1
2

Scrapy提 供了专门处理下载的Pipeline,包括文件下载和图片下载。下载文件和图片的原理与抓取页面的原理一样，因此下载过程支持异步和多线程，下载十分高效。下面我们来看看具体的实现过程。
官方文档地址为： https://doc.scrapy.org/en/latest/topics/media-pipeline.htmlo

首先定义存储文件的路径，需要定义一个IMAGES_STORE变量，在 settings.py中添加如下代码：
IMACES_STORE = './images'
在这里我们将路径定义为当前路径下的images子文件夹，即下载的图片都会保存到本项目的images文件夹中。
内置的ImagesPipeline会默认读取Item的image_urls字段，并认为该字段是一个列表形式，它会遍历Item的image_urls字段，然后取出每个URL进行图片下载。
但是现在生成的Item 的图片链接字段并不是image_urls字段表示的，也不是列表形式，而是单个的URL。所以为了实现下载，我们需要重新定义下载的部分逻辑，即要自定义ImagePipeline,继承内置的ImagesPipeline,重写几个方法。

from scrapy import Request
from scrapy.exceptions import DropItem
from scrapy.pipelines.images import ImagesPipeline
class ImagePipeline(ImagesPipeline):
	def file_path(self, request, response=None, info=None):
		url = request.url
		file_name = url.split(7' )[-l]
		return file_name
	def item_completed(self, results, item, info):
		image_paths = [x['path'] for ok, x in results if ok]
		if not image_paths:
			raise Dropltem('Image Downloaded Failed')
		return item
	def get_media_requests(self, item, info):
		yield Request(item['url'])

在这里我们实现了ImagePipeline,继承Scrapy内置的Im agesPipeline,重写下面几个方法。
□ get_media_requests()。它的第一个参数item是爬取生成的Item对象。我们将它的url字段取出来，然后直接生成Request对象。此Request加入到调度队列，等待被调度，执行下载。
□ file_path() 它的第一个参数request就是当前下载对应的Request对象。这个方法用来返回保存的文件名，直接将图片链接的最后一部分当作文件名即可。它利用split() 函数分割链接
并提取最后一部分，返回结果。这样此图片下载之后保存的名称就是该函数返回的文件名。
□ item_completed(),它是当单个Item 完成下载时的处理方法。因为并不是每张图片都会下载成功，所以我们需要分析下载结果并剔除下载失败的图片。如果某张图片下载失败，那么我们就不需保存此Item到数据库。该方法的第一个参数results就是该Item对应的下载结果，它是一个列表形式，列表每一个元素是一个元组，其中包含了下载成功或失败的信息。这里我们遍历下载结果找出所有成功的下载列表。如果列表为空，那么该Item对应的图片下载失败 ，随即抛出异常Dropitem,该Item忽略。否则返回该Item,说明此Item有效。

现在为止，三个Item Pipeline的定义就完成了。最后只需要启用就可以了，修改settings.py, 设置ITEM_PIPELINES,如下所示：
ITEM_PIPELINES = {
'images36O.pipelines.ImagePipeline': 300,
'images36O.pipelines.MongoPipeline': 301,
'images36O.pipelines.MysqlPipeline': 302,
}

这里注意调用的顺序。我们需要优先调用ImagePipeline对Item做下载后的筛选，下载失败的Item就直接忽略，它们就不会保存到MongoDB和MySQL里。随后再调用其他两个存储的Pipeline,这样就能确保存入数据库的图片都是下载成功的。

接下来运行程序，执行爬取，如下所示：
scrapy crawl images
爬虫一边爬取一边下载，下载速度非常快

没有伞的孩子，必须努力奔跑!

Typewriter Mode** 已开启。

可以在视图菜单中关闭

不再显示关闭