要点
Chrome 59 中随附了无头 Chrome。它是一种在无头环境中运行 Chrome 浏览器的方法。 从本质上说 可以在没有 Chrome 的情况下运行 Chrome它会将 Chromium 和 Blink 渲染引擎提供的所有现代网络平台功能引入命令行。
为什么它有用?
对于自动化测试和不需要可见界面 shell 的服务器环境而言,无头浏览器是很好的工具。例如,您可能想要针对实际网页运行一些测试,创建该网页的 PDF 文件或仅检查浏览器如何呈现网址。
启动无头 (CLI)
若要开始使用无头模式,最简单的方法是从命令行打开 Chrome 二进制文件。如果您已安装 Chrome 59 或更高版本,请使用 --headless
标志启动 Chrome:
chrome \
--headless \ # Runs Chrome in headless mode.
--disable-gpu \ # Temporarily needed if running on Windows.
--remote-debugging-port=9222 \
https://www.chromestatus.com # URL to open. Defaults to about:blank.
chrome
应指向您安装的 Chrome。确切位置因平台而异。因为使用的是 Mac
我为安装的每个 Chrome 版本都创建了便捷的别名
如果您使用的是 Chrome 稳定版,并且无法获取 Beta 版,我们建议您使用 chrome-canary
:
alias chrome="/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome"
alias chrome-canary="/Applications/Google\ Chrome\ Canary.app/Contents/MacOS/Google\ Chrome\ Canary"
alias chromium="/Applications/Chromium.app/Contents/MacOS/Chromium"
点击此处下载 Chrome Canary 版。
命令行功能
在某些情况下,您可能不需要通过程序化方式为无头 Chrome 编写脚本。有一些实用的命令行 flag 可用于执行常见任务。
输出 DOM
--dump-dom
标志会将 document.body.innerHTML
输出到 stdout:
chrome --headless --disable-gpu --dump-dom https://www.chromestatus.com/
创建 PDF
--print-to-pdf
标志会创建网页的 PDF 文件:
chrome --headless --disable-gpu --print-to-pdf https://www.chromestatus.com/
截取屏幕截图
如需截取网页的屏幕截图,请使用 --screenshot
标志:
chrome --headless --disable-gpu --screenshot https://www.chromestatus.com/
# Size of a standard letterhead.
chrome --headless --disable-gpu --screenshot --window-size=1280,1696 https://www.chromestatus.com/
# Nexus 5x
chrome --headless --disable-gpu --screenshot --window-size=412,732 https://www.chromestatus.com/
使用 --screenshot
运行会在当前工作目录中生成一个名为 screenshot.png
的文件。如果你想查看整页屏幕截图,就要更加复杂。David Schnurr
写过一篇很棒的博文请查看将无头 Chrome 用作自动屏幕截图工具 。
REPL 模式(读取-评估-输出循环)
--repl
标志以某种模式运行 Headless,您可以在浏览器中直接从命令行对 JS 表达式求值:
$ chrome --headless --disable-gpu --repl --crash-dumps-dir=./tmp https://www.chromestatus.com/
[0608/112805.245285:INFO:headless_shell.cc(278)] Type a Javascript expression to evaluate or "quit" to exit.
>>> location.href
{"result":{"type":"string","value":"https://www.chromestatus.com/features"}}
>>> quit
$
在没有浏览器界面的情况下调试 Chrome?
当您通过 --remote-debugging-port=9222
运行 Chrome 时,它会启动一个启用了 DevTools 协议的实例。该协议用于与 Chrome 通信并驱动无头浏览器实例。它也是 Sublime、VS Code 和 Node 等工具用于远程调试应用的功能。#synergy
由于您没有可查看该页面的浏览器界面,请在另一个浏览器中转到 http://localhost:9222
以检查是否一切正常。您会看到一个可检查页面的列表,您可以在其中点击查看 Headless 页面正在渲染哪些内容:
在这里,您可以使用熟悉的开发者工具功能像往常一样检查、调试和调整页面。如果您以编程方式使用 Headless,此页面也是一个强大的调试工具,用于查看与浏览器通信的所有原始开发者工具协议命令。
以编程方式使用(节点)
木偶操作师
Puppeteer 是由 Chrome 团队开发的 Node 库。它提供了一个用于控制无头(或完整)Chrome 的高级 API。它与 Phantom 和 NightmareJS 等其他自动化测试库类似,但它仅适用于最新版本的 Chrome。
例如,Puppeteer 可用于轻松截取屏幕截图、创建 PDF、浏览页面以及提取页面的相关信息。如果您想快速自动执行浏览器测试,我推荐使用该库它隐藏了开发者工具协议的复杂性,可以处理冗余任务,例如启动 Chrome 的调试实例。
安装:
npm i --save puppeteer
示例 - 输出用户代理
const puppeteer = require('puppeteer');
(async() => {
const browser = await puppeteer.launch();
console.log(await browser.version());
await browser.close();
})();
示例 - 抓取网页的屏幕截图
const puppeteer = require('puppeteer');
(async() => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto('https://www.chromestatus.com', {waitUntil: 'networkidle2'});
await page.pdf({path: 'page.pdf', format: 'A4'});
await browser.close();
})();
如需详细了解完整 API,请参阅 Puppeteer 的文档。
CRI 库
chrome-remote-interface 是一个级别低于 Puppeteer API 的库。如果您想接近标准并直接使用 DevTools 协议,我建议这样做。
启动 Chrome
chrome-remote-interface 不会为您启动 Chrome,因此您必须自行处理。
在 CLI 部分,我们使用 --headless --remote-debugging-port=9222
手动启动了 Chrome。不过,为了完全自动执行测试,您可能需要从应用中生成 Chrome。
一种方法是使用 child_process
:
const execFile = require('child_process').execFile;
function launchHeadlessChrome(url, callback) {
// Assuming MacOSx.
const CHROME = '/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome';
execFile(CHROME, ['--headless', '--disable-gpu', '--remote-debugging-port=9222', url], callback);
}
launchHeadlessChrome('https://www.chromestatus.com', (err, stdout, stderr) => {
...
});
但是,如果您需要一个适用于多个平台的便携式解决方案,情况就会变得非常复杂。只要看一下 Chrome 的硬编码路径 :(
使用 ChromeLauncher
Lighthouse 是一款用于测试 Web 应用质量的强大工具。我们在 Lighthouse 中开发了一个强大的 Chrome 启动模块,该模块现已提取以供独立使用。chrome-launcher
NPM 模块将查找 Chrome 的安装位置,设置调试实例,启动浏览器,并在程序完成后将其终止。最棒的是,它能够跨平台运行,这要归功于 Node!
默认情况下,chrome-launcher
会尝试启动 Chrome Canary(如果已安装),但您可以将其更改为手动选择要使用的 Chrome。如需使用它,请先从 npm 安装:
npm i --save chrome-launcher
示例 - 使用 chrome-launcher
启动无头
const chromeLauncher = require('chrome-launcher');
// Optional: set logging level of launcher to see its output.
// Install it using: npm i --save lighthouse-logger
// const log = require('lighthouse-logger');
// log.setLevel('info');
/**
* Launches a debugging instance of Chrome.
* @param {boolean=} headless True (default) launches Chrome in headless mode.
* False launches a full version of Chrome.
* @return {Promise<ChromeLauncher>}
*/
function launchChrome(headless=true) {
return chromeLauncher.launch({
// port: 9222, // Uncomment to force a specific port of your choice.
chromeFlags: [
'--window-size=412,732',
'--disable-gpu',
headless ? '--headless' : ''
]
});
}
launchChrome().then(chrome => {
console.log(`Chrome debuggable on port: ${chrome.port}`);
...
// chrome.kill();
});
运行此脚本不会执行任何操作,但您应该会看到一个加载了 about:blank
的任务管理器中启动了 Chrome 实例。请注意,这里没有任何浏览器界面我们没有头。
为了控制浏览器,我们需要使用开发者工具协议!
检索有关页面的信息
我们来安装库:
npm i --save chrome-remote-interface
示例
示例 - 输出用户代理
const CDP = require('chrome-remote-interface');
...
launchChrome().then(async chrome => {
const version = await CDP.Version({port: chrome.port});
console.log(version['User-Agent']);
});
结果类似于:HeadlessChrome/60.0.3082.0
示例 - 检查网站是否有 Web 应用清单
const CDP = require('chrome-remote-interface');
...
(async function() {
const chrome = await launchChrome();
const protocol = await CDP({port: chrome.port});
// Extract the DevTools protocol domains we need and enable them.
// See API docs: https://chromedevtools.github.io/devtools-protocol/
const {Page} = protocol;
await Page.enable();
Page.navigate({url: 'https://www.chromestatus.com/'});
// Wait for window.onload before doing stuff.
Page.loadEventFired(async () => {
const manifest = await Page.getAppManifest();
if (manifest.url) {
console.log('Manifest: ' + manifest.url);
console.log(manifest.data);
} else {
console.log('Site has no app manifest');
}
protocol.close();
chrome.kill(); // Kill Chrome.
});
})();
示例 - 使用 DOM API 提取页面的 <title>
。
const CDP = require('chrome-remote-interface');
...
(async function() {
const chrome = await launchChrome();
const protocol = await CDP({port: chrome.port});
// Extract the DevTools protocol domains we need and enable them.
// See API docs: https://chromedevtools.github.io/devtools-protocol/
const {Page, Runtime} = protocol;
await Promise.all([Page.enable(), Runtime.enable()]);
Page.navigate({url: 'https://www.chromestatus.com/'});
// Wait for window.onload before doing stuff.
Page.loadEventFired(async () => {
const js = "document.querySelector('title').textContent";
// Evaluate the JS expression in the page.
const result = await Runtime.evaluate({expression: js});
console.log('Title of page: ' + result.result.value);
protocol.close();
chrome.kill(); // Kill Chrome.
});
})();
使用 Selenium、WebDriver 和 ChromeDriver
现在,Slenium 打开了一个完整的 Chrome 实例。换句话说,它是一个自动化解决方案,但并非完全无头。不过,只需稍作调整,Selenium 就可以配置为运行无头 Chrome。如果您想获得有关如何自行设置的完整说明,建议您使用无头 Chrome 运行 Selenium,但我还是提供了一些示例来帮助您上手。
使用 ChromeDriver
ChromeDriver 2.32 使用 Chrome 61,可与无头 Chrome 配合使用。
安装:
npm i --save-dev selenium-webdriver chromedriver
例如:
const fs = require('fs');
const webdriver = require('selenium-webdriver');
const chromedriver = require('chromedriver');
const chromeCapabilities = webdriver.Capabilities.chrome();
chromeCapabilities.set('chromeOptions', {args: ['--headless']});
const driver = new webdriver.Builder()
.forBrowser('chrome')
.withCapabilities(chromeCapabilities)
.build();
// Navigate to google.com, enter a search.
driver.get('https://www.google.com/');
driver.findElement({name: 'q'}).sendKeys('webdriver');
driver.findElement({name: 'btnG'}).click();
driver.wait(webdriver.until.titleIs('webdriver - Google Search'), 1000);
// Take screenshot of results page. Save to disk.
driver.takeScreenshot().then(base64png => {
fs.writeFileSync('screenshot.png', new Buffer(base64png, 'base64'));
});
driver.quit();
使用 WebDriverIO
WebDriverIO 是基于 Selenium WebDriver 的更高级别 API。
安装:
npm i --save-dev webdriverio chromedriver
示例:在 chromestatus.com 上过滤 CSS 功能
const webdriverio = require('webdriverio');
const chromedriver = require('chromedriver');
const PORT = 9515;
chromedriver.start([
'--url-base=wd/hub',
`--port=${PORT}`,
'--verbose'
]);
(async () => {
const opts = {
port: PORT,
desiredCapabilities: {
browserName: 'chrome',
chromeOptions: {args: ['--headless']}
}
};
const browser = webdriverio.remote(opts).init();
await browser.url('https://www.chromestatus.com/features');
const title = await browser.getTitle();
console.log(`Title: ${title}`);
await browser.waitForText('.num-features', 3000);
let numFeatures = await browser.getText('.num-features');
console.log(`Chrome has ${numFeatures} total features`);
await browser.setValue('input[type="search"]', 'CSS');
console.log('Filtering features...');
await browser.pause(1000);
numFeatures = await browser.getText('.num-features');
console.log(`Chrome has ${numFeatures} CSS features`);
const buffer = await browser.saveScreenshot('screenshot.png');
console.log('Saved screenshot...');
chromedriver.stop();
browser.end();
})();
更多资源
以下是一些可帮助您上手的实用资源:
文档
- DevTools Protocol Viewer - API 参考文档
工具
- chrome-remote-interface - 封装开发者工具协议的节点模块
- Lighthouse - 用于测试 Web 应用质量的自动化工具;大量使用协议
- chrome-launcher - 用于启动 Chrome 的节点模块,已准备好实现自动化
样本歌曲
- “The Headless Web”- Paul Kinlan 写的关于将 Headless 与 api.ai 搭配使用的精彩博文。
FAQ
我需要 --disable-gpu
标志吗?
仅适用于 Windows。其他平台不再需要它。--disable-gpu
标志是一些 bug 的临时解决方法。在未来的 Chrome 版本中,您不再需要此标志。如需了解详情,请参阅 crbug.com/737678。
那么我仍然需要 Xvfb?
不需要。无头 Chrome 不使用窗口,因此不再需要 Xvfb 等显示服务器。即使没有这项功能,您也可以轻松运行自动化测试。
什么是 Xvfb?Xvfb 是适用于类似 Unix 的系统的内存中显示服务器,让您无需连接物理屏幕即可运行图形应用(例如 Chrome)。很多人使用 Xvfb 运行早期版本的 Chrome,进行“无头”测试。
如何创建运行无 Head Chrome 的 Docker 容器?
查看 lighthouse-ci。它包含一个使用 node:8-slim
作为基础映像的示例 Dockerfile,在 App Engine 柔性环境上安装 Lighthouse 并运行 Lighthouse。
可以将此与 Selenium / WebDriver / ChromeDriver 结合使用吗?
是的。请参阅使用 Selenium、WebDriver 和 ChromeDriver。
这与 PhantomJS 有何关系?
无头 Chrome 与 PhantomJS 等工具类似。两者都可用于无头环境中的自动测试。两者之间的主要区别在于,Phantom 使用旧版本的 WebKit 作为其渲染引擎,而无头 Chrome 使用最新版本的 Blink。
目前,Phantom 提供的 API 级别高于 DevTools 协议。
在哪里报告 bug?
如果您发现无头 Chrome 存在 bug,请在 crbug.com 上提交 bug。
对于开发者工具协议中存在的错误,请在 github.com/ChromeDevTools/devtools-protocol 上提交。