跳到主要内容

浏览器

介绍​

每个版本的 Playwright 都需要特定版本的浏览器二进制文件才能运行。你需要使用 Playwright CLI 来安装这些浏览器。

每次发布新版本，Playwright 都会更新其支持的浏览器版本，以确保最新的 Playwright 能够随时支持最新的浏览器。这意味着每次更新 Playwright 时，你可能都需要重新运行 install CLI 命令。

安装浏览器​

Playwright 可以安装受支持的浏览器。不带参数运行命令将安装默认浏览器。

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install"

你还可以通过提供参数来安装特定浏览器

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install webkit"

查看所有支持的浏览器

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --help"

安装系统依赖项​

系统依赖项可以自动安装。这对于 CI 环境非常有用。

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install-deps"

你还可以通过将其作为参数传递来安装单个浏览器的依赖项

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install-deps chromium"

还可以将 install-deps 与 install 结合使用，以便通过一个命令安装浏览器和 OS 依赖项。

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps chromium"

请参阅系统要求以了解官方支持的操作系统。

配置浏览器​

Playwright 可以在 Chromium、WebKit 和 Firefox 浏览器以及品牌浏览器（如 Google Chrome 和 Microsoft Edge）上运行测试。它还可以在模拟的平板电脑和移动设备上运行。请参阅设备参数注册表，以获取选定桌面、平板电脑和移动设备的完整列表。

在不同浏览器上运行测试​

在特定浏览器上运行测试

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      // Launch chromium, firefox or webkit.
      Browser browser = playwright.chromium().launch();
      Page page = browser.newPage();
      // ...
    }
  }
}

在多个浏览器上运行测试并使其基于环境变量 BROWSER

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      Browser browser = null;
      String browserName = System.getenv("BROWSER");
      if (browserName.equals("chromium")) {
        browser = playwright.chromium().launch();
      } else if (browserName.equals("firefox")) {
        browser = playwright.firefox().launch();
      } else if (browserName.equals("webkit")) {
        browser = playwright.webkit().launch();
      }
      Page page = browser.newPage();
      // ...
    }
  }
}

Chromium​

对于 Google Chrome、Microsoft Edge 和其他基于 Chromium 的浏览器，Playwright 默认使用开源的 Chromium 构建版本。由于 Chromium 项目领先于品牌浏览器，当世界使用 Google Chrome N 时，Playwright 已支持 Chromium N+1，后者将在几周后在 Google Chrome 和 Microsoft Edge 中发布。

Chromium: 无头 shell​

Playwright 提供用于有头操作的常规 Chromium 构建版本以及用于无头模式的单独chromium 无头 shell。

如果你只在无头 shell 中运行测试（即未指定 channel 选项），例如在 CI 上，你可以通过在安装期间传递 --only-shell 来避免下载完整的 Chromium 浏览器。

# only running tests headlessly
mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps --only-shell"

Chromium: 新无头模式​

你可以使用 'chromium' 渠道选择新的无头模式。正如官方 Chrome 文档所述

另一方面，新的无头模式是真正的 Chrome 浏览器，因此更真实、更可靠，并提供更多功能。这使其更适合高精度端到端 Web 应用程序测试或浏览器扩展测试。

有关详细信息，请参阅issue #33566。

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      Browser browser = playwright.chromium().launch(new BrowserType.LaunchOptions().setChannel("chromium"));
      Page page = browser.newPage();
      // ...
    }
  }
}

使用新的无头模式，你可以在浏览器安装期间使用 --no-shell 选项跳过下载无头 shell。

# only running tests headlessly
mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps --no-shell"

Google Chrome 和 Microsoft Edge​

虽然 Playwright 可以下载和使用最新的 Chromium 构建版本，但它也可以针对机器上可用的品牌 Google Chrome 和 Microsoft Edge 浏览器运行（请注意，Playwright 默认不会安装它们）。特别是，当前版本的 Playwright 将支持这些浏览器的 Stable 和 Beta 渠道。

可用的渠道包括 chrome、msedge、chrome-beta、msedge-beta、chrome-dev、msedge-dev、chrome-canary、msedge-canary。

警告

某些企业浏览器策略可能会影响 Playwright 启动和控制 Google Chrome 和 Microsoft Edge 的能力。在具有浏览器策略的环境中运行超出了 Playwright 项目的范围。

警告

Google Chrome 和 Microsoft Edge 已切换到新的无头模式实现，该实现更接近常规有头模式。这与 Playwright 默认在无头模式下使用的chromium 无头 shell 不同，因此在某些情况下可能会出现不同的行为。有关详细信息，请参阅issue #33566。

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      // Channel can be "chrome", "msedge", "chrome-beta", "msedge-beta" or "msedge-dev".
      Browser browser = playwright.chromium().launch(new BrowserType.LaunchOptions().setChannel("msedge"));
      Page page = browser.newPage();
      // ...
    }
  }
}

安装 Google Chrome 和 Microsoft Edge​

如果你的机器上没有 Google Chrome 或 Microsoft Edge，你可以使用 Playwright 命令行工具安装它们。

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install msedge"
警告

Google Chrome 或 Microsoft Edge 安装将安装在你操作系统的默认全局位置，覆盖你当前的浏览器安装。

运行 --help 选项可查看可安装浏览器的完整列表。

何时使用 Google Chrome 和 Microsoft Edge，何时不使用？​

默认值​

大多数情况下，使用最新的 Chromium 的默认 Playwright 配置是个好主意。由于 Playwright 在浏览器稳定渠道之前，因此可以让你安心，因为即将发布的 Google Chrome 或 Microsoft Edge 版本不会破坏你的站点。你可以在官方 Chrome 更新之前尽早发现损坏并有充足时间修复它。

回归测试​

话虽如此，测试策略通常要求针对当前公开可用的浏览器执行回归测试。在这种情况下，你可以选择其中一个稳定渠道，“chrome” 或 “msedge”。

媒体编解码器​

使用官方二进制文件进行测试的另一个原因是测试与媒体编解码器相关的功能。由于各种许可考虑和协议，Chromium 没有 Google Chrome 或 Microsoft Edge 捆绑的所有编解码器。如果你的站点依赖于此类编解码器（这种情况很少见），你还需要使用官方渠道。

企业策略​

Google Chrome 和 Microsoft Edge 遵守企业策略，其中包括对功能、网络代理和强制性扩展程序的限制，这些限制会妨碍测试。因此，如果你是使用此类策略的组织的一部分，则最简单的方法是使用捆绑的 Chromium 进行本地测试，你仍然可以在通常不受此类限制的机器人上选择稳定渠道。

Firefox​

Playwright 的 Firefox 版本与最新的Firefox Stable 构建版本匹配。Playwright 不适用于品牌版本的 Firefox，因为它依赖于补丁。

请注意，某些功能的可用性（严重依赖底层平台）在不同的操作系统之间可能会有所不同。例如，可用的媒体编解码器在 Linux、macOS 和 Windows 之间差异很大。

WebKit​

Playwright 的 WebKit 派生自最新的 WebKit main 分支源代码，通常早于这些更新被整合到 Apple Safari 和其他基于 WebKit 的浏览器中。这提供了充足的时间来应对潜在的浏览器更新问题。Playwright 不适用于品牌版本的 Safari，因为它依赖于补丁。相反，你可以使用最新的 WebKit 构建版本进行测试。

请注意，某些功能的可用性（严重依赖底层平台）在不同的操作系统之间可能会有所不同。例如，可用的媒体编解码器在 Linux、macOS 和 Windows 之间差异很大。虽然在 Linux CI 上运行 WebKit 通常是最经济实惠的选择，但为了获得最接近 Safari 的体验，你应在 Mac 上运行 WebKit，例如进行视频播放时。

在防火墙或代理后安装​

默认情况下，Playwright 从 Microsoft 的 CDN 下载浏览器。

有时公司会维护一个内部代理，阻止直接访问公共资源。在这种情况下，可以将 Playwright 配置为通过代理服务器下载浏览器。

HTTPS_PROXY=https://192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install"

如果代理请求被自定义的不可信证书颁发机构 (CA) 拦截，并在下载浏览器时出现 Error: self signed certificate in certificate chain 错误，则必须在安装浏览器之前通过 NODE_EXTRA_CA_CERTS 环境变量设置你的自定义根证书。

export NODE_EXTRA_CA_CERTS="/path/to/cert.pem"

如果你的网络连接 Playwright 浏览器存档速度较慢，可以使用 PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT 环境变量增加以毫秒为单位的连接超时时间。

PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install"

如果你正在安装依赖项并且需要在 Linux 上使用代理，请确保以 root 用户身份运行命令。否则，Playwright 将尝试成为 root 用户，并且不会将 HTTPS_PROXY 等环境变量传递给 Linux 包管理器。

sudo HTTPS_PROXY=https://192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install-deps"

从 artifact 仓库下载​

默认情况下，Playwright 从 Microsoft 的 CDN 下载浏览器。

有时公司会维护一个内部 artifact 仓库来托管浏览器二进制文件。在这种情况下，可以使用 PLAYWRIGHT_DOWNLOAD_HOST 环境变量将 Playwright 配置为从自定义位置下载。

PLAYWRIGHT_DOWNLOAD_HOST=http://192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install"

还可以使用 PLAYWRIGHT_CHROMIUM_DOWNLOAD_HOST、PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST 和 PLAYWRIGHT_WEBKIT_DOWNLOAD_HOST 环境变量来使用每个浏览器的下载主机，这些环境变量优先于 PLAYWRIGHT_DOWNLOAD_HOST。

PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=http://203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=http://192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install"

管理浏览器二进制文件​

Playwright 将 Chromium、WebKit 和 Firefox 浏览器下载到特定于操作系统的缓存文件夹中

  • Windows 上的 %USERPROFILE%\AppData\Local\ms-playwright
  • macOS 上的 ~/Library/Caches/ms-playwright
  • Linux 上的 ~/.cache/ms-playwright

安装后，这些浏览器将占用几百兆字节的磁盘空间

du -hs ~/Library/Caches/ms-playwright/*
281M  chromium-XXXXXX
187M  firefox-XXXX
180M  webkit-XXXX

你可以使用环境变量覆盖默认行为。安装 Playwright 时，要求它将浏览器下载到特定位置

PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install"

运行 Playwright 脚本时，要求它在共享位置搜索浏览器。

PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers mvn test

Playwright 会跟踪需要这些浏览器的包，并在你将 Playwright 更新到新版本时对它们进行垃圾回收。

注意

开发人员可以通过在他们的 .bashrc 中导出 PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers 来选择此模式。

跳过浏览器下载​

在某些情况下，希望完全避免浏览器下载，因为浏览器二进制文件是单独管理的。

这可以通过在安装前设置 PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD 变量来完成。

PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 mvn test

过期浏览器删除​

Playwright 会跟踪使用其浏览器的客户端。当不再有客户端需要特定版本的浏览器时，该版本将从系统中删除。这样你就可以安全地使用不同版本的 Playwright 实例，同时又不会浪费磁盘空间来存储不再使用的浏览器。

要退出未使用浏览器删除，你可以设置 PLAYWRIGHT_SKIP_BROWSER_GC=1 环境变量。

卸载浏览器​

这将删除当前 Playwright 安装的浏览器 (chromium, firefox, webkit)。

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="uninstall"

要同时删除其他 Playwright 安装的浏览器，请传递 --all 标志。

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="uninstall --all"