自动化测试 / 系统课时

等待指定响应

等待指定响应

页面操作经常会异步发送接口请求。若在请求完成前断言,或点击后才开始监听,都可能导致测试失败。本课使用不依赖外部服务的示例,完成注册等待、触发请求、校验响应和运行验证。

学习目标

  • 理解接口响应等待的适用场景。
  • 掌握 page.waitForResponse() 的匹配条件和调用时机。
  • 验证目标接口的状态码与返回数据,并处理超时。

为什么需要等待响应

页面操作和接口返回通常是异步过程。如果直接读取依赖接口的页面内容,可能出现请求未完成导致断言失败的问题。page.waitForResponse() 用来等待符合条件的网络响应;它本身不会发起请求,也不保证页面已经渲染完成。

必须先创建等待 Promise,再执行触发请求的点击操作。否则响应返回得太快时,测试可能错过该响应并一直等待到超时。

注册响应监听、触发请求与断言的时序

使用 waitForResponse

下面用 page.route() 模拟测试页面与 /api/user 响应,因此不需要启动后端。将代码保存为 tests/wait-response.spec.js,并在已安装 @playwright/test 和浏览器的项目中执行。代码先注册响应等待,再点击按钮触发 fetch。

js
const { test, expect } = require('@playwright/test');

test('wait response', async ({ page }) => {
  // 模拟网页和接口,避免依赖外部站点。
  await page.route('https://app.example.test/', route => route.fulfill({
    contentType: 'text/html',
    body: `<button onclick="fetch('/api/user')">加载用户</button>`
  }));
  await page.route('https://app.example.test/api/user', route => route.fulfill({
    status: 200,
    contentType: 'application/json',
    body: JSON.stringify({ name: 'Ada' })
  }));

  await page.goto('https://app.example.test/');
  // 先注册监听,再触发按钮对应的网络请求。
  const responsePromise = page.waitForResponse(
    resp => resp.url() === 'https://app.example.test/api/user' &&
      resp.request().method() === 'GET',
    { timeout: 5000 }
  );
  await page.getByRole('button', { name: '加载用户' }).click();
  const response = await responsePromise;
  const user = await response.json();

  expect(response.status()).toBe(200);
  expect(user).toEqual({ name: 'Ada' });
  console.log(`状态: ${response.status()}, 用户: ${user.name}`);
});

运行与验证

在项目根目录执行下列命令:

bash
npx playwright test tests/wait-response.spec.js

预期输出包含以下日志,并显示测试通过:

text
状态: 200, 用户: Ada

通过的测试数量与耗时由 playwright.config.js 中启用的浏览器项目决定。这里的日志来自断言完成后的 console.log,不是 Playwright 自动打印的接口内容。

等待条件设计

真实项目应结合完整 URL 或稳定的路径、请求方法筛选目标响应,不要只用 /api/ 这类宽泛条件。示例将 GET 和精确 URL 作为匹配条件,之后再断言状态码;这样接口即使返回 500,也能立即暴露为断言失败,而非因为状态码不匹配导致等待超时。

timeout: 5000 表示最多等待 5 秒;若请求未被触发或 URL 不匹配,将抛出超时错误。排查时先确认监听注册在动作之前,再核对浏览器实际发出的 URL 和方法。若后续要验证页面文字,还应独立使用 await expect(locator).toHaveText(...) 等自动重试断言,不能将收到响应等同于页面渲染完成。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

等待指定响应

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通