Skip to main content

網路

簡介​

Playwright 提供 API 來監控和修改瀏覽器網路流量，包括 HTTP 和 HTTPS。頁面所做的任何請求，包括 XHRs 和 fetch 請求，都可以被追蹤、修改和處理。

模擬 API​

查看我們的 API mocking 指南 以了解更多資訊。

  • 模擬 API 請求並且不會觸發 API
  • 執行 API 請求並修改回應
  • 使用 HAR 檔案來模擬網路請求。

HTTP 認證​

執行 HTTP 認證。

using var context = await Browser.NewContextAsync(new()
{
    HttpCredentials = new HttpCredentials
    {
        Username = "bill",
        Password = "pa55w0rd"
    },
});
var page = await context.NewPageAsync();
await page.GotoAsync("https://example.com");

HTTP Proxy​

您可以配置頁面通過 HTTP(S) 代理或 SOCKSv5 加載。代理可以為整個瀏覽器全域設置，也可以為每個瀏覽器上下文單獨設置。

您可以選擇性地指定 HTTP(S) 代理的使用者名稱和密碼，您也可以指定要繞過代理的主機。

這裡是一個全域代理的範例:

var proxy = new Proxy
{
    Server = "http://myproxy.com:3128",
    Username = "user",
    Password = "pwd"
};
await using var browser = await BrowserType.LaunchAsync(new()
{
    Proxy = proxy
});

也可以根據上下文指定它:

await using var browser = await BrowserType.LaunchAsync();
await using var context = await browser.NewContextAsync(new()
{
    Proxy = new Proxy { Server = "http://myproxy.com:3128" },
});

網路事件​

你可以監控所有的 Request 和 Response:

using Microsoft.Playwright;

using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Chromium.LaunchAsync();
var page = await browser.NewPageAsync();
page.Request += (_, request) => Console.WriteLine(">> " + request.Method + " " + request.Url);
page.Response += (_, response) => Console.WriteLine("<< " + response.Status + " " + response.Url);
await page.GotoAsync("https://example.com");

或者在按鈕點擊後等待網路回應 Page.RunAndWaitForResponseAsync():

// Use a glob URL pattern
var waitForResponseTask = page.WaitForResponseAsync("**/api/fetch_data");
await page.GetByText("Update").ClickAsync();
var response = await waitForResponseTask;

變體​

等待 Responses with Page.RunAndWaitForResponseAsync()

// Use a regular expression
var waitForResponseTask = page.WaitForResponseAsync(new Regex("\\.jpeg$"));
await page.GetByText("Update").ClickAsync();
var response = await waitForResponseTask;

// Use a predicate taking a Response object
var waitForResponseTask = page.WaitForResponseAsync(r => r.Url.Contains(token));
await page.GetByText("Update").ClickAsync();
var response = await waitForResponseTask;

處理請求​

您可以通過在您的 Playwright 腳本中處理網路請求來模擬 API 端點。

變體​

在整個瀏覽器上下文中設定路由，使用 BrowserContext.RouteAsync() 或頁面使用 Page.RouteAsync()。它將適用於彈出視窗和打開的連結。

await page.RouteAsync("**/api/fetch_data", async route => {
  await route.FulfillAsync(new() { Status = 200, Body = testData });
});
await page.GotoAsync("https://example.com");

修改請求​

// Delete header
await page.RouteAsync("**/*", async route => {
    var headers = new Dictionary<string, string>(route.Request.Headers.ToDictionary(x => x.Key, x => x.Value));
    headers.Remove("X-Secret");
    await route.ContinueAsync(new() { Headers = headers });
});

// Continue requests as POST.
await Page.RouteAsync("**/*", async route => await route.ContinueAsync(new() { Method = "POST" }));

你可以繼續請求並進行修改。上面的範例從傳出的請求中移除了 HTTP 標頭。

中止請求​

你可以使用 Page.RouteAsync() 和 Route.AbortAsync() 中止請求。

await page.RouteAsync("**/*.{png,jpg,jpeg}", route => route.AbortAsync());

// Abort based on the request type
await page.RouteAsync("**/*", async route => {
if ("image".Equals(route.Request.ResourceType))
    await route.AbortAsync();
else
    await route.ContinueAsync();
});

修改回應​

要修改回應，使用 APIRequestContext 獲取原始回應，然後將回應傳遞給 Route.FulfillAsync()。您可以通過選項覆蓋回應的個別欄位：

await Page.RouteAsync("**/title.html", async route =>
{
    // Fetch original response.
    var response = await route.FetchAsync();
    // Add a prefix to the title.
    var body = await response.TextAsync();
    body = body.Replace("<title>", "<title>My prefix:");

    var headers = response.Headers;
    headers.Add("Content-Type", "text/html");

    await route.FulfillAsync(new()
    {
        // Pass all fields from the response.
        Response = response,
        // Override response body.
        Body = body,
        // Force content type to be html.
        Headers = headers,
    });
});

WebSockets​

Playwright 支援 WebSockets 檢查。每次建立 WebSocket 時，會觸發 Page.WebSocket 事件。此事件包含 WebSocket 實例，以供進一步的 web socket 框架檢查:

page.WebSocket += (_, ws) =>
{
    Console.WriteLine("WebSocket opened: " + ws.Url);
    ws.FrameSent += (_, f) => Console.WriteLine(f.Text);
    ws.FrameReceived += (_, f) => Console.WriteLine(f.Text);
    ws.Close += (_, ws1) => Console.WriteLine("WebSocket closed");
};

缺少網路事件和服務工作者​

Playwright 的內建 BrowserContext.RouteAsync() 和 Page.RouteAsync() 允許您的測試原生地路由請求並執行模擬和攔截。

  1. 如果你正在使用 Playwright 的原生 BrowserContext.RouteAsync() 和 Page.RouteAsync()，並且出現網路事件缺失的情況，請通過將 Browser.newContext.serviceWorkers 設置為 'block' 來停用 Service Workers。
  2. 可能是因為你正在使用一個模擬工具，例如 Mock Service Worker (MSW)。雖然這個工具可以開箱即用來模擬回應，但它添加了自己的 Service Worker，接管了網路請求，因此使它們對 BrowserContext.RouteAsync() 和 Page.RouteAsync() 不可見。如果你對網路測試和模擬都感興趣，請考慮使用內建的 BrowserContext.RouteAsync() 和 Page.RouteAsync() 來進行回應模擬。
  3. 如果你不僅僅對使用 Service Workers 進行測試和網路模擬感興趣，還想對 Service Workers 自身發出的請求進行路由和監聽，請參見這個實驗性功能。