爬虫：Splash使用

Splash 是一个JavaScript渲染服务，是一个带有HTTP API的轻量浏览器，同时它对接了Python中的Twisted和QT库利用它，可以同样实现动态渲染页面的抓取

1、安装

1.1 安装服务和Python库

1.2 使用Splash

2 Splash Lua 脚本 API用法

2.1 入口及返回值

2.2 异步处理

3、Splash 对象属性

3.1 args：获取请求参数

3.2 js_enabled JavaScript执行开关

3.3 resource_timeout 加载时间

3.4 images_enabled 设置图片是否加载

3.5 plugins_enabled 控制浏览器插件开启和关闭

3.6 scroll_position 控制页面的滚动

4、Splash 对象的方法

4.1 go() 用于请求某个链接

4.2 wait() 控制页面的等待时间

4.3 jsfunc() 调用JavaScript定义的方法

4.4 evaljs() 执行并返回最后一条JavaScipt语句的返回结果【静态】

4.5 runjs() 此方法可以执行JavaScript动作或声明的方法【动态】

4.6 autoload() 自动加载对象

4.7 call_later() 设置定时任务或延迟时间

4.8 http_get() 模拟发送HTTP的GET请求

4.9 http_post() 模拟Post请求

5.0 set_content() 设置页面内容

5.1 html() 获取网页的源代码

5.2 png() 获取页面图片

5.3 jpeg() 获取JPEG格式的网页截图

5.4 har() 获取页面加载过程描述

5.5 url() 获取当前正在访问的URL

5.6 get_cookies() 获取当前页面的Cookies

5.7 add_cookie()

5.8 clear_cookies() 清除Cookies

5.9 get_viewport_size() 获取浏览器页面的大小

6.0 set_viewport_size() 设置当前浏览器

6.1 set_viewport_full() 此方法设置浏览器全屏

6.3 set_user_agent() 设置浏览器的User-Agent

6.4 set_custom_headers() 设置请求头

6.5 select()

6.6 select_all() 选中所有符合条件的节点

6.7 mouse_click() 鼠标操作

3 Splash API调用

3.1 render.html 获取JavaScript渲染的页面的HTML代码

3.2 render.png 获取网页截图

3.3 render.jepg 获取JPEG格式的图片

3.4 render.har

3.5 render.json 此接口包含了前面所有的功能

3.6 execute 与Lua脚本对接

1、安装

Scrapy-Splash 是一个Scrapy中支持JavaScript渲染的工具，安装分为两部分，一个是Splash服务的安装，具体是通过docker，安装之后，会启动一个服务，通过它的接口来实现JavaScript 页面的加载，另外一个是Scrapy-Splash的Python库的安装，安装之后可在Scrapy中使用Splash服务

利用Splash，可以实现以下功能

异步方式处理多个网页渲染过程
获取渲染后的页面的源代码或截图
通过关闭图片渲染或者使用Adblock规则来加快页面渲染速度
可执行特定的JavaScript脚本
可通过Lua脚本控制页面渲染过程
获取渲染的详细过程并通过HAR（HTTP Archive）格式呈现

1.1 安装服务和Python库

[root@node1 ~]# docker run -p 8050:8050 scrapinghub/splash

访问：http://ip:8050

接下来在安装其Python库

pip install scrapy-splash

1.2 使用Splash

输入框输入https://www.baidu.com

可以看到，网页的返回结果呈现了渲染截图、HAR加载统计数据、网页的源代码。

通过首页可以看到它其实是通过一段代码来展示的：这脚本其实是用Lua语言写的脚本

function main(splash, args)assert(splash:go(args.url))assert(splash:wait(0.5))return {html = splash:html(),png = splash:png(),har = splash:har(),}
end

2 Splash Lua 脚本 API用法

Splash 可以通过Lua脚本执行一系列渲染操作，这样我们就可以用Splash模拟类似Chrome PhantomJS的操作了

2.1 入口及返回值

function main(splash, args)splash:go("http://www.baidu.com")splash:wait(0.5)local title = splash:evaljs("document.title")return {title=title}
end

结果：

通过evaljs() 方法传入JavaScript脚本，而document.title的执行结果就是返回网页标题，执行王弼后将期赋值给一个title变量，随后将其返回

需要注意的是这里定义的方法叫做：main()。这个名称必须是固定的，Splash会默认调用这个方该方法返回值既可以是自定形式，也可以是字符内容形式，最后都会转化为 Splash HTTP Response
字典形式

function main(splash, args)splash:go("http://www.baidu.com")splash:wait(0.5)local title = splash:evaljs("document.title")return {hello="word"}
end

结果：

返回一个字符串

function main(splash, args)splash:go("http://www.baidu.com")splash:wait(0.5)local title = splash:evaljs("document.title")return "word"
end

结果：

2.2 异步处理

Splash 支持异步处理，但是这里并没有显式指明回调的方法，其回调的跳转是在Splash内部完成的

function main(splash, args)local example_urls = {"www.baidu.com","www.taobao.com","www.zhihu.com"}local urls = args.urls or example_urlslocal results = { }for index, url in ipairs(urls) dolocal ok ,reason = splash:go{"https://" ..url}if ok thensplash:wait(2)results[url] = splash:png()endendreturn results
end

结果运行后3个站点截图

wait() 方法会等待，当Splash执行到次方法时，它会转而去处理其他任务，然后在指定的时间过后再回来继续处理；这里做了加载时异常检测。go() 返回加载页面的结果状态，如果页面出现4xx或5xx状态码。ok变量就会为空，就不会加载后的图片

3、Splash 对象属性

例子中 main(0 方法的第一个参数是 splash ，这个对象非常重要，它类似于Selenium中的 WebDriver 对象，我们可以调用它的一些属性和方法来控制加载过程

3.1 args：获取请求参数

该属性可以获取加载时配置的参数，比如URL ，如果为GET 请求，它还可以获取GET 请求参数；如果为 POST 请求，它可以获取表单提交的数据 Splash支持使用第二个参数直接作为args

function main(splash, args)local url = args.url
end

第二个参数args就相当于splash.args 属性，等价于

function main(splash, args)local url = splash.args.url
end

3.2 js_enabled JavaScript执行开关

这个属性是 Splas 的JavaScript 执行开关，可以将其配置为 true或 false 来控制是否执行 JavaScript 代码，默认为 true。

function main(splash, args)splash:go('https://www.taobao.com')splash.js_enabled = falselocal title = splash:evaljs('document.title')return {title=title}
end

evaljs() 方法执行JavaScript代码就会抛出异常；不过一般来说，都是默认打开的

3.3 resource_timeout 加载时间

此属性可以设置加载的超时时间，单位是秒。如果设置为 0或nil （类似 Python中的None ），代表不检测超时

function main(splash, args)splash.resource_timeout = 0.1assert(splash:go("https://www.taobao.com"))return splash:png()
end

结果：超出了时间，无响应就报错

3.4 images_enabled 设置图片是否加载

此属性可以设置图片是否加载，默认情况下是加载的。禁用该属性后，可以节省网络流量并提高网页加载速度但是需要注意的是，禁用图片加载可能会影响 JavaScript 渲染，因为禁用图片之后，它的外层 DOM 节点的高度会受影响，进而影响 DOM 节点的位置因此，如果 JavaScript 对图片节点有操作的话，其执行就会受到影响。

另外值得注意的是， Splash 使用了缓存, 如果一开始加载出来了网页图片，然后禁用了图片加载，再重新加载页面，之前加载好的图片可能还会显示出来，这时直接重启 Splash 即可

function main(splash, args)splash.images_enabled = falseassert(splash:go('https://www.baodu.com'))return {png = splash:png()}
end

结果：

3.5 plugins_enabled 控制浏览器插件开启和关闭

此属性可以控制浏览器插件（如 Flash 插件）是否开启。默认情况下，此属性是 false ，表示不开可以使用如下代码控制其开启和关闭：

splash.plugins_enabled = true/false

3.6 scroll_position 控制页面的滚动

通过设置此属性，我们可以控制页面上下或左右滚动这是一个比较常用的属性

function main(splash, args)assert(splash:go("https://www.taobao.com"))splash.scroll_position = {x=100,y=400}return {png=splash:png()}
end

结果：

4、Splash 对象的方法

Splash还是这几种对象方法

4.1 go() 用于请求某个链接

可以模拟GET和POST请求，同时支持传入请求头、表单等数据

ok, reason = splash:go(url,bashurl=nil,headers=nil,http_name="GET",body=nil,formdata=nil)

其参数说明：

url：请求的url
bashurl：可选参数，默认为空，表示资源加载相对路径
headers：可选参数，默认为空，表示请求头
http_method：可选参数，默认为GET，同时支持POST
body：可选参数，默认为空，发POST请求时的表单数据，使用Content-type为application/json
formdata：可选参数，默认为空,POST的时候的表单数据，使用的Content-type为application/x-www-form-urlencoded

该方法返回结果是OK和原因reason的组合，如果ok为空，代表网页加载出现了错误，此时reason变量中包含了错误的原因，否则证明页面加载成功

function main(splash, args)local ok, reason = splash:go{url="http://httpbin.org/post",http_method="POST",body="name=Germey"}if ok thenreturn splash:html()end
end

提交的是一个POST请求，并传入了POST表单数据，如果成功返回源代码

4.2 wait() 控制页面的等待时间

可以控制页面的等待时间

ok,reason = splash:wait(time,cancel_on_redirect=false,cancel_on_error=true)

参数说明：

time：等待的秒数
cancel_on_redirect：可选参数，默认为false，表示如果发生了重定向就停止等待，并返回重定向结果
cancel_on_error：可选参数，默认为false，表示如果发生了加载错误，就停止等待

返回结果同样是ok和reason的组合

function main(splash, args)splash:go("https://www.taobao.com")splash:wait(2)return {html=splash:html()}
end

结果：

4.3 jsfunc() 调用JavaScript定义的方法

可以直接调用JavaScript定义的方法，但是调用的方法需要用双中括号包围，这相当于实现了JavaScript方法到Lua脚本的转化

function main(splash, args)local get_div_count = splash:jsfunc([[function () {var body = document.body;var divs = body.getElementsByTagName("div");return divs.length;}]])splash:go("https://www.baidu.com")return("There are %s DIVs"):format(get_div_count())
end

结果：

4.4 evaljs() 执行并返回最后一条JavaScipt语句的返回结果【静态】

此方法可以执行 JavaScript 代码并返回最后一条JavaScript 语句的返回结果

function main(splash, args)result = splash:evaljs(js)
end

例子：

function main(splash, args)result = splash:evaljs("document.title")
end

4.5 runjs() 此方法可以执行JavaScript动作或声明的方法【动态】

此方法可以执行 JavaScript 代码，它与 evaljs() 的功能类似，但是更偏向于执行某些动作或某些方法

function main(splash, args)splash:go("https://www.baidu.com")splash:runjs("foo = function() { return 'bar' }")local result = splash:evaljs("foo()")return result
end

结果：

4.6 autoload() 自动加载对象

此方法可以设置每个页面自动加载的对象

ok, reason = splash:autoload(source_or_url, source=nil ,url=nil)

参数说明如下：

source_or_url：JavaScript代码或者JavaScript库连接
source：JavaScript 代码
url：JavaScript库连接

此方法只负责加载 JavaScript 代码或库，不执行任何操作，如果要执行操作，可以调用 evaljs() 或runjs() 方法

function main(splash, args)splash:autoload([[function get_document_title(){return document.title;} ]])splash:go("https://www.taobao.com")return splash:evaljs("get_document_title()")
end

用autoload() 方法声明一个JavaScript方法，然后通过evaljs() 方法来执行此JavaScript方法
结果：

也可以加载某些库

function main(splash, args)assert(splash:autoload("https://code.jquery.com/jquery-2.1.3.min.js"))assert(splash:go("https://www.taobao.com"))local version = splash:evaljs("$.fn.jquery")return "JQuery version: " .. version
end

结果：

4.7 call_later() 设置定时任务或延迟时间

此方法可以通过设置定时任务和延迟时间来实现任务延时执行，井且可以在执行前通过 cancel () 方法重新执行定时任务

function main(splash, args)local snapshots = { }local timer = splash:call_later(function()snapshots["a"] = splash:png()splash:wait(1.0)snapshots["b"] = splash:png()end, 0.2)splash:go("https://www.baidu.com")splash:wait(3.0)return snapshots
end

设置了一个定时任务，0.2秒的时候获取网页截图，然后等待1秒，1.2秒再次获取网页结果

结果：

4.8 http_get() 模拟发送HTTP的GET请求

此方法可以模拟发送 HTTP 的GET 请求

response = splash:http_get{url,headers=nil,follow_redirects=true}

参数如下：

url：请求url
headers：可选参数，默认为空，请求头
follow_redirects：可选参数，表示是否启动自动重定向，默认为true

function main(splash, args)local treat = require("treat")local response = splash:http_get("http://httpbin.org/get")return {html=treat.as_string(response.body),url=response.url,status=response.status}
end

结果：

4.9 http_post() 模拟Post请求

和http_get() 方法类似，此方法用来模拟发送 POST 请求，不过多了一个参数 body

response = splash:http_post{url, headers=nil, follow_redirects=true, body=nil}

参数说明如下：

url：请求的url
headers：可选参数，默认为空，请求头
follow_redirects：可选参数，表示是否启动自动重定向，默认为true
body：可选参数，及表单数据，默认为空

function main(splash, args)local treat= require("treat")local json = require("json")local response = splash:http_post{"http://httpbin.org/post",body=json.encode({name="Germey"}),headers={["content-type"]="application/json"}}return {html=treat.as_string(response.body),url=response.url,status=response.status}
end

结果：

5.0 set_content() 设置页面内容

此方法用来设置页面的内容

function main(splash, args)assert(splash:set_content("<html><body><h1>hello</h1></body></html>"))return splash:png()
end

结果：

5.1 html() 获取网页的源代码

此方法用来获取网页的源代码，它是非常简单又常用的方法

function main(splash, args)splash:go("https://www.baidu.com")return splash:html()
end

结果：

5.2 png() 获取页面图片

此方法用来获取 PN 格式的网页截图

function main(splash, args)splash:go("https://www.baidu.com")return splash:png()
end

结果：

5.3 jpeg() 获取JPEG格式的网页截图

此方法用来获取 JPEG 格式的网页截图

function main(splash, args)splash:go("https://www.taobao.com")return splash:jpeg()
end

结果：

5.4 har() 获取页面加载过程描述

此方法用来获取页面加载过程描

function main(splash, args)splash:go("https://www.taobao.com")return splash:har()
end

结果：

5.5 url() 获取当前正在访问的URL

此方法可以获取当前正在访问的URL

function main(splash, args)splash:go("https://www.taobao.com")return splash:url()
end

结果：

5.6 get_cookies() 获取当前页面的Cookies

此方法可以获取当前页面的 Cookies

function main(splash, args)splash:go("https://www.taobao.com")return splash:get_cookies()
end

结果：

5.7 add_cookie()

此方法可以为当前页面添加 Cookie

cookies = splash:add_cookie(name,value,path=nil,domain=nil,expires=nil,httpOnly=nil,secure=nil)

各个参数代表 Cookie 的各个属性

function main(splash, args)splash:add_cookie{"seesionid","2323432423","/",domain="http://exapmle.com"}splash:go("http://example.com/")return splash:html()
end

5.8 clear_cookies() 清除Cookies

此方法可以清除所有的 Cookies

function main(splash, args)splash:go("https://www.taobao.com/")splash:clear_cookies()splash:get_cookies()
end

结果：

5.9 get_viewport_size() 获取浏览器页面的大小

此方法可以获取当前浏览器页面的大小，即宽高

function main(splash, args)splash:go("https://www.taobao.com/")return splash:get_viewport_size()
end

结果：

6.0 set_viewport_size() 设置当前浏览器

此方法可以设置当前浏览器页面的大小，即宽高

function main(splash, args)splash:set_viewport_size(400,700)splash:go("https://www.taobao.com/")return splash:png()
end

结果：

6.1 set_viewport_full() 此方法设置浏览器全屏

此方法可以设置浏览器全屏显示

function main(splash, args)splash:set_viewport_full()assert(splash:go("https://www.taobao.com"))return splash:png()
end

结果：

6.3 set_user_agent() 设置浏览器的User-Agent

此方法可以设置浏览器的 User-Agen

function main(splash, args)splash:set_user_agent("Splash")splash:go("http://httpbin.org/get")return splash:html()
end

结果：

6.4 set_custom_headers() 设置请求头

此方法可以设置请求头

function main(splash, args)splash:set_custom_headers({["User-Agent"] = "Splash",["Site"] = "Splash"})splash:go("http://httpbin.org/get")return splash:html()
end

结果：

6.5 select()

该方法可以选中符合条件中的第一个节点，如果多个节点符合条件，则只会返回一个，其参数事CSS选择器

function main(splash, args)splash:go("https://www.baidu.com")input = splash:select("#kw")input:send_text("Splash")splash:wait(3)return splash:png()
end

结果

6.6 select_all() 选中所有符合条件的节点

此方法可以选中所有符合条件的节点，其参数是 ss 选择器

function main(splash, args)local treat = require("treat")assert(splash:go("http://quotes.toscrape.com/"))assert(splash:wait(0.5))local texts = splash:select_all(".quote .text")local results = {}for index ,text in ipairs(texts) doresults[index] = text.node.innerHTMLendreturn treat.as_array(results)
end

结果：通过CSS选择器中了节点的正文内容，随后遍历了所有节点

6.7 mouse_click() 鼠标操作

此方法模拟鼠标点击操作，传入参数为坐标值x和y

function main(splash, args)splash:go("https://www.baidu.com/")input = splash:select("#kw")input:send_text("Splash")submit = splash:select("#su")submit:mouse_click()splash:wait(3)return splash:png()
end

结果：

3 Splash API调用

上面讲了脚本是在Splash页面中测试运行的，如果才能利用Splash渲染页面尼？怎样才能和Python程序结合使用并抓取JavaScript渲染的页面尼？

其实Splash给我们提供了一些HTTP API接口，只需要请求这些接口并传递相应的参数即可

3.1 render.html 获取JavaScript渲染的页面的HTML代码

此接口用户获取JavaScript渲染的页面的HTML代码

curl http://192.168.1.105:8050/render.html?url=https://www.baidu.com

使用Python实现的

import requests
url = "http://192.168.1.105:8050/render.html?url=https://www.baidu.com"
response = requests.get(url)
print(response.text)

结果

此外还支持代理设置，图片加载设置，Header设置，请求方法的设置，

比如设置等待时间5秒

import requests
url = "http://192.168.1.105:8050/render.html?url=https://www.baidu.com$wait=5"
response = requests.get(url)
print(response.text)

3.2 render.png 获取网页截图

此接口可以获取网页截图，其参数比render.html 多了几个，比如通过width和heighet来控制宽高，它返回的是PNG格式的图片的二进制数据

curl http://192.168.1.105:8050/render.png?url=https://www.baidu.com$width=1000$height=700

python来实现

import requests
url = "http://192.168.1.105:8050/render.png?url=https://www.baidu.com$width=1000$height=700"
response = requests.get(url)
with open("baidu.png","wb") as fd:fd.write(response.content)

结果：

3.3 render.jepg 获取JPEG格式的图片

此接口和 render.pug 类似，不过它返回的是 JPEG 格式的图片进制数据

此接口比 render.png 多了参数 quality

3.4 render.har

此接口用户获取页面加载的HAR数据

curl http://192.168.1.105:8050/render.har?url=https://www.taobao.com&wait=5

返回的结果JSON的数据

3.5 render.json 此接口包含了前面所有的功能

此接口包含了前面的接口的所有功能，返回结果是json格式

curl http://192.168.1.105:8050/render.json?url=https://httpbin.org

结果：

返回JSON形式的相应的请求数据

可以控制传入不同的参数控制其返回的结果，比如传入html=1，返回结果即会增加源代码数据；传入png=1，返回结果即会增加页面PNG截图数据；出入har=1，则会获得页面HAR数据，

curl http://192.168.1.105:8050/render.json?url=https://httpbin.org&html=1&har=1

3.6 execute 与Lua脚本对接

此接口才是最为强大的接口，此接口便可实现与Lua脚本的对接

render.html 和render.html等接口对于一般的JavaScript渲染页面时足够了，但是如果要实现一些交互操作的话，他们还是无能为力这就是需要execute接口了

先写一个简单的脚本，直接返回数据

function main(splash, args)return "hello"
end

然后将此脚本转化为URL编码后的字符串，拼接到execute接口后面

curl http://192.168.1.105:8050/execute?lua_source=function%20main(splash)%20%20return%20%27hello%27end

结果：这里通过lua_source参数传递了转码后的Lua脚本通过，execute接口获取了最终脚本的执行结果

使用Python来实现

import requests
from urllib.parse import quote
lua = """
function main(splash, args)return "hello"
end
"""
url = "http://192.168.1.105:8050/execute?lua_source=" + quote(lua)
response = requests.get(url)
print(response.text)结果：
hello

再看一个实例

import requests
from urllib.parse import quote
lua = """
function main(splash, args)local treat = require("treat")local response = splash:http_get("http://httpbin.org/get")return {html=treat.as_string(response.body),url=response.url,status=response.status}
end
"""
url = "http://192.168.1.105:8050/execute?lua_source=" + quote(lua)
response = requests.get(url)
print(response.text)结果：
{"status": 200, "html": "{\n  \"args\": {}, \n  \"headers\": {\n    \"Accept-Encoding\": \"gzip, deflate\", \n    \"Accept-Language\": \"en,*\", \n    \"Host\": \"httpbin.org\", \n    \"User-Agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/602.1 (KHTML, like Gecko) splash Version/10.0 Safari/602.1\", \n    \"X-Amzn-Trace-Id\": \"Root=1-61e03e06-3d7a34373e6b9d8f782a2d98\"\n  }, \n  \"origin\": \"123.112.23.99\", \n  \"url\": \"http://httpbin.org/get\"\n}\n", "url": "http://httpbin.org/get"}

这样我们就可以把Lua脚本均可以用此方式与Python进行对接