Puppeteer相关介绍

最近在使用lighthouse和puppeteer进行一些性能测试相关的工作,感觉puppeteer还是很好用的,下面简单介绍一下puppeteer的使用

概念

Headless Chrome

  • 是一种在无界面的环境中运行 Chrome,与正常Chrome的区别
    • 直接通过命令行或者程序语言操作
    • 没有界面,少了加载 css/js、渲染页面的工作,比真实浏览器更快,更稳定
  • 在启动 Chrome 时添加参数 --headless,便可以 headless 模式启动 Chrome

Puppeteer

  • 是 Node.js 工具引擎
  • 是 Chrome Developer Protocol 的上层封装
  • 提供了高级API来通过DevTools协议控制Chrome或Chromium
  • 默认是headless,可通过参数配置调出界面

Puppeteer可以做什么

  • 生成页面的屏幕截图和PDF。(包括滚动元素的全屏截图)
  • 爬取SPA(单页应用程序)并生成预渲染的内容(即“ SSR”(服务器端渲染))。
  • 自动进行表单提交,UI测试,键盘输入等。
  • 创建最新的自动化测试环境。使用最新的JavaScript和浏览器功能,直接在最新版本的Chrome中运行测试。
  • 捕获站点的时间线跟踪,以帮助诊断性能问题。
  • 测试Chrome扩展程序。

文档资源

API

结合API文档使用


image.png
Browser: 对应一个浏览器实例
BrowserContext: 对应浏览器一个上下文会话
Page:表示一个 Tab 页面
Frame: 一个框架
ExecutionContext: javascript 的执行环境
ElementHandle: 对应 DOM 的一个元素节点
JsHandle:对应 DOM 中的 javascript 对象CDPSession:可以直接与原生的 CDP 进行通信
Coverage:获取 JavaScript 和 CSS 代码覆盖率
Tracing:抓取性能数据进行分析
Response: 页面收到的响应
Request: 页面发出的请求

Puppeteer-Recoder

  • 可以直接记录与浏览器进行交互,生成Puppeteer脚本。
  • 可以在chrome中添加插件直接使用
  • 缺点:无法记录滚动操作
点击record开始记录 生成代码可直接运行
image.png
image.png

一些简单的例子

网页截图功能

const puppeteer = require('puppeteer');

(async () => {
  // 生成browser实例
  const browser = await puppeteer.launch();  
  
  // 解析一个新的页面。页面是在默认浏览器上下文创建的
  const page = await browser.newPage();
  
  // 设置网页大小
  await page.setViewport({ width: 1000, height: 500 });
  
  // 跳转到 https://example.com, 这里可以增加一些参数配置
  await page.goto('https://example.com');
  
  // 生成图片
  await page.screenshot({path: 'example.png'});

  // 生成pdf
  await page.pdf({path: 'page.pdf'});

  await browser.close();
})();

如果想调出界面

const browserConfig = {
    headless: false 
};
const browser = await puppeteer.launch(browserConfig);

如果想截图滚动元素

// 针对滚动元素截屏
async function scrollElementShot(page, selectorName, outputPath) {
    // 选中滚动元素
    const scrollableSectionEl = await page.waitForSelector(selectorName);
    
    // 获取滚动元素参数
    const bounding_box = await scrollableSectionEl.boundingBox();

    await scrollableSectionEl.screenshot({
        path: outputPath,
        clip: bounding_box
    });
}

如果设置不同网络状态

// 一些网络状态
const NETWORK_PRESETS = {
    // 所有速度 / 8 是因为网络速度通常以比特/秒,而 DevTools 预计吞吐量在字节/秒! (1字节 = 8比特)
    GPRS: {
        offline: false, // 是否连接
        downloadThroughput: (50 * 1024) / 8, // 模拟下载速度
        uploadThroughput: (20 * 1024) / 8,  // 模拟上传速度 
        latency: 500 // 模拟延迟(毫秒)
    },
    Regular2G: {
        offline: false,
        downloadThroughput: (250 * 1024) / 8,
        uploadThroughput: (50 * 1024) / 8,
        latency: 300
    },
};

async function setNet(network, page) {
    // 添加网络环境
    if (network !== 'default') {
        // Connect to Chrome DevTools
        await page._client.send('Network.emulateNetworkConditions', NETWORK_PRESETS[network]);
    }
}

const page = await browser.newPage();
// 添加网络环境
// Connect to Chrome DevTools
await page._client.send('Network.emulateNetworkConditions', NETWORK_PRESETS['GPRS']);

如果设置不同GPUThrottling

await page._client.send('Emulation.setCPUThrottlingRate', { rate: 4 });

一些时间节点判断API

// 等待3s
await page.waitForTimeout(3000);

// 等待某个元素出现
await page.waitForSelector('div > .m-tabwrap');

// 等待某个条件项
await page.waitForFunction('window.innerWidth < 100');

性能分析相关API

  • tracing,生成的json文件可直接拖入ChromeDevTools的performance面板中查看
await page.tracing.start({path: 'trace.json', screenshots: true});
await page.click('div > .m-tabwrap > .m-tab > li:nth-child(3) > a');
await page.waitForTimeout(3000);
await page.screenshot({
    path: 'demo1.png'
});
await page.tracing.stop();
  • 通过 page.getMetrics() 可以得到一些页面性能数据
const metrics = await page.metrics();

<!--Timestamp The timestamp when the metrics sample was taken.-->
<!--Documents 页面文档数-->
<!--Frames 页面 frame 数-->
<!--JSEventListeners 页面内事件监听器数-->
<!--Nodes 页面 DOM 节点数-->
<!--LayoutCount 页面 layout 数-->
<!--RecalcStyleCount 样式重算数-->
<!--LayoutDuration 页面 layout 时间-->
<!--RecalcStyleDuration 样式重算时长-->
<!--ScriptDuration script 时间-->
<!--TaskDuration 所有浏览器任务时长-->
<!--JSHeapUsedSize JavaScript 占用堆大小-->
<!--JSHeapTotalSize JavaScript 堆总量-->

更多

更多示例可参考官方示例库

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,347评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,435评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,509评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,611评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,837评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,987评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,730评论 0 267
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,194评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,525评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,664评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,334评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,944评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,764评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,997评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,389评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,554评论 2 349

推荐阅读更多精彩内容