WebView2

簡介

以下將說明如何將 Playwright 與 Microsoft Edge WebView2 搭配使用。WebView2 是一個 WinForms 控制項，將使用 Microsoft Edge 來渲染網頁內容。它是 Microsoft Edge 瀏覽器的一部分，適用於 Windows 10 和 Windows 11。Playwright 可用於自動化 WebView2 應用程式，並可用於測試 WebView2 中的網頁內容。為了連接到 WebView2，Playwright 使用 BrowserType.ConnectOverCDPAsync()，它通過 Chrome DevTools Protocol (CDP) 進行連接。

概述

WebView2 控制項可以透過設定 WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS 環境變數為 --remote-debugging-port=9222 或呼叫 EnsureCoreWebView2Async 並帶上 --remote-debugging-port=9222 參數來指示其監聽進入的 CDP 連接。這將啟動啟用 Chrome DevTools Protocol 的 WebView2 程序，允許 Playwright 進行自動化。9222 是此範例中的埠號，但也可以使用任何其他未使用的埠號。

await this.webView.EnsureCoreWebView2Async(await CoreWebView2Environment.CreateAsync(null, null, new CoreWebView2EnvironmentOptions()
{
  AdditionalBrowserArguments = "--remote-debugging-port=9222",
})).ConfigureAwait(false);

一旦包含 WebView2 控制項的應用程式正在執行，你可以通過 Playwright 連接到它:

var browser = await playwright.Chromium.ConnectOverCDPAsync("http://localhost:9222");
var context = browser.Contexts[0];
var page = context.Pages[0];

為了確保 WebView2 控制項已準備好，你可以等待 CoreWebView2InitializationCompleted 事件：

this.webView.CoreWebView2InitializationCompleted += (_, e) =>
{
    if (e.IsSuccess)
    {
        Console.WriteLine("WebView2 initialized");
    }
};

Writing and running tests

預設情況下，WebView2 控制項將對所有實例使用相同的用戶資料目錄。這意味著如果您平行執行多個測試，它們將互相干擾。為了避免這種情況，您應該為每個測試設置 WEBVIEW2_USER_DATA_FOLDER 環境變數（或使用 WebView2.EnsureCoreWebView2Async Method），以使用不同的文件夾。這將確保每個測試在其自己的用戶資料目錄中執行。

使用以下內容，Playwright 將會將你的 WebView2 應用程式作為子程序執行，為其分配一個唯一的使用者資料目錄，並將 Page 實例提供給你的測試：

// WebView2Test.cs
using System.Diagnostics;
using Microsoft.Playwright;
using Microsoft.Playwright.MSTest;

namespace PlaywrightTests;

[TestClass]
public class ExampleTest : PlaywrightTest
{
    public IBrowser Browser { get; internal set; } = null!;
    public IBrowserContext Context { get; internal set; } = null!;
    public IPage Page { get; internal set; } = null!;
    private Process? _webView2Process = null;
    private string _userDataDir = null!;
    private string _executablePath = Path.Join(Directory.GetCurrentDirectory(), @"..\..\..\..\webview2-app\bin\Debug\net8.0-windows\webview2.exe");

    [TestInitialize]
    public async Task BrowserTestInitialize()
    {
        var cdpPort = 10000 + WorkerIndex;
        Assert.IsTrue(File.Exists(_executablePath), "Make sure that the executable exists");
        _userDataDir = Path.Join(Path.GetTempPath(), $"playwright-webview2-tests/user-data-dir-{WorkerIndex}");
        // WebView2 does some lazy cleanups on shutdown so we can't clean it up after each test
        if (Directory.Exists(_userDataDir))
        {
            Directory.Delete(_userDataDir, true);
        }
        _webView2Process = Process.Start(new ProcessStartInfo(_executablePath)
        {
            EnvironmentVariables =
        {
            ["WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS"] = $"--remote-debugging-port={cdpPort}",
            ["WEBVIEW2_USER_DATA_FOLDER"] = _userDataDir,
        },
            RedirectStandardOutput = true,
        });
        while (!_webView2Process!.HasExited)
        {
            var output = await _webView2Process!.StandardOutput.ReadLineAsync();
            if (_webView2Process!.HasExited)
            {
                throw new Exception("WebView2 process exited unexpectedly");
            }
            if (output != null && output.Contains("WebView2 initialized"))
            {
                break;
            }
        }
        var cdpAddress = $"http://127.0.0.1:{cdpPort}";
        Browser = await Playwright.Chromium.ConnectOverCDPAsync(cdpAddress);
        Context = Browser.Contexts[0];
        Page = Context.Pages[0];
    }

    [TestCleanup]
    public async Task BrowserTestCleanup()
    {
        _webView2Process!.Kill(true);
        await Browser.CloseAsync();
    }
}

// UnitTest1.cs
using Microsoft.Playwright;
using Microsoft.Playwright.MSTest;

namespace PlaywrightTests;

[TestClass]
public class ExampleTest : WebView2Test
{
    [TestMethod]
    public async Task HomepageHasPlaywrightInTitleAndGetStartedLinkLinkingtoTheIntroPage()
    {
        await Page.GotoAsync("https://playwright.dev");
        var getStarted = Page.GetByText("Get Started");
        await Expect(getStarted).ToBeVisibleAsync();
    }
}

除錯

在你的 webview2 控制項內，你可以右鍵點擊以打開上下文選單並選擇 "Inspect" 來打開 DevTools 或按 F12。你也可以使用 WebView2.CoreWebView2.OpenDevToolsWindow 方法以程式碼方式打開 DevTools。

如需除錯測試，請參閱 Playwright 除錯指南。