TL;DR
Chrome Headless diluncurkan di Chrome 59. Ini adalah cara untuk menjalankan browser Chrome di lingkungan headless. Pada dasarnya, menjalankan Chrome tanpa chrome! Google Cloud menghadirkan semua fitur platform web modern yang disediakan oleh Chromium dan mesin rendering Blink ke baris perintah.
Mengapa hal tersebut bermanfaat?
Browser headless adalah alat yang hebat untuk pengujian otomatis dan lingkungan server tempat Anda tidak memerlukan shell UI yang terlihat. Misalnya, Anda mungkin ingin menjalankan beberapa pengujian terhadap halaman web yang sebenarnya, membuat PDF-nya, atau cukup memeriksa cara browser merender URL.
Headless Memulai (CLI)
Cara termudah untuk mulai menggunakan mode headless adalah dengan membuka biner Chrome
dari baris perintah. Jika Anda telah menginstal Chrome 59 atau yang lebih baru, mulai Chrome dengan tanda --headless
:
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
akan mengarah ke penginstalan Chrome Anda. Lokasi tepatnya akan
bervariasi dari satu platform ke platform yang lain. Karena saya menggunakan Mac, saya membuat nama alias yang mudah digunakan
untuk setiap versi Chrome yang telah saya instal.
Jika Anda menggunakan saluran stabil Chrome dan tidak bisa mendapatkan versi Beta, sebaiknya
menggunakan 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"
Download Chrome Canary di sini.
Fitur command line
Dalam beberapa kasus, Anda mungkin tidak perlu membuat skrip terprogram Chrome Headless. Ada beberapa tanda command line yang berguna untuk melakukan tugas-tugas umum.
Mencetak DOM
Flag --dump-dom
mencetak document.body.innerHTML
ke stdout:
chrome --headless --disable-gpu --dump-dom https://www.chromestatus.com/
Membuat PDF
Tanda --print-to-pdf
membuat PDF halaman:
chrome --headless --disable-gpu --print-to-pdf https://www.chromestatus.com/
Mengambil screenshot
Untuk mengambil screenshot halaman, gunakan tanda --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/
Menjalankan file --screenshot
akan menghasilkan file bernama screenshot.png
dalam
direktori kerja saat ini. Jika Anda mencari screenshot halaman penuh,
yang lebih terlibat. Ada blog bagus
dari David Schnurr yang
berisi seluruh informasi. Periksa
Menggunakan Chrome headless sebagai alat screenshot otomatis .
Mode REPL (loop read-eval-print)
Tanda --repl
menjalankan Headless dalam mode tempat Anda dapat mengevaluasi ekspresi JS
di browser, langsung dari command line:
$ 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
$
Melakukan debug Chrome tanpa UI browser?
Saat Anda menjalankan Chrome dengan --remote-debugging-port=9222
, instance akan dimulai
dengan protokol DevTools diaktifkan. Tujuan
protokol ini digunakan untuk berkomunikasi dengan Chrome dan mengarahkan headless
di instance browser. Itu juga contoh penggunaan alat seperti
Sublime, VS Code, dan {i>Node<i} untuk
proses debug aplikasi dari jarak jauh. #synergy
Karena Anda tidak memiliki UI browser untuk melihat halaman, buka http://localhost:9222
di browser lain untuk memeriksa
apakah semuanya bekerja. Anda akan melihat daftar
halaman yang dapat diperiksa tempat Anda dapat mengklik dan melihat apa yang dirender Headless:
Dari sini, Anda bisa menggunakan fitur DevTools yang sudah dikenal untuk memeriksa, men-debug, dan mengubah halaman seperti yang biasa Anda lakukan. Jika Anda menggunakan Headless secara terprogram, juga merupakan alat debug yang canggih untuk melihat semua protokol DevTools mentah perintah yang melewati kabel, berkomunikasi dengan {i>browser<i}.
Menggunakan secara terprogram (Node)
Dam
Puppeteer adalah library Node yang dikembangkan oleh tim Chrome. Memberikan API tingkat tinggi untuk mengontrol headless (atau versi lengkap) Chrome. Ini serupa dengan library pengujian otomatis lainnya seperti Phantom dan NightmareJS, tetapi hanya berfungsi pada versi Chrome terbaru.
Di antara hal-hal lainnya, Puppeteer dapat digunakan untuk mengambil tangkapan layar, membuat PDF, menavigasi halaman, dan mengambil informasi tentang halaman tersebut. Saya merekomendasikan perpustakaan jika ingin mengotomatiskan pengujian browser dengan cepat. Ini menyembunyikan kerumitan protokol DevTools dan menangani tugas berlebihan seperti meluncurkan men-debug instance Chrome.
Instal:
npm i --save puppeteer
Contoh - cetak agen pengguna
const puppeteer = require('puppeteer');
(async() => {
const browser = await puppeteer.launch();
console.log(await browser.version());
await browser.close();
})();
Contoh - mengambil screenshot halaman
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();
})();
Lihat dokumentasi Puppeteer untuk mempelajari lebih lanjut API lengkap.
Perpustakaan CRI
chrome-remote-interface adalah library dengan level yang lebih rendah dari API Puppeteer. Saya merekomendasikannya jika Anda ingin menjadi yang dekat dengan logam dan menggunakan protokol DevTools secara langsung.
Meluncurkan Chrome
chrome-remote-interface tidak meluncurkan Chrome untuk Anda, jadi Anda harus mengambil mengurusnya sendiri.
Di bagian CLI, kami memulai Chrome secara manual menggunakan
--headless --remote-debugging-port=9222
. Namun, untuk mengotomatiskan
pengujian sepenuhnya, Anda mungkin akan
ingin memunculkan Chrome dari aplikasi Anda.
Salah satu caranya adalah menggunakan 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) => {
...
});
Tetapi keadaan akan menjadi rumit jika Anda menginginkan solusi portabel yang dapat berfungsi di seluruh platform Google. Lihat saja jalur hard code ke Chrome :(
Menggunakan ChromeLauncher
Lighthouse adalah tempat yang luar biasa
untuk menguji kualitas aplikasi web Anda. Modul yang andal untuk peluncuran
Chrome dikembangkan di Lighthouse dan kini diekstrak untuk penggunaan mandiri.
Modul NPM chrome-launcher
akan menemukan di mana
Chrome diinstal, menyiapkan instance debug, meluncurkan browser, dan menghentikannya
setelah program Anda selesai. Bagian terbaiknya adalah ia berfungsi
secara lintas platform berkat
{i>Node<i}.
Secara default, chrome-launcher
akan mencoba meluncurkan Chrome Canary (jika
diinstal), tetapi Anda dapat mengubahnya untuk memilih Chrome yang akan digunakan secara manual. Kepada
gunakan, instal pertama dari npm:
npm i --save chrome-launcher
Contoh - menggunakan chrome-launcher
untuk meluncurkan Headless
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();
});
Menjalankan skrip ini tidak melakukan banyak hal, tetapi Anda akan melihat instance
Chrome dijalankan di pengelola tugas yang memuat about:blank
. Ingat, di sana
tidak akan berupa UI browser apa pun. Kami tanpa kepala.
Untuk mengontrol browser, kita memerlukan protokol DevTools!
Mengambil informasi tentang halaman
Mari kita instal library:
npm i --save chrome-remote-interface
Contoh
Contoh - cetak agen pengguna
const CDP = require('chrome-remote-interface');
...
launchChrome().then(async chrome => {
const version = await CDP.Version({port: chrome.port});
console.log(version['User-Agent']);
});
Menghasilkan sesuatu seperti: HeadlessChrome/60.0.3082.0
Contoh - periksa apakah situs memiliki manifes aplikasi 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.
});
})();
Contoh - ekstrak <title>
halaman menggunakan DOM API.
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.
});
})();
Menggunakan Selenium, WebDriver, dan ChromeDriver
Saat ini, Selenium membuka contoh Chrome lengkap. Dengan kata lain, ini adalah solusi otomatis, tetapi tidak sepenuhnya headless. Namun, Selenium bisa dikonfigurasi untuk menjalankan Chrome headless dengan sedikit upaya. Saya sarankan Menjalankan Selenium dengan Chrome Headless jika Anda ingin petunjuk lengkap tentang cara mengatur sendiri semuanya, tapi saya mencantumkan beberapa contoh di bawah ini untuk membantu Anda memulai.
Menggunakan ChromeDriver
ChromeDriver 2.32 menggunakan Chrome 61 dan berfungsi baik dengan Chrome headless.
Instal:
npm i --save-dev selenium-webdriver chromedriver
Contoh:
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();
Menggunakan WebDriverIO
WebDriverIO adalah API level yang lebih tinggi selain Selenium WebDriver.
Instal:
npm i --save-dev webdriverio chromedriver
Contoh: memfilter fitur CSS di chromestatus.com
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();
})();
Aset lainnya
Berikut ini beberapa referensi berguna untuk memulai:
Dokumen
- DevTools Protocol Viewer - Dokumen referensi API
Alat
- chrome-remote-interface - node modul yang menggabungkan protokol DevTools
- Lighthouse - alat otomatis untuk pengujian kualitas aplikasi web; banyak menggunakan protokol
- chrome-launcher - modul node untuk meluncurkan Chrome, siap untuk otomatisasi
Demo
- "Web Headless" - Blog bagus Paul Kinlan memposting tentang penggunaan Headless dengan api.ai.
FAQ
Apakah saya memerlukan flag --disable-gpu
?
Hanya di Windows. Platform lain tidak lagi memerlukannya. Flag --disable-gpu
adalah
sementara waktu untuk
menemukan beberapa serangga. Anda tidak memerlukan penanda ini di versi mendatang
Chrome. Lihat crbug.com/737678
untuk informasi selengkapnya.
Jadi, saya masih memerlukan Xvfb?
Tidak. Chrome Headless tidak menggunakan jendela sehingga server tampilan seperti Xvfb tidak lagi diperlukan. Anda dapat menjalankan pengujian otomatis dengan lancar tanpanya.
Apa itu Xvfb? Xvfb adalah server tampilan dalam memori untuk sistem serupa Unix yang memungkinkan Anda untuk menjalankan aplikasi grafis (seperti Chrome) tanpa memasang layar fisik. Banyak orang menggunakan Xvfb untuk menjalankan versi Chrome sebelumnya untuk melakukan operasi "headless" pengujian.
Bagaimana cara membuat container Docker yang menjalankan Headless Chrome?
Lihat mercusuar-ci. Alat ini memiliki
contoh Dockerfile
yang menggunakan node:8-slim
sebagai image dasar, menginstal +
menjalankan Lighthouse
di App Engine Flex.
Dapatkah saya menggunakan ini dengan Selenium / WebDriver / ChromeDriver?
Ya. Lihat Menggunakan Selenium, WebDriver, dan ChromeDriver.
Bagaimana kaitannya dengan PhantomJS?
Chrome Headless mirip dengan alat seperti PhantomJS. Keduanya dapat digunakan untuk pengujian otomatis di lingkungan headless. Perbedaan utamanya di antara keduanya adalah bahwa Phantom menggunakan versi WebKit yang lebih lama sebagai sementara Headless Chrome menggunakan Blink versi terbaru.
Saat ini, Phantom juga menyediakan level API yang lebih tinggi daripada protokol DevTools.
Di mana saya dapat melaporkan bug?
Untuk bug pada Chrome Headless, laporkan di crbug.com.
Untuk bug dalam protokol DevTools, laporkan di github.com/ChromeDevTools/devtools-protocol.