网络

介绍

Playwright 提供了用于监视和修改浏览器网络流量的 API，包括 HTTP 和 HTTPS。页面执行的任何请求，包括 XHR 和 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")

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

HTTP 代理

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

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

这是一个全局代理的示例

同步
异步

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

browser = await 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"})

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

网络事件

您可以监视所有请求和响应

同步
异步

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)

import asyncio
from playwright.async_api import async_playwright, Playwright

async def run(playwright: Playwright):
    chromium = playwright.chromium
    browser = await chromium.launch()
    page = await 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))
    await page.goto("https://example.com")
    await browser.close()

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())

或者在点击按钮后使用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

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

变体

使用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

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

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

处理请求

同步
异步

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

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

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

变体

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

同步
异步

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

await context.route(
    "**/api/login",
    lambda route: route.fulfill(status=200, body="accept"))
await 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"))

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

# Continue requests as POST.
await 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_())

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

# Abort based on the request type
await 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)

async def handle_route(route: Route) -> None:
    # Fetch original response.
    response = await route.fetch()
    # Add a prefix to the title.
    body = await response.text()
    body = body.replace("<title>", "<title>My prefix:")
    await 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"},
    )

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

Glob URL 模式

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

星号
- 单个的 * 匹配除 / 以外的任意字符
- 双个的 ** 匹配包含 / 在内的任意字符
问号 ? 仅匹配问号 ?。如果您想匹配任意字符，请改用 *。
花括号 {} 可用于匹配由逗号 , 分隔的选项列表
反斜杠 \ 可用于转义任何特殊字符（注意反斜杠本身需要转义为 \\）

示例

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
**/*.js 匹配 https://example.com/file.js 和 https://example.com/path/file.js
**/*.{png,jpg,jpeg} 匹配所有图片请求

重要说明

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

WebSockets

Playwright 支持WebSockets的检查、模拟和修改，开箱即用。请参阅我们的API 模拟指南，了解如何模拟 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)

缺失的网络事件和 Service Workers

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

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

介绍​

模拟 API​

HTTP 身份验证​

HTTP 代理​

网络事件​

变体​

处理请求​

变体​

修改请求​

中断请求​

修改响应​

Glob URL 模式​

WebSockets​

缺失的网络事件和 Service Workers​

介绍