PhantomJS 是一個基於 WebKit 的伺服器端 JavaScript API。它全面支援web而不需瀏覽器支持,其快速,原生支持各種Web標準: DOM 處理, CSS 選擇器, JSON, Canvas, 和 SVG。 PhantomJS 可用於 頁面自動化 , 網路監測 , 網頁截圖 ,以及 無介面測試 等。
PhantomJs官網:http://phantomjs.org/
GitHub:https://github.com/ariya/phantomjs/wiki/Quick-Start
一、安裝
安裝套件下載位址:http://phantomjs.org/download.html ,包含Windows ,Mac OS,Linux版本,自行選擇對應版本下載解壓縮即可( 為方便使用,可自已為phantomjs設定環境變數),其中有一個example資料夾,裡面有許多已經寫好的程式碼可供使用。本文假設phantomjs已經安裝好並已設定了環境變數。
二、使用
Hello, World!
新建一個包含下面兩行腳本的文字檔:
console.log('Hello, world!'); phantom.exit();
將檔案另存為 hello.js ,然後執行它:
phantomjs hello.js
輸出結果為:Hello, world!
第一行將會在終端機上印出字串,第二行 phantom.exit 將退出運作。
在該腳本中呼叫 phantom.exit 是非常重要的,否則 PhantomJS 將根本不會停止。
腳本參數 – Script Arguments
Phantomjs如何傳遞參數呢?如下圖 :
其中的foo, bar, baz就是要傳遞的參數,如何取得呢:
var system = require('system'); if (system.args.length === 1) { console.log('Try to pass some args when invoking this script!'); } else { system.args.forEach(function (arg, i) { console.log(i + ': ' + arg); }); } phantom.exit();
它將輸出 :
0: foo
1: bar
2: baz
頁面載入 – Page Loading
透過建立一個網頁對象,一個網頁可以被加載,分析和渲染。
下面的腳本將範例頁面物件最簡單的用法,它載入 example.com 並且將它儲存為一張圖片, example.png 。
var page = require('webpage').create(); page.open('http://example.com', function () { page.render('example.png'); phantom.exit(); });
由於它的這個特性,PhantomJS 可以用來 網頁截圖 ,截取一些內容的快照,比如將網頁、SVG存成圖片,PDF等,這個功能很牛X。
接下來的 loadspeed.js 腳本載入一個特殊的URL (不要忘了http協定) 並且計量載入該頁面的時間。
var page = require('webpage').create(), system = require('system'), t, address; if (system.args.length === 1) { console.log('Usage: loadspeed.js <some URL>'); phantom.exit(); } t = Date.now(); address = system.args[1]; page.open(address, function (status) { if (status !== 'success') { console.log('FAIL to load the address'); } else { t = Date.now() - t; console.log('Loading time ' + t + ' msec'); } phantom.exit(); });
在命令列運行該腳本:
phantomjs loadspeed.js http://www.google.com
它輸出像下面的東西:
Loading http://www.google.com Loading time 719 msec
程式碼運算 – Code Evaluation
要想在網頁的上下文中對JavaScript 或 CoffeeScript 進行運算,使用 evaluate() 方法。程式碼是在「沙箱」中運行的,它沒有辦法讀取在其所屬頁面上下文之外的任何JavaScript物件和變數。 evaluate() 會傳回一個對象,然而它只限制於簡單的物件並且不能包含方法或閉包。
這有一個範例來顯示網頁標題:
var page = require('webpage').create(); page.open(url, function (status) { var title = page.evaluate(function () { return document.title; }); console.log('Page title is ' + title); });
任何來自於網頁並且包括來自 evaluate() 內部程式碼的控制台訊息,預設不會顯示的。要重寫這個行為,使用 onConsoleMessage 回呼函數,前一個範例可以改寫成:
var page = require('webpage').create(); page.onConsoleMessage = function (msg) { console.log('Page title is ' + msg); }; page.open(url, function (status) { page.evaluate(function () { console.log(document.title); }); });
DOM操作 – DOM Manipulation
由於腳本好像是一個在網頁瀏覽器上運行的一樣,標準的DOM腳本和CSS選擇器可以很好的工作。這使得PhantomJS適合支援各種 頁面自動化任務 。
下面的 useragent.js 將讀取 id 為myagent的元素的 textContent 屬性:
var page = require('webpage').create(); console.log('The default user agent is ' + page.settings.userAgent); page.settings.userAgent = 'SpecialAgent'; page.open('http://www.httpuseragent.org', function (status) { if (status !== 'success') { console.log('Unable to access network'); } else { var ua = page.evaluate(function () { return document.getElementById('myagent').textContent; }); console.log(ua); } phantom.exit(); });
上面範例同樣提供了一種自訂 user agent 的方法。
使用JQuery及其他類別庫:
var page = require('webpage').create(); page.open('http://www.sample.com', function() { page.includeJs("http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js", function() { page.evaluate(function() { $("button").click(); }); phantom.exit() }); });
網路請求及回應 – Network Requests and Responses
將一個頁面從一台遠端伺服器請求一個資源的時候,請求和回應都可以透過 onResourceRequested 和 onResourceReceived 回呼方法追蹤到。範例 netlog.js :
var page = require('webpage').create(); page.onResourceRequested = function (request) { console.log('Request ' + JSON.stringify(request, undefined, 4)); }; page.onResourceReceived = function (response) { console.log('Receive ' + JSON.stringify(response, undefined, 4)); }; page.open(url);
獲取如何把該特性用於HAR 輸出以及基於YSlow的性能分析的更多信息,請參閱 網絡監控頁面 。