Puppeteer的入門教程和實踐

任乃千發表於2017-10-26

出現的背景

Chrome59(linux、macos)、 Chrome60(windows)之後，Chrome自帶headless(無介面)模式很方便做自動化測試或者爬蟲。但是如何和headless模式的Chrome互動則是一個問題。通過啟動Chrome時的命令列引數僅能實現簡易的啟動時初始化操作。Selenium、Webdriver等是一種解決方案，但是往往依賴眾多，不夠扁平。

Puppeteer.png

Puppeteer是谷歌官方出品的一個通過DevTools協議控制headless Chrome的Node庫。可以通過Puppeteer的提供的api直接控制Chrome模擬大部分使用者操作來進行UI Test或者作為爬蟲訪問頁面來收集資料。

環境和安裝

Puppeteer本身依賴6.4以上的Node，但是為了非同步超級好用的async/await，推薦使用7.6版本以上的Node。另外headless Chrome本身對伺服器依賴的庫的版本要求比較高，centos伺服器依賴偏穩定，v6很難使用headless Chrome，提升依賴版本可能出現各種伺服器問題（包括且不限於無法使用ssh），最好使用高版本伺服器。

Puppeteer因為是一個npm的包，所以安裝很簡單：

npm i puppeteer

或者

yarn add puppeteer

Puppeteer安裝時自帶一個最新版本的Chromium，可以通過設定環境變數或者npm config中的PUPPETEER_SKIP_CHROMIUM_DOWNLOAD跳過下載。如果不下載的話，啟動時可以通過puppeteer.launch([options])配置項中的executablePath指定Chromium的位置。

使用和例子

Puppeteer類似其他框架，通過操作Browser例項來操作瀏覽器作出相應的反應。

const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('http://rennaiqian.com');
  await page.screenshot({path: 'example.png'});
  await page.pdf({path: 'example.pdf', format: 'A4'});
  await browser.close();
})();
複製程式碼

上述程式碼通過puppeteer的launch方法生成了一個browser的例項，對應於瀏覽器，launch方法可以傳入配置項，比較有用的是在本地除錯時傳入{headless:false}可以關閉headless模式。

const browser = await puppeteer.launch({headless:false})
複製程式碼

browser.newPage方法可以開啟一個新選項卡並返回選項卡的例項page，通過page上的各種方法可以對頁面進行常用操作。上述程式碼就進行了截圖和列印pdf的操作。

一個很強大的方法是page.evaluate(pageFunction, ...args)，可以向頁面注入我們的函式，這樣就有了無限可能

const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('http://rennaiqian.com');

  // Get the "viewport" of the page, as reported by the page.
  const dimensions = await page.evaluate(() => {
    return {
      width: document.documentElement.clientWidth,
      height: document.documentElement.clientHeight,
      deviceScaleFactor: window.devicePixelRatio
    };
  });

  console.log('Dimensions:', dimensions);
  await browser.close();
})();
複製程式碼

需要注意的是evaluate方法中是無法直接使用外部的變數的，需要作為引數傳入，想要獲得執行的結果也需要return出來。因為是一個開源一個多月的專案，現在專案很活躍，所以使用時自行查詢api才能保證引數、使用方法不會錯。

除錯技巧

  1. 關掉無介面模式，有時檢視瀏覽器顯示的內容是很有用的。使用以下命令可以啟動完整版瀏覽器：
const browser = await puppeteer.launch({headless: false})
複製程式碼
  1. 減慢速度，slowMo選項以指定的毫秒減慢Puppeteer的操作。這是另一個看到發生了什麼的方法：
const browser = await puppeteer.launch({
  headless:false,
  slowMo:250
});
複製程式碼

3.捕獲console的輸出,通過監聽console事件。在page.evaluate裡除錯程式碼時這也很方便：

page.on('console', msg => console.log('PAGE LOG:', ...msg.args));
await page.evaluate(() => console.log(`url is ${location.href}`));
複製程式碼

4.啟動詳細日誌記錄，所有公共API呼叫和內部協議流量都將通過puppeteer名稱空間下的debug模組進行記錄

 # Basic verbose logging
 env DEBUG="puppeteer:*" node script.js

 # Debug output can be enabled/disabled by namespace
 env DEBUG="puppeteer:*,-puppeteer:protocol" node script.js # everything BUT protocol messages
 env DEBUG="puppeteer:session" node script.js # protocol session messages (protocol messages to targets)
 env DEBUG="puppeteer:mouse,puppeteer:keyboard" node script.js # only Mouse and Keyboard API calls

 # Protocol traffic can be rather noisy. This example filters out all Network domain messages
 env DEBUG="puppeteer:*" env DEBUG_COLORS=true node script.js 2>&1 | grep -v '"Network'
複製程式碼

爬蟲實踐

很多網頁通過user-agent來判斷裝置，可以通過page.emulate(options)來進行模擬。options有兩個配置項，一個為userAgent，另一個為viewport可以設定寬度(width)、高度(height)、螢幕縮放(deviceScaleFactor)、是否是移動端(isMobile)、有無touch事件(hasTouch)。

const puppeteer = require('puppeteer');
const devices = require('puppeteer/DeviceDescriptors');
const iPhone = devices['iPhone 6'];

puppeteer.launch().then(async browser => {
  const page = await browser.newPage();
  await page.emulate(iPhone);
  await page.goto('https://www.example.com');
  // other actions...
  await browser.close();
});
複製程式碼

上述程式碼則模擬了iPhone6訪問某網站，其中devices是puppeteer內建的一些常見裝置的模擬引數。

很多網頁需要登入，有兩種解決方案：

  1. 讓puppeteer去輸入賬號密碼 常用方法：點選可以使用page.click(selector[, options])方法，也可以選擇聚焦page.focus(selector)。 輸入可以使用page.type(selector, text[, options])輸入指定的字串，還可以在options中設定delay緩慢輸入更像真人一些。也可以使用keyboard.down(key[, options])來一個字元一個字元的輸入。

  2. 如果是通過cookie判斷登入狀態的可以通過page.setCookie(...cookies)，想要維持cookie可以定時訪問。

Tip：有些網站需要掃碼，但是相同域名的其他網頁卻有登入，就可以嘗試去可以登入的網頁登入完利用cookie訪問跳過掃碼。

簡單例子

const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch({headless: false});
  const page = await browser.newPage();
  await page.goto('https://baidu.com');
  await page.type('#kw', 'puppeteer', {delay: 100});
  page.click('#su')
  await page.waitFor(1000);
  const targetLink = await page.evaluate(() => {
    return [...document.querySelectorAll('.result a')].filter(item => {
      return item.innerText && item.innerText.includes('Puppeteer的入門和實踐')
    }).toString()
  });
  await page.goto(targetLink);
  await page.waitFor(1000);
  browser.close();
})()
複製程式碼

records.gif

歡迎訪問我的部落格

相關文章