Puppeteer Sharp入门教程：掌握.NET版浏览器自动化利器-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01144/article/details/148575067

Puppeteer Sharp入门教程：掌握.NET版浏览器自动化利器

puppeteer-sharp hardkoded/puppeteer-sharp: Puppeteer-Sharp 是 .NET 中的一个封装库，它提供了对 Google Chrome Puppeteer API 的访问，可用于爬虫抓取、网页自动化、生成预渲染页面等各种场景。项目地址: https://gitcode.com/gh_mirrors/pu/puppeteer-sharp

什么是Puppeteer Sharp

Puppeteer Sharp是一个基于.NET平台的浏览器自动化工具，它是Node.js版Puppeteer的.NET移植版本。这个强大的库允许开发者在.NET环境中控制Chromium或Chrome浏览器，实现各种自动化操作，如页面截图、PDF生成、表单提交、UI测试等。

环境准备与基础配置

在开始使用Puppeteer Sharp前，需要确保项目中已正确安装NuGet包。核心功能依赖于Chromium浏览器，Puppeteer Sharp提供了自动下载和管理Chromium的功能。

核心功能实战

1. 页面截图功能

页面截图是Puppeteer Sharp最基础也是最常用的功能之一。以下是一个完整的截图示例：

// 初始化浏览器实例
using var browserFetcher = new BrowserFetcher();
await browserFetcher.DownloadAsync();
var browser = await Puppeteer.LaunchAsync(new LaunchOptions
{
    Headless = true  // 无头模式运行
});

// 创建新页面并导航
var page = await browser.NewPageAsync();
await page.GoToAsync("http://www.example.com");

// 保存截图
await page.ScreenshotAsync("screenshot.png");

高级技巧：可以通过设置视口大小来控制截图尺寸：

await page.SetViewportAsync(new ViewPortOptions
{
    Width = 1024,  // 设置宽度
    Height = 768   // 设置高度
});

2. PDF生成功能

Puppeteer Sharp能够将网页内容高质量地转换为PDF文档：

var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true });
var page = await browser.NewPageAsync();
await page.GoToAsync("http://www.example.com");

// 生成PDF
await page.PdfAsync("output.pdf");

3. 元素内容获取

自动化测试中经常需要验证页面元素内容：

using (var page = await browser.NewPageAsync())
{
    await page.GoToAsync("https://example.com/blog");
    var header = await page.QuerySelectorAsync("h1");
    var text = await header.GetPropertyAsync("innerText");
    var content = await text.JsonValueAsync<string>();
    Console.WriteLine($"标题内容: {content}");
}

4. HTML内容注入

可以直接向页面注入HTML内容，非常适合生成动态内容：

using(var page = await browser.NewPageAsync())
{
    // 注入自定义HTML
    await page.SetContentAsync("<div class='receipt'>订单详情</div>");
    
    // 获取处理后HTML
    var finalHtml = await page.GetContentAsync();
    
    // 生成PDF
    await page.PdfAsync("receipt.pdf");
}

5. JavaScript执行

Puppeteer Sharp支持在页面上下文中执行JavaScript：

using (var page = await browser.NewPageAsync())
{
    // 执行简单表达式
    var result = await page.EvaluateExpressionAsync<int>("()=> 4 + 3");
    
    // 执行带参数的函数
    var dynamicObj = await page.EvaluateFunctionAsync<dynamic>(
        "(value) => ({property: value})", 
        5);
    
    Console.WriteLine(dynamicObj.property);  // 输出: 5
}

高级应用场景

1. 等待页面元素

处理单页应用(SPA)时，等待特定元素出现非常重要：

await page.GoToAsync("http://spa.example.com");
// 等待主要内容区域加载完成
await page.WaitForSelectorAsync("div.main-content", new WaitForSelectorOptions {
    Timeout = 30000  // 30秒超时
});

2. 响应式设计测试

可以模拟不同视口尺寸并等待布局响应：

await page.GoToAsync("http://responsive.example.com");
var responsiveCheck = page.WaitForFunctionAsync(
    "() => window.innerWidth < 768");

// 切换到移动端视口
await page.SetViewportAsync(new ViewPortOptions { 
    Width = 375, 
    Height = 667 
});

await responsiveCheck;  // 等待响应完成

3. 连接远程浏览器

Puppeteer Sharp支持连接远程浏览器实例，适合分布式测试：

var options = new ConnectOptions()
{
    BrowserWSEndpoint = "wss://remote-browser.example.com"
};

using (var browser = await Puppeteer.ConnectAsync(options))
{
    // 使用远程浏览器实例
    using (var page = await browser.NewPageAsync())
    {
        await page.GoToAsync("https://example.com");
        await page.PdfAsync("remote.pdf");
    }
}