赵走x博客 - 开发者的网上家园

Python3网络爬虫实战：38、动态渲染页面抓取:Splash的使用

资源编号:75814 Python3网络爬虫实战爬虫热度：35

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

Splash 是一个 JavaScript 渲染服务，是一个带有 HTTP API 的轻量级浏览器，同时它对接了 Python 中的 Twisted和 QT 库，利用它我们同样可以实现动态渲染页面的抓取。
# 1. 功能介绍
利用 Splash 我们可以实现如下功能：
* 异步方式处理多个网页渲染过程
* 获取渲染后的页面的源代码或截图
* 通过关闭图片渲染或者使用 Adblock 规则来加快页面渲染速度
* 可执行特定的 JavaScript 脚本
* 可通过 Lua 脚本来控制页面渲染过程获取渲染的详细过程并通过 HAR（HTTP Archive）格式呈现

接下来我们来了解一下它的具体用法。
# 2. 准备工作
在本节开始之前请确保已经正确安装好了 Splash 并可以正常运行服务，如没有安装可以参考第一章的安装说明。
# 3. 实例引入
首先我们可以通过 Splash 提供的 Web 页面来测试 Splash的渲染过程，例如我们在本机 8050 端口运行了 Splash 服务:
```
docker  run  -p  8050:8050  scrapinghub/splash
```
打开：http://localhost:8050/ 即可看到其 Web 页面，如图 7-6 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-0ba0fa7a.png)
图 7-6 Web 页面
在右侧呈现的是一个渲染示例，我们可以看到在上方有一个输入框，默认是：http://google.com ，我们在这里换成百度测试一下，将内容更改为：https://www.baidu.com ，然后点击按钮，开始渲染，结果如图 7-7 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-3075621c.png)

图 7-7 运行结果
可以看到网页的返回结果呈现了渲染截图、HAR 加载统计数据、网页的源代码。
通过 HAR 的结果我们可以看到 Splash 执行了整个网页的渲染过程，包括 CSS、JavaScript 的加载等过程，呈现的页面和我们在浏览器得到的结果完全一致。
那么这个过程是由什么来控制的呢？我们重新返回首页可以看到实际上是有一段脚本，内容如下：
```
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
```
这个脚本是实际是 Lua 语言写的脚本，Lua也是一门编程语言，简洁易用。
即使我们不懂这个语言的语法，但通过脚本表面意思我们也可以大致了解到它是首先调用 go() 方法去加载页面，然后调用 wait() 方法等待了一定的时间，最后返回了页面的源码、截图和 HAR 信息。
所以到这里我们可以大体了解到 Splash 是通过 Lua 脚本来控制了页面的加载过程，加载过程完全模拟浏览器，最后可返回各种格式的结果，如网页源码、截图等。
所以接下来我们要学会用 Splash 的话，一是需要了解其中 Lua 脚本的写法，二是需要了解相关 API 的用法，那么接下来我们就来了解一下这两部分内容。
# 4. Splash Lua脚本
Splash可以通过Lua脚本执行一系列渲染操作，这样我们就可以用Splash来模拟类似Chrome、PhantomJS的操作了。
首先我们先对 Splash Lua 脚本的用法有一个基本的认识，先了解一下它的入口和执行方式。
### 入口及返回值
首先我们来看一个基本实例：
```
function main(splash, args)
  splash:go("http://www.baidu.com")
  splash:wait(0.5)
  local title = splash:evaljs("document.title")
  return {title=title}
end
```
我们将代码粘贴到刚才我们所打开的：http://localhost:8050/ 的代码编辑区域，然后点击按钮来测试一下。
这样我们就会看到其返回了网页的标题，这里我们是通过 evaljs() 方法传入 JavaScript 脚本，而 document.title 的执行结果就是返回网页标题，执行完毕后赋值给一个 title 变量，随后将其返回，这样就可以看到其返回结果就是网页标题了，如图 7-8 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-3e86c12e.png)

图 7-8 运行结果
注意到我们在这里定义的方法名称叫做 main()，这个名称必须是固定的，Splash 会默认调用这个方法。
方法的返回值可以是字典形式、也可以是字符串形式，最后都会转化为一个 Splash HTTP Response，例如：
```
function main(splash)
    return {hello="world!"}
end
```
这样即返回了一个字典形式的内容。
```
function main(splash)
    return 'hello'
end
```
这样即返回了一个字符串形式的内容，同样是可以的。
### 异步处理
Splash是支持异步处理的，但是这里我们并没有显式地指明回调方法，其回调的跳转是在Splash内部完成的，我们先来看一个例子：
```
function main(splash, args)
  local example_urls = {"www.baidu.com", "www.taobao.com", "www.zhihu.com"}
  local urls = args.urls or example_urls
  local results = {}
  for index, url in ipairs(urls) do
    local ok, reason = splash:go("http://" .. url)
    if ok then
      splash:wait(2)
      results[url] = splash:png()
    end
  end
  return results
end
```
运行后的返回结果是三个站点的截图，如图 7-9 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-2247313d.png)

图 7-9 运行结果
在脚本内调用了 wait() 方法，这类似于 Python 中的 sleep()，参数为等待的秒数，当 Splash 执行到此方法时，它会转而去处理其他的任务，然后在指定的时间过后再回来继续处理。
在这里值得注意的是 Lua 脚本中的字符串拼接，和 Python不同，这里的字符串拼接使用的是 .. 操作符，而不是 +，如有必要可以简单了解一下Lua脚本的语法，链接：http://www.runoob.com/lua/lua-basic-syntax.html。
另外这里我们做了加载时的异常检测，go() 方法会返回加载页面的结果状态，如果页面出现 4XX 或 5XX 状态码，ok 变量就会为空，就不会返回加载后的图片。
# 5. Splash对象属性
我们注意到在前面的例子中 main() 方法的第一个参数是 splash，这个对象非常重要，类似于在 Selenium 中的WebDriver 对象：
```
from selenium import webdriver
browser = webdriver.Chrome()
```
如上所示，现在的 splash 对象就如同此处 Selenium 中的 browser 对象，我们可以调用它的一些属性和方法来控制加载过程，接下来我们首先看下它的属性。
### args
splash 对象的 args 属性可以获取加载时配置的参数，它可以获取加载的 URL，如果为 GET 请求它还可以获取 GET 请求参数，如果为 POST 请求它可以获取表单提交的数据。Splash 支持第二个参数直接作为 args，例如：
```
function main(splash, args)
    local url = args.url
end
```
在这里第二个参数 args 就相当于 splash.args 属性，以上代码等价于：
```
function main(splash)
    local url = splash.args.url
end
```
### js_enabled
这个属性是 Splash 的 JavaScript 执行开关，我们可以将其配置为 True 或 False 来控制是否可以执行 JavaScript 代码，默认为 True，例如我们在这里禁用一下 JavaScript 的执行：
```
function main(splash, args)
  splash:go("https://www.baidu.com")
  splash.js_enabled = false
  local title = splash:evaljs("document.title")
  return {title=title}
end
```
禁用之后，我们重新调用了 evaljs() 方法执行 JavaScript 代码，那么运行结果就会抛出异常：
```
{
    "error": 400,
    "type": "ScriptError",
    "info": {
        "type": "JS_ERROR",
        "js_error_message": null,
        "source": "[string \"function main(splash, args)\r...\"]",
        "message": "[string \"function main(splash, args)\r...\"]:4: unknown JS error: None",
        "line_number": 4,
        "error": "unknown JS error: None",
        "splash_method": "evaljs"
    },
    "description": "Error happened while executing Lua script"
}
```
不过一般来说我们不用设置此属性开关，默认开启即可。
### resource_timeout
此属性可以设置加载的超时时间，单位是秒，如果设置为 0或 nil（类似 Python 中的 None）就代表不检测超时，我们用一个实例感受一下：
```
function main(splash)
    splash.resource_timeout = 0.1
    assert(splash:go('https://www.taobao.com'))
    return splash:png()
end
```
例如这里我们将超时时间设置为 0.1 秒，如果在 0.1 秒之内没有得到响应就会抛出异常，错误如下：
```
{
    "error": 400,
    "type": "ScriptError",
    "info": {
        "error": "network5",
        "type": "LUA_ERROR",
        "line_number": 3,
        "source": "[string \"function main(splash)\r...\"]",
        "message": "Lua error: [string \"function main(splash)\r...\"]:3: network5"
    },
    "description": "Error happened while executing Lua script"
}
```
此属性适合在网页加载速度较慢的情况下设置，如果超过了某个时间无响应则直接抛出异常并忽略即可。
### images_enabled
此属性可以设置图片是否加载，默认情况下是加载的，但是禁用之后可以节省网络流量并提高网页加载速度，但是值得注意的是禁用图片加载之后可能会影响 JavaScript 渲染，因为禁用图片之后它的外层 DOM 节点的高度会受影响，进而影响 DOM 节点的位置，所以如果 JavaScript 如果使用了相关变量的话，其执行就会受到影响，不过一般情况下不会。
另外值得注意的是 Splash 使用了缓存，所以如果你一开始加载出来了网页图片，然后禁用了图片加载，然后再重新加载页面，之前加载好的图片可能还会显示出来，这时可以重启一下 Splash 即可解决。
禁用图片加载的示例如下：
```
function main(splash, args)
  splash.images_enabled = false
  assert(splash:go('https://www.jd.com'))
  return {png=splash:png()}
end
```
这样返回的页面截图就不会带有任何图片，加载速度也会快很多。
### plugins_enabled
此属性可以控制浏览器插件是否开启，如 Flash 插件。默认此属性是 False 不开启，可以使用如下代码控制其开启和关闭：
```
splash.plugins_enabled = true/false
```
### scroll_position
此属性可以控制页面的滚动偏移，通过设置此属性我们可以控制页面上下或左右滚动，还是比较常用的一个属性，我们用一个实例感受一下：
```
function main(splash, args)
  assert(splash:go('https://www.taobao.com'))
  splash.scroll_position = {y=400}
  return {png=splash:png()}
end
```
这样我们就可以控制页面向下滚动 400 像素值，结果如图 7-10 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-f3403344.png)

图 7-10 运行结果
如果要控制左右滚动可以传入 x 参数，代码如下：
```
splash.scroll_position = {x=100, y=200}
```
# 6. Splash对象方法
### go()
go() 方法就是用来请求某个链接的方法，而且它可以模拟 GET 和 POST 请求，同时支持传入 Headers、Form Data 等数据，用法如下：
```
ok, reason = splash:go{url, baseurl=nil, headers=nil, http_method="GET", body=nil, formdata=nil}
```
参数说明如下：
* url，即请求的URL。
* baseurl，可选参数，默认为空，资源加载相对路径。
* headers，可选参数，默认为空，请求的 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{"http://httpbin.org/post", http_method="POST", body="name=Germey"}
  if ok then
        return splash:html()
  end
end
```
在这里我们模拟了一个 POST 请求，并传入了 POST 的表单数据，如果成功，则返回页面源代码。
运行结果如下：
```
<html><head></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">{
  "args": {}, 
  "data": "", 
  "files": {}, 
  "form": {
    "name": "Germey"
  }, 
  "headers": {
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", 
    "Accept-Encoding": "gzip, deflate", 
    "Accept-Language": "en,*", 
    "Connection": "close", 
    "Content-Length": "11", 
    "Content-Type": "application/x-www-form-urlencoded", 
    "Host": "httpbin.org", 
    "Origin": "null", 
    "User-Agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/602.1 (KHTML, like Gecko) splash Version/9.0 Safari/602.1"
  }, 
  "json": null, 
  "origin": "60.207.237.85", 
  "url": "http://httpbin.org/post"
}
</pre></body></html>
```
通过结果可以看到我们成功实现了 POST 请求并发送了表单数据。
### 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)
    splash:go("https://www.taobao.com")
    splash:wait(2)
    return {html=splash:html()}
end
```
如上代码可以实现访问淘宝并等待 2 秒，随后返回页面源代码的功能。
### jsfunc()
此方法可以直接调用 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
```
运行结果：
```
There are 21 DIVs
```
首选我们声明了一个方法，然后在页面加载成功后调用了此方法计算出了页面中的 div 节点的个数。
但这只是 Splash 提供的 Web 页面功能，更多的功能我们可以使用它提供的 HTTP API 来完成 JavaScript 渲染过程。
关于更多 JavaScript 到 Lua 脚本的转换细节可以参考官方文档介绍：https://splash.readthedocs.io/en/stable/scripting-ref.html#splash-jsfunc。
### evaljs()
此方法可以执行 JavaScript 代码并返回最后一条语句的返回结果，使用方法如下：
```
result = splash:evaljs(js)
```
比如我们可以用下面的代码来获取页面的标题：
```
local title = splash:evaljs("document.title")
runjs()
```
此方法可以执行 JavaScript 代码，和 evaljs() 功能类似，但是此方法更偏向于执行某些动作或声明某些方法，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
```
在这里我们用 runjs() 先声明了一个 JavaScript 定义的方法，然后通过 evaljs() 来调用得到结果。
运行结果如下：
```
bar
```
### 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.baidu.com")
  return splash:evaljs("get_document_title()")
end
```
在这里我们调用 autoload() 声明了一个 JavaScript 方法，然后通过 evaljs() 调用了此方法执行。
运行结果：
```
百度一下，你就知道
```
另外我们也可以加载某些方法库，如 jQuery，示例如下：
```
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
```
运行结果：
```
JQuery version: 2.1.3
```
### 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.taobao.com")
  splash:wait(3.0)
  return snapshots
end
```
在这里我们设置了一个定时任务，0.2 秒的时候获取网页截图，然后等待 1 秒，1.2 秒时再次获取网页截图，访问的页面是淘宝，最后将截图结果返回。
运行结果如图 7-11 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-18939813.png)

图 7-11 运行结果
我们可以发现第一次截图网页还没有加载出来，截图为空，第二次网页便加载成功了。
### http_get()
此方法可以模拟发送 HTTP 的 GET 请求，使用方法如下：
```
response = splash:http_get{url, headers=nil, follow_redirects=true}
```
参数说明如下：
* url，请求URL。
* headers，可选参数，默认为空，请求的 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
```
运行结果：
```
Splash Response: Object
html: String (length 355)
{
  "args": {}, 
  "headers": {
    "Accept-Encoding": "gzip, deflate", 
    "Accept-Language": "en,*", 
    "Connection": "close", 
    "Host": "httpbin.org", 
    "User-Agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/602.1 (KHTML, like Gecko) splash Version/9.0 Safari/602.1"
  }, 
  "origin": "60.207.237.85", 
  "url": "http://httpbin.org/get"
}
status: 200
url: "http://httpbin.org/get"
```
### http_post()
和 http_get() 方法类似，此方法是模拟发送一个 POST 请求，不过多了一个参数 body，使用方法如下：
```
response = splash:http_post{url, headers=nil, follow_redirects=true, body=nil}
```
参数说明如下：
* url，请求URL。
* headers，可选参数，默认为空，请求的 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
```
运行结果：
```
Splash Response: Object
html: String (length 533)
{
  "args": {}, 
  "data": "{\"name\": \"Germey\"}", 
  "files": {}, 
  "form": {}, 
  "headers": {
    "Accept-Encoding": "gzip, deflate", 
    "Accept-Language": "en,*", 
    "Connection": "close", 
    "Content-Length": "18", 
    "Content-Type": "application/json", 
    "Host": "httpbin.org", 
    "User-Agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/602.1 (KHTML, like Gecko) splash Version/9.0 Safari/602.1"
  }, 
  "json": {
    "name": "Germey"
  }, 
  "origin": "60.207.237.85", 
  "url": "http://httpbin.org/post"
}
status: 200
url: "http://httpbin.org/post"
```
可以看到在这里我们成功模拟提交了 POST 请求并发送了表单数据。
### set_content()
此方法可以用来设置页面的内容，示例如下：
```
function main(splash)
    assert(splash:set_content("<html><body><h1>hello</h1></body></html>"))
    return splash:png()
end
```
运行结果如图 7-12 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-dcf2571f.png)

图 7-12 运行结果
### html()
此方法可以用来获取网页的源代码，非常简单又常用的方法，示例如下：
```
function main(splash, args)
  splash:go("https://httpbin.org/get")
  return splash:html()
end
```
运行结果：
```
<html><head></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">{
  "args": {}, 
  "headers": {
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", 
    "Accept-Encoding": "gzip, deflate", 
    "Accept-Language": "en,*", 
    "Connection": "close", 
    "Host": "httpbin.org", 
    "User-Agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/602.1 (KHTML, like Gecko) splash Version/9.0 Safari/602.1"
  }, 
  "origin": "60.207.237.85", 
  "url": "https://httpbin.org/get"
}
</pre></body></html>
```
### png()
此方法可以用来获取 PNG 格式的网页截图，示例如下：
```
function main(splash, args)
  splash:go("https://www.taobao.com")
  return splash:png()
end
```
### jpeg()
此方法可以用来获取 JPEG 格式的网页截图，示例如下：
```
function main(splash, args)
  splash:go("https://www.taobao.com")
  return splash:jpeg()
end
```
### har()

此方法可以用来获取页面加载过程描述，示例如下：
```
function main(splash, args)
  splash:go("https://www.baidu.com")
  return splash:har()
end
```
运行结果如图 7-13 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-10191e47.png)

图 7-13 运行结果
在这里显示了页面加载过程中的每个请求记录详情。
### url()
此方法可以获取当前正在访问的 URL，示例如下：
```
function main(splash, args)
  splash:go("https://www.baidu.com")
  return splash:url()
end
```
运行结果如下：
```
https://www.baidu.com/
```
### get_cookies()
此方法可以获取当前页面的 Cookies，示例如下：
```
function main(splash, args)
  splash:go("https://www.baidu.com")
  return splash:get_cookies()
end
```
运行结果如下：
```
Splash Response: Array[2]
0: Object
domain: ".baidu.com"
expires: "2085-08-21T20:13:23Z"
httpOnly: false
name: "BAIDUID"
path: "/"
secure: false
value: "C1263A470B02DEF45593B062451C9722:FG=1"
1: Object
domain: ".baidu.com"
expires: "2085-08-21T20:13:23Z"
httpOnly: false
name: "BIDUPSID"
path: "/"
secure: false
value: "C1263A470B02DEF45593B062451C9722"
```
### add_cookie()
此方法可以为当前页面添加 Cookie，用法如下：
```
cookies = splash:add_cookie{name, value, path=nil, domain=nil, expires=nil, httpOnly=nil, secure=nil}
```
方法的各个参数代表了 Cookie 的各个属性。
示例如下：
```
function main(splash)
    splash:add_cookie{"sessionid", "237465ghgfsd", "/", domain="http://example.com"}
    splash:go("http://example.com/")
    return splash:html()
end
clear_cookies()
```
此方法可以清除所有的 Cookies，示例如下：
```
function main(splash)
    splash:go("https://www.baidu.com/")
    splash:clear_cookies()
    return splash:get_cookies()
end
```
在这里我们清除了所有的 Cookies，然后再调用 get_cookies() 并将结果返回。
运行结果：
```
Splash Response: Array[0]
```
可以看到Cookies被全部清空，没有任何结果。
### get_viewport_size()
此方法可以获取当前浏览器页面的大小，即宽高，示例如下：
```
function main(splash)
    splash:go("https://www.baidu.com/")
    return splash:get_viewport_size()
end
```
运行结果：
```
Splash Response: Array[2]
0: 1024
1: 768
```
### set_viewport_size()
此方法可以设置当前浏览器页面的大小，即宽高，用法如下：
```
splash:set_viewport_size(width, height)
```
例如这里我们访问一个宽度自适应的页面，示例如下：
```
function main(splash)
    splash:set_viewport_size(400, 700)
    assert(splash:go("http://cuiqingcai.com"))
    return splash:png()
end
```
运行结果如图 7-14 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-3f638f38.png)

图 7-14 运行结果
### set_viewport_full()
此方法可以设置浏览器全屏显示，示例如下：
```
function main(splash)
    splash:set_viewport_full()
    assert(splash:go("http://cuiqingcai.com"))
    return splash:png()
end
```
### set_user_agent()
此方法可以设置浏览器的 User-Agent，示例如下：
```
function main(splash)
  splash:set_user_agent('Splash')
  splash:go("http://httpbin.org/get")
  return splash:html()
end
```
在这里我们将浏览器的 User-Agent 设置为 Splash，运行结果如下：
```
<html><head></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">{
  "args": {}, 
  "headers": {
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", 
    "Accept-Encoding": "gzip, deflate", 
    "Accept-Language": "en,*", 
    "Connection": "close", 
    "Host": "httpbin.org", 
    "User-Agent": "Splash"
  }, 
  "origin": "60.207.237.85", 
  "url": "http://httpbin.org/get"
}
</pre></body></html>
```
可以看到此处 User-Agent 被成功设置。
### set_custom_headers()
此方法可以设置请求的 Headers，示例如下：
```
function main(splash)
  splash:set_custom_headers({
     ["User-Agent"] = "Splash",
     ["Site"] = "Splash",
  })
  splash:go("http://httpbin.org/get")
  return splash:html()
end
```
在这里我们设置了 Headers 中的 User-Agent 和 Site 属性，运行结果：
```
<html><head></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">{
  "args": {}, 
  "headers": {
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", 
    "Accept-Encoding": "gzip, deflate", 
    "Accept-Language": "en,*", 
    "Connection": "close", 
    "Host": "httpbin.org", 
    "Site": "Splash", 
    "User-Agent": "Splash"
  }, 
  "origin": "60.207.237.85", 
  "url": "http://httpbin.org/get"
}
</pre></body></html>
```
可以看到结果的 Headers 中两个字段被成功设置。
### select()
select() 方法可以选中符合条件的第一个节点，如果有多个节点符合条件，则只会返回一个，其参数是 CSS 选择器，示例如下：
```
function main(splash)
  splash:go("https://www.baidu.com/")
  input = splash:select("#kw")
  input:send_text('Splash')
  splash:wait(3)
  return splash:png()
end
```
在这里我们首先访问了百度，然后选中了搜索框，随后调用了 send_text() 方法填写了文本，然后返回网页截图。
结果如图 7-15 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-4f629d44.png)

图 7-15 运行结果
可以看到我们成功填写了输入框。
### select_all()
此方法可以选中所有的符合条件的节点，其参数是 CSS 选择器。示例如下
```
function main(splash)
  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) do
    results[index] = text.node.innerHTML
  end
  return treat.as_array(results)
end
```
在这里我们通过 CSS 选择器选中了节点的正文内容，随后遍历了所有节点，然后将其中的文本获取了下来。
运行结果：
```
Splash Response: Array[10]
0: "“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.”"
1: "“It is our choices, Harry, that show what we truly are, far more than our abilities.”"
2: “There are only two ways to live your life. One is as though nothing is a miracle. The other is as though everything is a miracle.”
3: "“The person, be it gentleman or lady, who has not pleasure in a good novel, must be intolerably stupid.”"
4: "“Imperfection is beauty, madness is genius and it's better to be absolutely ridiculous than absolutely boring.”"
5: "“Try not to become a man of success. Rather become a man of value.”"
6: "“It is better to be hated for what you are than to be loved for what you are not.”"
7: "“I have not failed. I've just found 10,000 ways that won't work.”"
8: "“A woman is like a tea bag; you never know how strong it is until it's in hot water.”"
9: "“A day without sunshine is like, you know, night.”"
```
可以发现我们成功将 10 个节点的正文内容获取了下来。
### mouse_click()
此方法可以模拟鼠标点击操作，传入的参数为坐标值 x、y，也可以直接选中某个节点直接调用此方法，示例如下：
```
function main(splash)
  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
```
在这里我们首先选中了页面的输入框，输入了文本，然后选中了提交按钮，调用了 mouse_click() 方法提交查询，然后页面等待三秒，返回截图，结果如图 7-16 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-038add95.png)

图 7-16 运行结果
可以看到在这里我们成功获取了查询后的页面内容，模拟了百度搜索操作。
以上我们介绍了 Splash 的常用 API 操作，还有一些 API 在这不再一一介绍，更加详细和权威的说明可以参见官方文档：https://splash.readthedocs.io/en/stable/scripting-ref.html ，此页面介绍了 splash 对象的所有 API 操作，另外还有针对于页面元素的 API 操作，链接为：https://splash.readthedocs.io/en/stable/scripting-element-object.html 。
# 7. Splash API调用
在上文中我们说明了 Splash Lua 脚本的用法，但这些脚本是在 Splash 页面里面测试运行的，我们如何才能利用Splash 来渲染页面呢？怎样才能和 Python 程序结合使用并抓取 JavaScript 渲染的页面呢？
其实 Splash 给我们提供了一些 HTTP API 接口，我们只需要请求这些接口并传递相应的参数即可获取页面渲染后的结果，下面我们对这些接口进行介绍：
### render.html
此接口用于获取 JavaScript 渲染的页面的 HTML 代码，接口地址就是 Splash 的运行地址加此接口名称，例如：http://localhost:8050/render.html ，我们可以用 curl 来测试一下：
```
curl http://localhost:8050/render.html?url=https://www.baidu.com
```
我们给此接口传递了一个 url 参数指定渲染的 URL，返回结果即页面渲染后的源代码。
如果用 Python 实现的话，代码如下：
```
import requests
url = 'http://localhost:8050/render.html?url=https://www.baidu.com'
response = requests.get(url)
print(response.text)
```
这样我们就可以成功输出百度页面渲染后的源代码了。
另外此接口还可以指定其他参数，如 wait 指定等待秒数，如果我们要确保页面完全加载出来可以增加等待时间，例如：
```
import requests
url = 'http://localhost:8050/render.html?url=https://www.taobao.com&wait=5'
response = requests.get(url)
print(response.text)
```
如果增加了此等待时间后，得到响应的时间就会相应变长，如在这里我们会等待大约 5 秒多钟即可获取 JavaScript 渲染后的淘宝页面源代码。
另外此接口还支持代理设置、图片加载设置、Headers设置、请求方法设置，具体的用法可以参见官方文档：https://splash.readthedocs.io/en/stable/api.html#render-html 。
### render.png
此接口可以获取网页截图，参数相比 render.html 又多了几个，如 width、height 来控制宽高，返回的是 PNG 格式的图片二进制数据。
示例如下：
```
curl http://localhost:8050/render.png?url=https://www.taobao.com&wait=5&width=1000&height=700
```
在这里我们还传入了 width 和 height 来放缩页面大小为 1000x700 像素。
如果用 Python 实现，我们可以将返回的二进制数据保存为PNG 格式的图片，实现如下：
```
import requests

url = 'http://localhost:8050/render.png?url=https://www.jd.com&wait=5&width=1000&height=700'
response = requests.get(url)
with open('taobao.png', 'wb') as f:
    f.write(response.content)
```
得到的图片如图 7-17 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-5e860bad.png)

图 7-17 运行结果
这样我们就成功获取了京东首页渲染完成后的页面截图，详细的参数设置可以参考官网文档：https://splash.readthedocs.io/en/stable/api.html#render-png。
### render.jpeg
此接口和 render.png 类似，不过它返回的是 JPEG 格式的图片二进制数据。
另外此接口相比 render.png 还多了一个参数 quality，可以用来设置图片质量。
### render.har
此接口用于获取页面加载的 HAR 数据，示例如下：
```
curl http://localhost:8050/render.har?url=https://www.jd.com&wait=5
```
返回结果非常多，是一个 Json 格式的数据，里面包含了页面加载过程中的 HAR 数据。
结果如图 7-18 所示：
![image.png](https://img.hacpai.com/file/2019/09/image-fd52cefa.png)

图 7-18 运行结果
### render.json
此接口包含了前面接口的所有功能，返回结果是 Json 格式，示例如下：
```
curl http://localhost:8050/render.json?url=https://httpbin.org
```
结果如下：
```
{"title": "httpbin(1): HTTP Client Testing Service", "url": "https://httpbin.org/", "requestedUrl": "https://httpbin.org/", "geometry": [0, 0, 1024, 768]}
```
可以看到这里以 Json 形式返回了相应的请求数据。
我们可以通过传入不同的参数控制其返回的结果，如传入html=1，返回结果即会增加源代码数据，传入 png=1，返回结果机会增加页面 PNG 截图数据，传入har=1则会获得页面 HAR 数据，例如：
```
curl http://localhost:8050/render.json?url=https://httpbin.org&html=1&har=1
```
这样返回的 Json 结果便会包含网页源代码和 HAR 数据。
还有更多参数设置可以参考官方文档：https://splash.readthedocs.io/en/stable/api.html#render-json。
### execute
此接口才是最为强大的接口，我们在前面说了很多 Splash Lua 脚本的操作，用此接口便可以实现和 Lua 脚本的对接。
前面的 render.html、render.png 等接口对于一般的 JavaScript 渲染页面是足够了，但是如果要实现一些交互操作的话还是无能为力的，所以这里就需要使用此 execute 接口来对接 Lua 脚本和网页进行交互了。
我们先实现一个最简单的脚本，直接返回数据：
```
function main(splash)
    return 'hello'
end
```
然后将此脚本转化为 URL 编码后的字符串，拼接到 execute 接口后面，示例如下：
```
curl http://localhost:8050/execute?lua_source=function+main%28splash%29%0D%0A++return+%27hello%27%0D%0Aend
```
运行结果：
```
hello
```
在这里我们通过 lua_source 参数传递了转码后的 Lua 脚本，通过 execute 接口获取了最终脚本的执行结果。
那么在这里我们更加关心的肯定是如何用 Python 来实现，上例用 Python 实现如下：
```
import requests
from urllib.parse import quote

lua = '''
function main(splash)
    return 'hello'
end
'''

url = 'http://localhost:8050/execute?lua_source=' + quote(lua)
response = requests.get(url)
print(response.text)
```
运行结果：
```
hello
```
在这里我们用 Python 中的三引号来将 Lua 脚本包括起来，然后用 urllib.parse 模块里的 quote()方法将脚本进行 URL 转码，随后构造了 Splash 请求 URL，将其作为 lua_source 参数传递，这样运行结果就会显示 Lua 脚本执行后的结果。
我们再来一个实例看一下：
```
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://localhost:8050/execute?lua_source=' + quote(lua)
response = requests.get(url)
print(response.text)
```
运行结果：
```
{"url": "http://httpbin.org/get", "status": 200, "html": "{\n  \"args\": {}, \n  \"headers\": {\n    \"Accept-Encoding\": \"gzip, deflate\", \n    \"Accept-Language\": \"en,*\", \n    \"Connection\": \"close\", \n    \"Host\": \"httpbin.org\", \n    \"User-Agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/602.1 (KHTML, like Gecko) splash Version/9.0 Safari/602.1\"\n  }, \n  \"origin\": \"60.207.237.85\", \n  \"url\": \"http://httpbin.org/get\"\n}\n"}
```
返回结果是 Json 形式，我们成功获取了请求的 URL、状态码和网页源代码。
如此一来，我们之前所说的 Lua 脚本均可以用此方式与 Python 进行对接，这样的话，所有网页的动态渲染、模拟点击、表单提交、页面滑动、延时等待后的一些结果均可以自由控制，获取页面源码和截图都不在话下。

# 8、Splash负载均衡配置

如果我们用 Splash 来做 JavaScript 动态渲染的页面的抓取的话，如果爬取的量非常大，任务非常多，如果我们用一个 Splash 服务来处理的话未免压力太大了，所以我们可以考虑搭建一个负载均衡器来把压力分散到各个服务器上，这样相当于多台机器多个服务共同参与任务的处理，可以减小单个 Splash 服务的压力。
### 1. 配置Splash服务

要搭建 Splash 负载均衡首先我们需要有多个 Splash 服务，假如在这里我在四台远程主机的 8050 端口上都开启了 Splash 服务，它们的服务地址分别为：41.159.27.223:8050、41.159.27.221:8050、41.159.27.9:8050、41.159.117.119:8050，四个服务完全一致，都是通过 Docker 的 Splash 镜像开启的，访问任何一个服务都可以使用 Splash 服务。
### 2. 配置负载均衡

接下来我们可以选用任意一台带有公网 IP 的主机来配置负载均衡，首先需要在这台主机上装好 Nginx，然后修改 Nginx 的配置文件 nginx.conf，添加如下内容：
```
http {
    upstream splash {
        least_conn;
        server 41.159.27.223:8050;
        server 41.159.27.221:8050;
        server 41.159.27.9:8050;
        server 41.159.117.119:8050;
    }
    server {
        listen 8050;
        location / {
            proxy_pass http://splash;
        }
    }
}
```
这样我们通过 upstream 字段定义了一个名字叫做 splash 的服务集群配置，least_conn 代表最少链接负载均衡，它适合处理请求处理时间长短不一造成服务器过载的情况。

或者我们也可以不指定配置，配置如下：
```
upstream splash {
    server 41.159.27.223:8050;
    server 41.159.27.221:8050;
    server 41.159.27.9:8050;
    server 41.159.117.119:8050;
}
```

这样默认以轮询策略实现负载均衡，每个服务器的压力相同，此策略适合服务器配置相当，无状态且短平快的服务使用。

另外我们还可以指定权重，配置如下：
```
upstream splash {
    server 41.159.27.223:8050 weight=4;
    server 41.159.27.221:8050 weight=2;
    server 41.159.27.9:8050 weight=2;
    server 41.159.117.119:8050 weight=1;
}
```
我们通过 weight 指定了各个服务的权重，权重越高分配到处理的请求越多，假如不同的服务器配置差别比较大的话，就可以使用此种配置。

最后还有一种 IP 哈希负载均衡，配置如下：
```
upstream splash {
    ip_hash;
    server 41.159.27.223:8050;
    server 41.159.27.221:8050;
    server 41.159.27.9:8050;
    server 41.159.117.119:8050;
}
```
服务器根据请求客户端的 IP 地址进行哈希计算，确保使用同一个服务器响应请求，这种策略适合有状态的服务，如用户登录后访问某个页面的情形。不过对于 Splash 来说不需要。

我们可以根据不同的情形选用不同的配置，配置完成后重启一下 Nginx 服务：
```
sudo nginx -s reload
```
这样直接访问 Nginx 所在服务器的 8050 端口即可实现负载均衡了。
### 3. 配置认证

现在 Splash 是公开访问的，如果我们不想让其被公开访问还可以配置认证，仍然借助于 Nginx 即可，可以在 server 的 location 字段中添加一个 auth_basic 和 auth_basic_user_file 字段，配置如下：
```
http {
    upstream splash {
        least_conn;
        server 41.159.27.223:8050;
        server 41.159.27.221:8050;
        server 41.159.27.9:8050;
        server 41.159.117.119:8050;
    }
    server {
        listen 8050;
        location / {
            proxy_pass http://splash;
            auth_basic "Restricted";
            auth_basic_user_file /etc/nginx/conf.d/.htpasswd;
        }
    }
}
```
在这里使用的用户名密码配置放置在 /etc/nginx/conf.d 目录，我们需要使用 htpasswd 命令创建，例如创建一个用户名为 admin 的文件，命令如下：
```
htpasswd -c .htpasswd admin
```
接下就会提示我们输入密码，输入两次之后，就会生成密码文件，查看一下内容：
```
cat .htpasswd 
admin:5ZBxQr0rCqwbc
```
配置完成之后我们重启一下 Nginx 服务，运行如下命令：
```
sudo nginx -s reload
```
这样访问认证就成功配置好了。
### 4. 测试

最后我们可以用代码来测试一下负载均衡的配置，看看到底是不是每次请求会切换IP，利用 http://httpbin.org/get 测试即可，代码实现如下：
```
import requests
from urllib.parse import quote
import re

lua = '''
function main(splash, args)
  local treat = require("treat")
  local response = splash:http_get("http://httpbin.org/get")
  return treat.as_string(response.body)
end
'''

url = 'http://splash:8050/execute?lua_source=' + quote(lua)
response = requests.get(url, auth=('admin', 'admin'))
ip = re.search('(\d+\.\d+\.\d+\.\d+)', response.text).group(1)
print(ip)
```
这里的 URL 中的 splash 请自行替换成自己的 Nginx 服务器 IP，在这里我修改了 Hosts 添加了 splash 别名。

多次运行代码之后可以发现每次请求的 IP 都会变化：

如第一次的结果：
```
41.159.27.223
```
第二次的结果：
```
41.159.27.9
```
这就说明负载均衡已经成功实现了。

# 9. 结语
到现在为止，我们就可以用 Python 和 Splash 实现JavaScript 渲染的页面的抓取了，除了 Selenium，本节所说的 Splash 同样可以做到非常强大的渲染功能，同时它也不需要浏览器即可渲染，使用非常方便。

本节我们还成功实现了负载均衡的配置，配置了负载均衡之后可以多个 Splash 服务共同合作，减轻单个服务的负载，还是比较有用的。