Spider 中间件(Middleware)

Spider 中间件(Middleware) 下载器中间件是介入到 Scrapy 的 spider 处理机制的钩子框架，您可以添加代码来处理发送给 Spiders 的 response 及 spider 产生的 item 和 request。

激活 spider 中间件

要启用 spider 中间件，您可以将其加入到 SPIDER_MIDDLEWARES 设置中。该设置是一个字典，键位中间件的路径，值为中间件的顺序(order)。

样例:

SPIDER_MIDDLEWARES = {
    'myproject.middlewares.CustomSpiderMiddleware': 543,
}

SPIDER_MIDDLEWARES 设置会与 Scrapy 定义的 SPIDER_MIDDLEWARES_BASE 设置合并(但不是覆盖)，而后根据顺序(order)进行排序，最后得到启用中间件的有序列表: 第一个中间件是最靠近引擎的，最后一个中间件是最靠近 spider 的。

关于如何分配中间件的顺序请查看 SPIDER_MIDDLEWARES_BASE 设置，而后根据您想要放置中间件的位置选择一个值。由于每个中间件执行不同的动作，您的中间件可能会依赖于之前(或者之后)执行的中间件，因此顺序是很重要的。

如果您想禁止内置的(在 SPIDER_MIDDLEWARES_BASE 中设置并默认启用的)中间件，您必须在项目的 SPIDER_MIDDLEWARES 设置中定义该中间件，并将其值赋为 None。例如，如果您想要关闭 off-site 中间件:

SPIDER_MIDDLEWARES = {
    'myproject.middlewares.CustomSpiderMiddleware': 543,
    'scrapy.contrib.spidermiddleware.offsite.OffsiteMiddleware': None,
}

最后，请注意，有些中间件需要通过特定的设置来启用。更多内容请查看相关中间件文档。

编写您自己的 spider 中间件

编写 spider 中间件十分简单。每个中间件组件是一个定义了以下一个或多个方法的 Python 类:

class scrapy.contrib.spidermiddleware.SpiderMiddleware

process_spider_input(response, spider)

当 response 通过 spider 中间件时，该方法被调用，处理该 response。

process_spider_input()应该返回 None 或者抛出一个异常。

如果其返回 None，Scrapy 将会继续处理该 response，调用所有其他的中间件直到 spider 处理该 response。

如果其跑出一个异常(exception)，Scrapy 将不会调用任何其他中间件的 process_spider_input()方法，并调用 request 的 errback。 errback 的输出将会以另一个方向被重新输入到中间件链中，使用 process_spider_output()方法来处理，当其抛出异常时则带调用 process_spider_exception()。

参数:

response (Response 对象) – 被处理的 response
spider (Spider 对象) – 该 response 对应的 spider

process_spider_output(response, result, spider)

当 Spider 处理 response 返回 result 时，该方法被调用。

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

参数:

response (Response 对象) – 生成该输出的 response
result (包含 Request 或 Item 对象的可迭代对象(iterable)) – spider 返回的 result
spider (Spider 对象) – 其结果被处理的 spider

process_spider_exception(response, exception, spider)

当 spider 或(其他 spider 中间件的) process_spider_input()跑出异常时，该方法被调用。

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

如果其返回 None，Scrapy 将继续处理该异常，调用中间件链中的其他中间件的 process_spider_exception()方法，直到所有中间件都被调用，该异常到达引擎(异常将被记录并被忽略)。

如果其返回一个可迭代对象，则中间件链的 process_spider_output()方法被调用，其他的 process_spider_exception()将不会被调用。

参数:

response (Response 对象) – 异常被抛出时被处理的 response
exception (Exception 对象) – 被跑出的异常
spider (Spider 对象) – 抛出该异常的 spider

process_start_requests(start_requests, spider)

该方法以 spider 启动的 request 为参数被调用，执行的过程类似于 process_spider_output()，只不过其没有相关联的 response 并且必须返回 request(不是 item)。

其接受一个可迭代的对象(start_requests 参数)且必须返回另一个包含 Request 对象的可迭代对象。

注解

当在您的 spider 中间件实现该方法时，您必须返回一个可迭代对象(类似于参数 start_requests)且不要遍历所有的 start_requests。该迭代器会很大(甚至是无限)，进而导致内存溢出。Scrapy 引擎在其具有能力处理 start request 时将会拉起 request，因此 start request 迭代器会变得无限，而由其他参数来停止 spider( 例如时间限制或者 item/page 记数)。

参数:

start_requests (包含 Request 的可迭代对象) – start requests
spider (Spider 对象) – start requests 所属的 spider

内置 spider 中间件参考手册

本页面介绍了 Scrapy 自带的所有 spider 中间件。关于如何使用及编写您自己的中间件，请参考 spider middleware usage guide。

关于默认启用的中间件列表(及其顺序)请参考 SPIDER_MIDDLEWARES_BASE 设置。

DepthMiddleware

class scrapy.contrib.spidermiddleware.depth.DepthMiddleware

DepthMiddleware 是一个用于追踪每个 Request 在被爬取的网站的深度的中间件。其可以用来限制爬取深度的最大深度或类似的事情。

DepthMiddleware 可以通过下列设置进行配置(更多内容请参考设置文档):

DEPTH_LIMIT - 爬取所允许的最大深度，如果为 0，则没有限制。
DEPTH_STATS - 是否收集爬取状态。
DEPTH_PRIORITY - 是否根据其深度对 requet 安排优先级

HttpErrorMiddleware

class scrapy.contrib.spidermiddleware.httperror.HttpErrorMiddleware

过滤出所有失败(错误)的 HTTP response，因此 spider 不需要处理这些 request。处理这些 request 意味着消耗更多资源，并且使得 spider 逻辑更为复杂。

根据 HTTP 标准，返回值为 200-300 之间的值为成功的 resonse。

如果您想处理在这个范围之外的 response，您可以通过 spider 的 handle_httpstatus_list 属性或 HTTPERROR_ALLOWED_CODES 设置来指定 spider 能处理的 response 返回值。

例如，如果您想要处理返回值为 404 的 response 您可以这么做:

class MySpider(CrawlSpider):
    handle_httpstatus_list = [404]

Request.meta 中的 handle_httpstatus_list 键也可以用来指定每个 request 所允许的 response code。

不过请记住，除非您知道您在做什么，否则处理非 200 返回一般来说是个糟糕的决定。

更多内容请参考:HTTP Status Code 定义。

HttpErrorMiddleware settings

HTTPERROR_ALLOWED_CODES

默认:[]

忽略该列表中所有非 200 状态码的 response。

HTTPERROR_ALLOW_ALL

默认:False

忽略所有 response，不管其状态值。

OffsiteMiddleware

class scrapy.contrib.spidermiddleware.offsite.OffsiteMiddleware

过滤出所有 URL 不由该 spider 负责的 Request。

该中间件过滤出所有主机名不在 spider 属性 allowed_domains 的 request。

当 spide 返回一个主机名不属于该 spider 的 request 时，该中间件将会做一个类似于下面的记录:

DEBUG: Filtered offsite request to 'www.othersite.com': <GET http://www.othersite.com/some/page.html>

为了避免记录太多无用信息，其将对每个新发现的网站记录一次。因此，例如，如果过滤出另一个 www.othersite.com 请求，将不会有新的记录但如果过滤出 someothersite.com 请求，仍然会有记录信息(仅针对第一次)。

如果 spider 没有定义 allowed_domains 属性，或该属性为空，则 offsite 中间件将会允许所有 request。

如果 request 设置了 dont_filter 属性，即使该 request 的网站不在允许列表里，则 offsite 中间件将会允许该 request。

RefererMiddleware

class scrapy.contrib.spidermiddleware.referer.RefererMiddleware

根据生成 Request 的 Response 的 URL 来设置 Request Referer 字段。

RefererMiddleware settings

REFERER_ENABLED

默认:True

是否启用 referer 中间件。

UrlLengthMiddleware

class scrapy.contrib.spidermiddleware.urllength.UrlLengthMiddleware

过滤出 URL 长度比 URLLENGTH_LIMIT 的 request。

UrlLengthMiddleware 可以通过下列设置进行配置(更多内容请参考设置文档):

URLLENGTH_LIMIT - 允许爬取 URL 最长的长度。