显式等待高级使用
同学们大家好,这节课我们来学习一下有关于 Web 自动化测试中,显示等待的高级使用方式。
简介
在 Web 自动化测试中,显式等待机制是一种关键的技术,用于等待特定的条件在页面加载、元素渲染或页面跳转等过程中为真(满足条件)后再执行后续操作,以确保测试脚本的可靠性和稳定性。
显示等待通过不断轮询等待条件,定期检查条件是否满足,以及设置最大等待时间来实现等待页面元素或事件的机制。这样可以确保测试脚本在页面加载或异步操作完成后再进行交互。语法示例如下:
在 Web 自动化测试中,显式等待是一项非常重要的技术,用来确保脚本在页面加载、元素渲染或特定事件发生后才继续执行。它通过轮询方式定期检查条件是否满足,并设置一个最大等待时间,以提高测试脚本的可靠性和稳定性。简单来说,显式等待就像是在告诉脚本:‘等等,等这个按钮出现了再点击’或者‘等页面加载完了再检查结果’,从而避免由于网络延迟或页面响应慢导致的测试失败。接下来,我们通过一个示例来看看显式等待是怎么用的。
Python 版本
WebDriverWait(driver实例,最长等待时间,轮询时间).until(结束条件函数)
写法如下所示,在Python中,我们可以使用 WebDriverWait 类,搭配一个结束条件函数来实现,driver实例是WebDriver的实例,最长等待时间是等待的最长时间,单位是秒,轮询时间是每次检查条件时的间隔时间,默认为0.5秒,结束条件函数是等待的条件函数。这个方法非常的灵活,可以在结束条件函数中选择多种条件函数,比如元素是否可见、元素是否可点击、元素是否存在等。
Java 版本
WebDriverWait WebDriverWait(driver实例,最长等待时间,轮询时间).until(结束条件函数)
Java版本写法与Python略有不同,如下所示。
显式等待的关键概念
- 最长等待时间(Timeout):指在等待过程中所允许的最大等待时间,通常以秒为单位,如果最长等待时间内条件不满足,等待操作将被中断并引发
TimeoutException
异常。
- 轮询时间:轮询时间是指在等待过程中,等待器会周期性地检查条件是否满足的时间间隔。它用于反复检查条件函数,以确保等待器能够及时响应。
显式等待的核心在于两个重要的概念:第一个,最长等待时间,这是等待器允许的最大时间长度,以秒为单位。它定义了等待某个条件满足的最大时限。如果超时了,条件仍未满足,程序会抛出一个 TimeoutException,提示等待失败。这有助于避免无限制的等待。第二个,轮询时间,这是等待器周期性检查条件的时间间隔。它就像在不断地问页面:‘好了没?好了没?’直到条件满足或者超过最长等待时间为止。轮询时间的设置可以让等待器既能及时响应,又不会过于频繁地占用资源。所以显式等待的这两项设置结合起来,就可以让我们的脚本既稳定又高效,不会因为页面加载的延迟而出错,也不会浪费不必要的时间。
- WebDriverWait 类:在
Selenium
中,WebDriverWait
是用于实现显式等待的类。它需要传递WebDriver
实例、最长等待时间和轮询时间作为参数,并提供了until
方法来等待特定条件的出现。
- 结束条件函数:结束条件函数是用于检查特定条件是否满足的函数。它通常使用
expected_conditions
模块中的方法来定义,如等待元素可见、元素可被选中等。当结束条件函数返回True
时,等待结束。
在 Selenium 中实现显式等待的关键工具有两个,第一个,WebDriverWait 类:这是 Selenium 提供的显式等待工具类。使用它时,需要传入三个参数:WebDriver 实例、最长等待时间以及轮询时间。它的核心方法是 until,用于让脚本等待直到某个特定条件被满足,比如元素加载完成、按钮变为可点击等。第二个就是结束条件函数,这是等待器用来判断条件是否满足的核心逻辑。通常借助 expected_conditions,我们通常写成 大写的EC,然后使用模块中的方法,比如 等待元素可见方法,visibility of element located,或者等待元素可被点击方法, element to be clickable。一旦这个结束条件返回 True,等待器就会结束等待,继续执行后续脚本。这两个工具搭配起来使用,便可以帮助我们精准地控制脚本的执行时机,让测试更稳定。这就是我们在 web 自动化中最常会用到的等待方式了。
显示等待-expected_conditions
- Selenium 显式等待官网说明
- Selenium 官网提供了显式等待详细说明文档,其中包括了各种内置的等待条件函数及其使用方法。在编写测试用例时,根据实际需要选择合适的等待条件函数。
- 演示网站: https://vip.ceshiren.com/#/ui_study
ui_study
是一个 Web 自动化练习网站,在这个网站可以模拟各种前端应用场景,使用Selenium
来自动化测试网页的各种功能和交互效果。下面代码将使用此网站来演示显式等待的使用。
接着,我们来看下 expected conditions 这个模块,它为 Selenium 的显式等待提供了强大的内置条件函数。你可以通过官方文档快速找到适合你测试场景的条件函数,比如等待某个元素是否可点击、是否可见等,这些函数让你的测试逻辑更加灵活且高效。然后,学社为大家提供了一个用来做 web 自动化练习的网站,叫做 ui study,它提供了一个非常好的练习环境,模拟了各种常见的前端场景,让我们可以轻松上手显式等待的使用。接下来,我们将结合这个网站的实例,逐步讲解如何通过显式等待实现对动态页面的精准操作。
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()
那么我们的基础练习如下代码所示,先来看一下 Python 版本,大家可以先看下代码中的逻辑,看下它都做了些什么。
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
,表示元素可以被点击。
接下来是 Java 版本的代码。Java 版本的显式等待语法和 Python 类似,同样非常易于阅读和维护。主要就是利用 WebDriverWait 配合 expected conditions 模块来实现显式等待。在这个示例中,我们打开了 ui study 页面,然后使用 WebDriverWait 等待页面上 ID 为 success btn 的按钮变为可点击状态,接着通过找到这个按钮并点击。不管是Python还是Java,这里的关键都是 element to be clickable这个方法,它检查的条件是元素是否可见且可以被点击。如果在设定的 10 秒内条件达成,脚本会继续执行,否则会抛出超时异常。
常见 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() | 针对于弹窗 |
我们再来看一下一些针对不同的场景的 expected conditions,我们可以选择合适的等待条件。这里总结了几种典型类型,第一种Element 类型类似于element to be clickable和visibility of element located,都是针对于元素,主要呢,就是用来判断元素是否可见、是否可点击,或者判断元素是否已渲染到页面上。第二种是URL 类型,比如url contains,它就是用于判断当前页面的 URL 是否包含指定的字符串,非常适合在页面跳转后验证 URL 是否正确。第三种是Title 类型,比如title is,通常用于判断页面标题是否符合预期,常用于验证页面加载是否成功的情景。第四种是Frame 类型,比如frame to be available and switch to it,它的用法是判断页面中是否存在指定的 frame,并切换到该 frame,适合处理页面中嵌套的 iframe。第五种是Alert 类型,比如alert is present,用于判断是否存在弹窗,通常用于处理系统提示或者确认弹窗。这些方法极大地提升了测试的灵活性和稳定性,我们可以根据实际场景灵活地组合使用这些方法,尽可能的减少使用强制等待而造成的浪费时间。
在 Selenium 中,expected_conditions
是一组用于 WebDriverWait
的预定义条件。这些条件用于等待直到满足特定条件后再执行下一步。下面是一些常见的 expected_conditions
:
element_to_be_clickable()
:判断元素是否存在且可见,以及是否可以被单击。如果元素存在但不可见或不可单击,该条件将一直等待直到元素可见并且可以被单击。visibility_of_element_located()
:判断元素是否存在且可见。如果元素存在但不可见,该条件将一直等待直到元素可见。url_contains()
:判断当前页面 URL 是否包含指定的字符串。如果 URL 不包含指定的字符串,该条件将一直等待直到 URL 包含指定的字符串。
在 selenium 中,expected conditions 给我们内置了非常多的函数,我们可以根据具体的测试需求创建灵活和可控的等待条件,以满足不同场景下的自动化测试需求。大家可以看一下屏幕中给大家举例出来的一部分方法,以及他们对应的使用场景。
title_is()
:判断当前页面标题是否与指定的字符串完全匹配。如果标题与指定的字符串不匹配,该条件将一直等待直到标题匹配指定的字符串。frame_to_be_available_and_switch_to_it()
:判断指定的 frame 是否可用并切换到它。如果 frame 不可用,该条件将一直等待直到 frame 可用并且已经切换到该 frame。alert_is_present()
:判断是否存在弹窗。如果不存在弹窗,该条件将一直等待直到存在弹窗。
这些条件可以根据实际情况进行组合使用,来实现更复杂的等待需求。
当然这些条件也是支持组合使用的,组合使用就可以实现更复杂的等待逻辑,比如等待页面标题符合预期的同时,某个元素也变为可点击的状态,那么我们就可以完成很多复杂场景的测试任务,比如异步加载的问题等等。
显示等待-封装等待条件
官方的 excepted_conditions
不可能覆盖所有场景,封装自定义的等待条件是非常有价值的,它可以根据具体的测试需求创建灵活和可控的等待条件,以满足不同场景下的自动化测试需求。
虽然官方 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)
下面我们来看一个示例代码,这个例子展示了一个简单的自定义显示等待封装,我们先初始化了一个 Chrome 浏览器实例,设置隐式等待为五秒,并打开演示网站,在 test webdriver wait 方法中,我们尝试解决按钮需要多次点击才能生效的问题,比如企业微信添加成员的这个场景,就会出现这个问题,我们为此封装了一个 muliti click 函数,这个函数接收两个参数,分别是按钮定位和目标元素定位,内部通过点击按钮并检查目标元素是否存在来实现循环等待,如果条件满足就结束等待,否则在最大等待时间内继续尝试,最后用 WebDriverWait 调用这个自定义方法,让浏览器在十秒内不断点击按钮直到目标弹框出现,这种封装方法非常适合处理复杂交互场景,提高了测试的灵活性和稳定性。
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();
}
}
下面我们来看一下同样功能的 Java 实现。你会发现核心逻辑和 Python 是类似的,都是通过显式等待来动态检查某个条件是否满足。比如这里,我们需要点击一个按钮多次,直到出现目标弹框。在 Java 中,我们引入了 Selenium 的 ExpectedConditions 工具类,这让我们可以直接调用现成的方法,比如判断元素是否可点击或是否存在。相比 Python 的 muliti click 自定义函数,Java 更偏向于通过库函数实现逻辑。这种方式虽然少了一些灵活性,但代码更结构化。总体来说,Python 适合快速开发和灵活封装,而 Java 更强调代码的规范化和可维护性。
总结
显式等待是一个可定制的,针对特定元素对象的等待轮询,其等待结束的条件可以使用已有封装的 ExpectedCondition,也可以自定义等待条件来应对复杂的需求。
那么今天关于显式等待的高级使用就到这里了,接下来我们来一起回顾一下学到的内容吧。首先,我们了解了显式等待的基本概念和作用,接着,通过一些简单示例,掌握了如何使用它。最后,我们学习了如何自定义和封装显式等待,以应对更复杂的场景。需要记住的是,显式等待是一种非常灵活的机制,能够针对特定元素进行等待,并通过轮询判断条件是否满足。掌握了它,你就能应对自动化测试中各种需要等待的情况。多加练习,显式等待将成为你得心应手的工具。