Android

Playwright 具有 实验性 的 Android 自动化支持。这包括 Android 版 Chrome 和 Android WebView。

要求

Android 设备或 AVD 模拟器。
ADB 守护程序正在运行并已通过设备验证。通常运行 adb devices 即可。
Chrome 87 或更高版本已安装在设备上
在 chrome://flags 中启用“在非 root 设备上启用命令行”。

已知限制

尚不支持原始 USB 操作，因此您需要 ADB。
设备需要处于唤醒状态才能生成屏幕截图。启用“保持唤醒状态”开发者模式将有所帮助。
我们没有针对设备运行所有测试，因此并非所有功能都有效。

如何运行

Android 自动化脚本的示例为

const { _android: android } = require('playwright');

(async () => {
  // Connect to the device.
  const [device] = await android.devices();
  console.log(`Model: ${device.model()}`);
  console.log(`Serial: ${device.serial()}`);
  // Take screenshot of the whole device.
  await device.screenshot({ path: 'device.png' });

  {
    // --------------------- WebView -----------------------

    // Launch an application with WebView.
    await device.shell('am force-stop org.chromium.webview_shell');
    await device.shell('am start org.chromium.webview_shell/.WebViewBrowserActivity');
    // Get the WebView.
    const webview = await device.webView({ pkg: 'org.chromium.webview_shell' });

    // Fill the input box.
    await device.fill({
      res: 'org.chromium.webview_shell:id/url_field',
    }, 'github.com/microsoft/playwright');
    await device.press({
      res: 'org.chromium.webview_shell:id/url_field',
    }, 'Enter');

    // Work with WebView's page as usual.
    const page = await webview.page();
    await page.waitForNavigation({ url: /.*microsoft\/playwright.*/ });
    console.log(await page.title());
  }

  {
    // --------------------- Browser -----------------------

    // Launch Chrome browser.
    await device.shell('am force-stop com.android.chrome');
    const context = await device.launchBrowser();

    // Use BrowserContext as usual.
    const page = await context.newPage();
    await page.goto('https://webkit.org/');
    console.log(await page.evaluate(() => window.location.href));
    await page.screenshot({ path: 'page.png' });

    await context.close();
  }

  // Close the device.
  await device.close();
})();

方法

connect

添加于: v1.28

android.connect

此方法将 Playwright 附加到现有的 Android 设备。使用 android.launchServer() 启动新的 Android 服务器实例。

用法

await android.connect(wsEndpoint);
await android.connect(wsEndpoint, options);

参数

wsEndpoint string #

要连接的浏览器 websocket 端点。
options Object (可选)
- headers Object<string, string> (可选)#
  
  与 web socket 连接请求一起发送的其他 HTTP 标头。可选。
- slowMo number (可选)#
  
  以指定的毫秒数减慢 Playwright 操作的速度。方便您查看正在发生的情况。默认为 0。
- timeout number (可选)#
  
  等待建立连接的最长时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。

返回值

Promise<AndroidDevice>#

devices

添加于: v1.9

android.devices

返回检测到的 Android 设备列表。

用法

await android.devices();
await android.devices(options);

参数

options Object (可选)
- host string (可选)添加于: v1.22#
  
  用于建立 ADB 服务器连接的可选主机。默认为 127.0.0.1。
- omitDriverInstall boolean (可选)添加于: v1.21#
  
  阻止在附加时自动安装 playwright 驱动程序。假设已安装驱动程序。
- port number (可选)添加于: v1.20#
  
  用于建立 ADB 服务器连接的可选端口。默认为 5037。

返回值

Promise<Array<AndroidDevice>>#

launchServer

添加于: v1.28

android.launchServer

启动 Playwright Android 服务器，客户端可以连接到该服务器。请参阅以下示例

用法

服务端

const { _android } = require('playwright');

(async () => {
  const browserServer = await _android.launchServer({
    // If you have multiple devices connected and want to use a specific one.
    // deviceSerialNumber: '<deviceSerialNumber>',
  });
  const wsEndpoint = browserServer.wsEndpoint();
  console.log(wsEndpoint);
})();

客户端

const { _android } = require('playwright');

(async () => {
  const device = await _android.connect('<wsEndpoint>');

  console.log(device.model());
  console.log(device.serial());
  await device.shell('am force-stop com.android.chrome');
  const context = await device.launchBrowser();

  const page = await context.newPage();
  await page.goto('https://webkit.org/');
  console.log(await page.evaluate(() => window.location.href));
  await page.screenshot({ path: 'page-chrome-1.png' });

  await context.close();
})();

参数

options Object (可选)
- adbHost string (可选)#
  
  用于建立 ADB 服务器连接的可选主机。默认为 127.0.0.1。
- adbPort number (可选)#
  
  用于建立 ADB 服务器连接的可选端口。默认为 5037。
- deviceSerialNumber string (可选)#
  
  用于在其上启动浏览器的可选设备序列号。如果未指定，则在连接多个设备时将抛出错误。
- host string (可选)添加于: v1.45#
  
  用于 web socket 的主机。它是可选的，如果省略，则当 IPv6 可用时，服务器将接受未指定的 IPv6 地址 (::) 上的连接，否则接受未指定的 IPv4 地址 (0.0.0.0) 上的连接。考虑通过选择特定接口来加强它。
- omitDriverInstall boolean (可选)#
  
  阻止在附加时自动安装 playwright 驱动程序。假设已安装驱动程序。
- port number (可选)#
  
  用于 web socket 的端口。默认为 0，表示选择任何可用端口。
- wsPath string (可选)#
  
  用于提供 Android 服务器服务的路径。为了安全起见，默认设置为不可猜测的字符串。
  
  警告
  任何知道 wsPath 的进程或网页（包括在 Playwright 中运行的进程或网页）都可以控制 OS 用户。因此，在使用此选项时，应使用不可猜测的令牌。

返回值

Promise<BrowserServer>#

setDefaultTimeout

添加于: v1.9

android.setDefaultTimeout

此设置将更改所有接受 timeout 选项的方法的默认最大时间。

用法

android.setDefaultTimeout(timeout);

参数

timeout number #

最大时间（毫秒）

方法​

connect​

devices​

launchServer​

setDefaultTimeout​

方法

connect

devices

launchServer

setDefaultTimeout