跳至主要内容

Network

简介​

Playwright 提供了API来监控和修改浏览器网络流量，包括HTTP和HTTPS。页面发出的任何请求，包括XHRs和fetch请求，都可以被跟踪、修改和处理。

模拟API接口​

查看我们的API模拟指南了解更多关于如何

  • 模拟API请求而无需实际调用API
  • 执行API请求并修改响应
  • 使用HAR文件来模拟网络请求。

HTTP认证​

执行HTTP认证。

context = browser.new_context(
    http_credentials={"username": "bill", "password": "pa55w0rd"}
)
page = context.new_page()
page.goto("https://example.com")

HTTP代理​

您可以配置页面通过HTTP(S)代理或SOCKSv5加载。代理可以全局设置用于整个浏览器，也可以单独为每个浏览器上下文设置。

您可以选择性地为HTTP(S)代理指定用户名和密码，也可以指定要绕过proxy的主机。

这是一个全局代理的示例：

browser = chromium.launch(proxy={
  "server": "http://myproxy.com:3128",
  "username": "usr",
  "password": "pwd"
})

也可以针对每个上下文单独指定：

browser = chromium.launch()
context = browser.new_context(proxy={"server": "http://myproxy.com:3128"})

网络事件​

您可以监控所有的Request请求和Response响应：

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    chromium = playwright.chromium
    browser = chromium.launch()
    page = browser.new_page()
    # Subscribe to "request" and "response" events.
    page.on("request", lambda request: print(">>", request.method, request.url))
    page.on("response", lambda response: print("<<", response.status, response.url))
    page.goto("https://example.com")
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

或者在按钮点击后等待网络响应，使用 page.expect_response()：

# Use a glob url pattern
with page.expect_response("**/api/fetch_data") as response_info:
    page.get_by_text("Update").click()
response = response_info.value

变体​

等待Response响应，使用page.expect_response()

# Use a regular expression
with page.expect_response(re.compile(r"\.jpeg$")) as response_info:
    page.get_by_text("Update").click()
response = response_info.value

# Use a predicate taking a response object
with page.expect_response(lambda response: token in response.url) as response_info:
    page.get_by_text("Update").click()
response = response_info.value

处理请求​

page.route(
    "**/api/fetch_data",
    lambda route: route.fulfill(status=200, body=test_data))
page.goto("https://example.com")

你可以通过在Playwright脚本中处理网络请求来模拟API端点。

变体​

在整个浏览器上下文中设置路由使用browser_context.route()或在页面中使用page.route()。这将适用于弹出窗口和打开的链接。

context.route(
    "**/api/login",
    lambda route: route.fulfill(status=200, body="accept"))
page.goto("https://example.com")

修改请求​

# Delete header
def handle_route(route):
    headers = route.request.headers
    del headers["x-secret"]
    route.continue_(headers=headers)
page.route("**/*", handle_route)

# Continue requests as POST.
page.route("**/*", lambda route: route.continue_(method="POST"))

您可以对请求进行修改后继续发送。上面的示例移除了传出请求中的一个HTTP头部。

中止请求​

您可以使用page.route()和route.abort()来中止请求。

page.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())

# Abort based on the request type
page.route("**/*", lambda route: route.abort() if route.request.resource_type == "image"  else route.continue_())

修改响应​

要修改响应，请使用APIRequestContext获取原始响应，然后将响应传递给route.fulfill()。您可以通过选项覆盖响应中的各个字段：

def handle_route(route: Route) -> None:
    # Fetch original response.
    response = route.fetch()
    # Add a prefix to the title.
    body = response.text()
    body = body.replace("<title>", "<title>My prefix:")
    route.fulfill(
        # Pass all fields from the response.
        response=response,
        # Override response body.
        body=body,
        # Force content type to be html.
        headers={**response.headers, "content-type": "text/html"},
    )

page.route("**/title.html", handle_route)

全局URL模式​

Playwright在网络拦截方法如page.route()或page.expect_response()中使用简化的通配符模式进行URL匹配。这些模式支持基本通配符：

  1. Asterisks:
    • 单个 * 匹配除 / 外的任何字符
    • 双星号 ** 可以匹配包括 / 在内的任何字符
  2. 问号 ? 匹配除 / 外的任意单个字符
  3. 大括号 {} 可用于匹配由逗号 , 分隔的选项列表
  4. 方括号 [] 可用于匹配一组字符
  5. 反斜杠 \ 可用于转义任何特殊字符（注意反斜杠本身需要用 \\ 转义）

示例：

  • https://example.com/*.js 匹配 https://example.com/file.js 但不匹配 https://example.com/path/file.js
  • https://example.com/\\?page=1 匹配 https://example.com/?page=1 但不匹配 https://example.com
  • **/v[0-9]* 匹配 https://example.com/v1/ 但不匹配 https://example.com/vote/
  • **/*.js 匹配 https://example.com/file.js 和 https://example.com/path/file.js
  • **/*.{png,jpg,jpeg} 匹配所有图片请求

重要说明：

  • glob模式必须匹配整个URL，而不仅仅是其中的一部分。
  • 在使用通配符进行URL匹配时，请考虑完整的URL结构，包括协议和路径分隔符。
  • 对于更复杂的匹配需求，考虑使用[RegExp]替代glob模式。

WebSockets​

Playwright 支持开箱即用的WebSockets检查、模拟和修改。请参阅我们的API mocking guide了解如何模拟WebSockets。

每次创建WebSocket时，都会触发page.on("websocket")事件。该事件包含WebSocket实例，用于进一步检查WebSocket帧：

def on_web_socket(ws):
    print(f"WebSocket opened: {ws.url}")
    ws.on("framesent", lambda payload: print(payload))
    ws.on("framereceived", lambda payload: print(payload))
    ws.on("close", lambda payload: print("WebSocket closed"))

page.on("websocket", on_web_socket)

缺失的网络事件与服务工作者​

Playwright内置的browser_context.route()和page.route()允许您的测试原生地路由请求并执行模拟和拦截。

  1. 如果您正在使用Playwright的原生browser_context.route()和page.route()，并且发现网络事件似乎缺失，可以通过将service_workers设置为'block'来禁用Service Workers。
  2. 可能是您正在使用像Mock Service Worker (MSW)这样的模拟工具。虽然该工具开箱即用可以模拟响应，但它会添加自己的Service Worker来接管网络请求，从而使这些请求对browser_context.route()和page.route()不可见。如果您同时对网络测试和模拟感兴趣，可以考虑使用内置的browser_context.route()和page.route()进行response mocking。
  3. 如果您不仅对使用Service Workers进行测试和网络模拟感兴趣，还想了解如何路由和监听由Service Workers自身发出的请求，请参阅此实验性功能。