显式等待高级使用

简介

在 Web 自动化测试中，显式等待机制是一种关键的技术，用于等待特定的条件在页面加载、元素渲染或页面跳转等过程中为真（满足条件）后再执行后续操作，以确保测试脚本的可靠性和稳定性。

显示等待通过不断轮询等待条件，定期检查条件是否满足，以及设置最大等待时间来实现等待页面元素或事件的机制。这样可以确保测试脚本在页面加载或异步操作完成后再进行交互。语法示例如下：

Python 版本

WebDriverWait(driver实例，最长等待时间，轮询时间).until(结束条件函数)

Java 版本

WebDriverWait WebDriverWait(driver实例，最长等待时间，轮询时间).until(结束条件函数)

显式等待的关键概念

最长等待时间（Timeout）：指在等待过程中所允许的最大等待时间，通常以秒为单位，如果最长等待时间内条件不满足，等待操作将被中断并引发 TimeoutException 异常。

轮询时间：轮询时间是指在等待过程中，等待器会周期性地检查条件是否满足的时间间隔。它用于反复检查条件函数，以确保等待器能够及时响应。

WebDriverWait 类：在 Selenium 中，WebDriverWait 是用于实现显式等待的类。它需要传递 WebDriver 实例、最长等待时间和轮询时间作为参数，并提供了 until 方法来等待特定条件的出现。

结束条件函数：结束条件函数是用于检查特定条件是否满足的函数。它通常使用 expected_conditions 模块中的方法来定义，如等待元素可见、元素可被选中等。当结束条件函数返回 True 时，等待结束。

显示等待-expected_conditions

Selenium 显式等待官网说明
- Selenium 官网提供了显式等待详细说明文档，其中包括了各种内置的等待条件函数及其使用方法。在编写测试用例时，根据实际需要选择合适的等待条件函数。
演示网站: https://vip.ceshiren.com/#/ui_study
- ui_study 是一个 Web 自动化练习网站，在这个网站可以模拟各种前端应用场景，使用 Selenium 来自动化测试网页的各种功能和交互效果。下面代码将使用此网站来演示显式等待的使用。

Pyhton 版本

from selenium import webdriver
from selenium.webdriver.common.by import By
from selenium.webdriver.support import expected_conditions
from selenium.webdriver.support.wait import WebDriverWait


def wait_until():
    driver = webdriver.Chrome()
    driver.get("https://vip.ceshiren.com/#/ui_study")
    WebDriverWait(driver, 10).until(
        expected_conditions.element_to_be_clickable(
            (By.CSS_SELECTOR, '#success_btn')))
    driver.find_element(By.CSS_SELECTOR, "#success_btn").click()

Java 版本

driver.get("https://vip.ceshiren.com/#/ui_study");
WebDriverWait wait = new WebDriverWait(driver, Duration.ofSeconds(10));
//等待元素可以被点击，并且获取这个元素
WebElement element = wait.until(ExpectedConditions.elementToBeClickable(By.cssSelector("#success_btn")));

以上代码展示了一个等待元素可被点击的示例。在 WebDriverWait 中，传入了 driver 实例以及最长等待时间，然后调用 until 方法，并传入期望条件函数 element_to_be_clickable，表示元素可以被点击。

常见 expected_conditions

类型	示例方法	说明
element	element_to_be_clickable()
visibility_of_element_located()	针对于元素，比如判断元素是否可以点击，或者元素是否可见
url	url_contains()	针对于 url
title	title_is()	针对于标题
frame	frame_to_be_available_and_switch_to_it(locator)	针对于 frame
alert	alert_is_present()	针对于弹窗

在 Selenium 中，expected_conditions 是一组用于 WebDriverWait 的预定义条件。这些条件用于等待直到满足特定条件后再执行下一步。下面是一些常见的 expected_conditions：

element_to_be_clickable()：判断元素是否存在且可见，以及是否可以被单击。如果元素存在但不可见或不可单击，该条件将一直等待直到元素可见并且可以被单击。
visibility_of_element_located()：判断元素是否存在且可见。如果元素存在但不可见，该条件将一直等待直到元素可见。
url_contains()：判断当前页面 URL 是否包含指定的字符串。如果 URL 不包含指定的字符串，该条件将一直等待直到 URL 包含指定的字符串。
title_is()：判断当前页面标题是否与指定的字符串完全匹配。如果标题与指定的字符串不匹配，该条件将一直等待直到标题匹配指定的字符串。
frame_to_be_available_and_switch_to_it()：判断指定的 frame 是否可用并切换到它。如果 frame 不可用，该条件将一直等待直到 frame 可用并且已经切换到该 frame。
alert_is_present()：判断是否存在弹窗。如果不存在弹窗，该条件将一直等待直到存在弹窗。

这些条件可以根据实际情况进行组合使用，来实现更复杂的等待需求。

显示等待-封装等待条件

官方的 excepted_conditions 不可能覆盖所有场景，封装自定义的等待条件是非常有价值的，它可以根据具体的测试需求创建灵活和可控的等待条件，以满足不同场景下的自动化测试需求。

Python 实现

import time
from selenium import webdriver
from selenium.webdriver.common.by import By
from selenium.webdriver.remote.webdriver import WebDriver
from selenium.webdriver.support.wait import WebDriverWait


class TestWebdriverWait:

    driver = webdriver.Chrome()

    driver.maximize_window()
    driver.implicitly_wait(5)
    driver.get("https://vip.ceshiren.com/#/ui_study")
    def teardown(self):
        self.driver.quit()
    def test_webdriver_wait(self):
        # 解决的问题：有的按钮点击一次没有反应，可能要点击多次，比如企业微信的添加成员
        # 解决的方案：一直点击按钮，直到下个页面出现，封装成显式等待的一个条件
        def muliti_click(button_element,until_ele):
            # 函数封装
            def inner(driver):
                # 封装点击方法
                driver.find_element(By.XPATH,button_element).click()
                return driver.find_element(By.XPATH,until_ele)
            return inner
        time.sleep(5)
        # 在限制时间内会一直点击按钮，直到展示弹框
        WebDriverWait(self.driver,10).until(muliti_click("//*[text()='点击两次响应']","//*[text()='该弹框点击两次后才会弹出']"))
        time.sleep(5)

Java 实现

public class TestWebdriverWait {
    public static void main(String[] args) throws InterruptedException {
        WebDriver driver = new ChromeDriver();
        driver.manage().window().maximize();
        driver.get("https://vip.ceshiren.com/#/ui_study");

        // 定义一个点击多次直到条件满足的函数
        WebElement element = driver.findElement(By.xpath("//*[text()='点击两次响应']"));
        WebDriverWait wait = new WebDriverWait(driver, 10);
        wait.until(ExpectedConditions.elementToBeClickable(element));
        element.click();
        wait.until(ExpectedConditions.presenceOfElementLocated(By.xpath("//*[text()='该弹框点击两次后才会弹出']")));

        driver.quit();
    }
}

总结

显式等待是一个可定制的，针对特定元素对象的等待轮询，其等待结束的条件可以使用已有封装的 ExpectedCondition，也可以自定义等待条件来应对复杂的需求。