跳到主要内容

WebView2 控件

简介​

以下内容将介绍如何在 Microsoft Edge WebView2 中使用 Playwright。WebView2 是一个 WinForms 控件，底层使用 Microsoft Edge 渲染网页内容。它是 Microsoft Edge 浏览器的一部分，可在 Windows 10 和 Windows 11 上使用。Playwright 可以用于自动化 WebView2 应用程序，也可以用于测试 WebView2 中的网页内容。要连接到 WebView2，Playwright 使用 browser_type.connect_over_cdp() 方法，通过 Chrome DevTools 协议（CDP）进行连接。

概览​

可以通过设置 WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS 环境变量为 --remote-debugging-port=9222，或者调用 EnsureCoreWebView2Async 并传递 --remote-debugging-port=9222 参数，让 WebView2 控件监听传入的 CDP 连接。这将以启用 Chrome DevTools 协议的方式启动 WebView2 进程，从而允许 Playwright 进行自动化。9222 只是一个示例端口，也可以使用其他未被占用的端口。

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

当你的 WebView2 控件应用程序运行后，可以通过 Playwright 进行连接：

browser = playwright.chromium.connect_over_cdp("http://localhost:9222")
context = browser.contexts[0]
page = context.pages[0]

为了确保 WebView2 控件已准备就绪，你可以等待 CoreWebView2InitializationCompleted 事件：

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

编写和运行测试​

默认情况下，WebView2 控件会为所有实例使用相同的用户数据目录。这意味着如果你并行运行多个测试，它们会互相干扰。为避免这种情况，你应该为每个测试设置不同的 WEBVIEW2_USER_DATA_FOLDER 环境变量（或使用 WebView2.EnsureCoreWebView2Async 方法），这样可以确保每个测试在自己的用户数据目录中运行。

使用如下方式，Playwright 会将你的 WebView2 应用作为子进程运行，为其分配唯一的用户数据目录，并为你的测试提供 Page 实例：

conftest.py
import os
import socket
import tempfile
import pytest
from pathlib import Path
from playwright.sync_api import Playwright, Browser, BrowserContext
import subprocess

EXECUTABLE_PATH = (
    Path(__file__).parent
    / ".."
    / "webview2-app"
    / "bin"
    / "Debug"
    / "net8.0-windows"
    / "webview2.exe"
)


@pytest.fixture(scope="session")
def data_dir():
    with tempfile.TemporaryDirectory(
        prefix="playwright-webview2-tests", ignore_cleanup_errors=True
    ) as tmpdirname:
        yield tmpdirname


@pytest.fixture(scope="session")
def webview2_process_cdp_port(data_dir: str):
    cdp_port = _find_free_port()
    process = subprocess.Popen(
        [EXECUTABLE_PATH],
        env={
            **dict(os.environ),
            "WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS": f"--remote-debugging-port={cdp_port}",
            "WEBVIEW2_USER_DATA_FOLDER": data_dir,
        },
        stdout=subprocess.PIPE,
        stderr=subprocess.STDOUT,
        universal_newlines=True,
    )
    while True:
        line = process.stdout.readline()
        # 等待 WebView2 初始化完成
        if "WebView2 initialized" in line:
            break
    yield cdp_port
    process.terminate()


@pytest.fixture(scope="session")
def browser(playwright: Playwright, webview2_process_cdp_port: int):
    browser = playwright.chromium.connect_over_cdp(
        f"http://127.0.0.1:{webview2_process_cdp_port}"
    )
    yield browser


@pytest.fixture(scope="function")
def context(browser: Browser):
    context = browser.contexts[0]
    yield context


@pytest.fixture(scope="function")
def page(context: BrowserContext):
    page = context.pages[0]
    yield page


def _find_free_port(port=9000, max_port=65535):
    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    while port <= max_port:
        try:
            sock.bind(("", port))
            sock.close()
            return port
        except OSError:
            port += 1
    raise IOError("没有可用的端口")
test_webview2.py
from playwright.sync_api import Page, expect


def test_webview2(page: Page):
    page.goto("https://playwright.dev")
    get_started = page.get_by_text("Get Started")
    expect(get_started).to_be_visible()

调试​

在你的 webview2 控件内部，可以直接右键打开上下文菜单并选择“检查”来打开开发者工具，或者按下 F12。你也可以通过 WebView2.CoreWebView2.OpenDevToolsWindow 方法以编程方式打开开发者工具。

如需调试测试，请参阅 Playwright 的调试指南。