如何避免 Selenium 中的“StaleElementReferenceException”？

Question

我正在使用 Java 实现很多 Selenium 测试 - 有时，我的测试由于 StaleElementReferenceException 而失败。

您能否提出一些使测试更稳定的方法？

Answer 1

如果页面上发生的 DOM 操作暂时导致元素不可访问，则可能会发生这种情况。为了应对这些情况，您可以尝试在循环中多次访问该元素，然后最终引发异常。

试试this excellent solution from darrelgrainger.blogspot.com:

public boolean retryingFindClick(By by) {
    boolean result = false;
    int attempts = 0;
    while(attempts < 2) {
        try {
            driver.findElement(by).click();
            result = true;
            break;
        } catch(StaleElementException e) {
        }
        attempts++;
    }
    return result;
}

Answer 2

我间歇性地遇到这个问题。我不知道，BackboneJS 正在页面上运行并替换我试图单击的元素。我的代码看起来像这样。

driver.findElement(By.id("checkoutLink")).click();

当然功能和这个是一样的。

WebElement checkoutLink = driver.findElement(By.id("checkoutLink"));
checkoutLink.click();

偶尔会发生的情况是 javascript 会在查找和点击之间替换 checkoutLink 元素，即。

WebElement checkoutLink = driver.findElement(By.id("checkoutLink"));
// javascript replaces checkoutLink
checkoutLink.click();

这在尝试单击链接时正确地导致了 StaleElementReferenceException。我找不到任何可靠的方法来告诉 WebDriver 等到 javascript 完成运行，所以这就是我最终解决它的方法。

new WebDriverWait(driver, timeout)
    .ignoring(StaleElementReferenceException.class)
    .until(new Predicate<WebDriver>() {
        @Override
        public boolean apply(@Nullable WebDriver driver) {
            driver.findElement(By.id("checkoutLink")).click();
            return true;
        }
    });

此代码将不断尝试单击链接，忽略 StaleElementReferenceExceptions，直到单击成功或达到超时。我喜欢这个解决方案，因为它省去了您编写任何重试逻辑的麻烦，并且只使用了 WebDriver 的内置结构。

Answer 3

Kenny 的解决方案很好，但是可以用更优雅的方式编写

new WebDriverWait(driver, timeout)
        .ignoring(StaleElementReferenceException.class)
        .until((WebDriver d) -> {
            d.findElement(By.id("checkoutLink")).click();
            return true;
        });

也可以：

new WebDriverWait(driver, timeout).ignoring(StaleElementReferenceException.class).until(ExpectedConditions.elementToBeClickable(By.id("checkoutLink")));
driver.findElement(By.id("checkoutLink")).click();

但无论如何，最好的解决方案是依赖 Selenide 库，它可以处理这类事情等等。 （它处理代理而不是元素引用，因此您永远不必处理陈旧的元素，这可能非常困难）。 Selenide

Answer 4

这通常是由于 DOM 正在更新并且您尝试访问更新/新元素 - 但 DOM 已刷新，因此您拥有的引用无效..

首先对元素使用显式等待以确保更新完成，然后再次获取对该元素的新引用来解决此问题。

这里有一些伪代码来说明（改编自我用于EXACTLY这个问题的一些C#代码）：

WebDriverWait wait = new WebDriverWait(browser, TimeSpan.FromSeconds(10));
IWebElement aRow = browser.FindElement(By.XPath(SOME XPATH HERE);
IWebElement editLink = aRow.FindElement(By.LinkText("Edit"));

//this Click causes an AJAX call
editLink.Click();

//must first wait for the call to complete
wait.Until(ExpectedConditions.ElementExists(By.XPath(SOME XPATH HERE));

//you've lost the reference to the row; you must grab it again.
aRow = browser.FindElement(By.XPath(SOME XPATH HERE);

//now proceed with asserts or other actions.

希望这会有所帮助！

Answer 5

StaleElementReferenceException 出现的原因已经说明：在查找和处理元素之间更新 DOM。

对于点击问题，我最近使用了这样的解决方案：

public void clickOn(By locator, WebDriver driver, int timeout)
{
    final WebDriverWait wait = new WebDriverWait(driver, timeout);
    wait.until(ExpectedConditions.refreshed(
        ExpectedConditions.elementToBeClickable(locator)));
    driver.findElement(locator).click();
}

关键部分是 Selenium 自己的 ExpectedConditions 通过 ExpectedConditions.refreshed() 的“链接”。这实际上会等待并检查相关元素是否在指定的超时期间被刷新，另外还等待元素变为可点击。

看看documentation for the refreshed method。

Answer 6

在我的项目中，我引入了 StableWebElement 的概念。它是 WebElement 的包装器，能够检测元素是否过时并找到对原始元素的新引用。我添加了一个辅助方法来定位返回 StableWebElement 而不是 WebElement 的元素，并且 StaleElementReference 的问题消失了。

public static IStableWebElement FindStableElement(this ISearchContext context, By by)
{
    var element = context.FindElement(by);
    return new StableWebElement(context, element, by, SearchApproachType.First);
} 

C# 中的代码可在我的项目页面上找到，但它可以很容易地移植到 java https://github.com/cezarypiatek/Tellurium/blob/master/Src/MvcPages/SeleniumUtils/StableWebElement.cs

Answer 7

C# 中的解决方案是：

助手类：

internal class DriverHelper
{

    private IWebDriver Driver { get; set; }
    private WebDriverWait Wait { get; set; }

    public DriverHelper(string driverUrl, int timeoutInSeconds)
    {
        Driver = new ChromeDriver();
        Driver.Url = driverUrl;
        Wait = new WebDriverWait(Driver, TimeSpan.FromSeconds(timeoutInSeconds));
    }

    internal bool ClickElement(string cssSelector)
    {
        //Find the element
        IWebElement element = Wait.Until(d=>ExpectedConditions.ElementIsVisible(By.CssSelector(cssSelector)))(Driver);
        return Wait.Until(c => ClickElement(element, cssSelector));
    }

    private bool ClickElement(IWebElement element, string cssSelector)
    {
        try
        {
            //Check if element is still included in the dom
            //If the element has changed a the OpenQA.Selenium.StaleElementReferenceException is thrown.
            bool isDisplayed = element.Displayed;

            element.Click();
            return true;
        }
        catch (StaleElementReferenceException)
        {
            //wait until the element is visible again
            element = Wait.Until(d => ExpectedConditions.ElementIsVisible(By.CssSelector(cssSelector)))(Driver);
            return ClickElement(element, cssSelector);
        }
        catch (Exception)
        {
            return false;
        }
    }
}

调用：

        DriverHelper driverHelper = new DriverHelper("http://www.seleniumhq.org/docs/04_webdriver_advanced.jsp", 10);
        driverHelper.ClickElement("input[value='csharp']:first-child");

同样可以用于Java。

Answer 8

不推荐使用 Kenny 的解决方案，我正在使用操作类双击，但你可以做任何事情。

new FluentWait<>(driver).withTimeout(30, TimeUnit.SECONDS).pollingEvery(5, TimeUnit.SECONDS)
                    .ignoring(StaleElementReferenceException.class)
                    .until(new Function() {

                    @Override
                    public Object apply(Object arg0) {
                        WebElement e = driver.findelement(By.xpath(locatorKey));
                        Actions action = new Actions(driver);
                        action.moveToElement(e).doubleClick().perform();
                        return true;
                    }
                });

Answer 9

我找到了解决方案here。在我的情况下，如果离开当前窗口、选项卡或页面并再次返回，元素将变得不可访问。

.ignoring(StaleElement...)、.refreshed(...) 和 elementToBeClicable(...) 没有帮助，我在act.doubleClick(element).build().perform(); 字符串上遇到异常。

在我的主测试类中使用函数：

openForm(someXpath);

我的 BaseTest 函数：

int defaultTime = 15;

boolean openForm(String myXpath) throws Exception {
    int count = 0;
    boolean clicked = false;
    while (count < 4 || !clicked) {
        try {
            WebElement element = getWebElClickable(myXpath,defaultTime);
            act.doubleClick(element).build().perform();
            clicked = true;
            print("Element have been clicked!");
            break;
        } catch (StaleElementReferenceException sere) {
            sere.toString();
            print("Trying to recover from: "+sere.getMessage());
            count=count+1;
        }
    }

我的 BaseClass 函数：

protected WebElement getWebElClickable(String xpath, int waitSeconds) {
        wait = new WebDriverWait(driver, waitSeconds);
        return wait.ignoring(StaleElementReferenceException.class).until(
                ExpectedConditions.refreshed(ExpectedConditions.elementToBeClickable(By.xpath(xpath))));
    }

Answer 10

干净的findByAndroidId 方法可以优雅地处理StaleElementReference。

这在很大程度上基于jspcal's answer，但我必须修改该答案以使其与我们的设置完美配合，因此我想在此处添加它以防对其他人有所帮助。如果这个答案对你有帮助，请点赞jspcal's answer。

// This loops gracefully handles StateElementReference errors and retries up to 10 times. These can occur when an element, like a modal or notification, is no longer available.
export async function findByAndroidId( id, { assert = wd.asserters.isDisplayed, timeout = 10000, interval = 100 } = {} ) {
  MAX_ATTEMPTS = 10;
  let attempt = 0;

  while( attempt < MAX_ATTEMPTS ) {
    try {
      return await this.waitForElementById( `android:id/${ id }`, assert, timeout, interval );
    }
    catch ( error ) {
      if ( error.message.includes( "StaleElementReference" ) )
        attempt++;
      else
        throw error; // Re-throws the error so the test fails as normal if the assertion fails.
    }
  }
}

Answer 11

试试这个

while (true) { // loops forever until break
    try { // checks code for exceptions
        WebElement ele=
        (WebElement)wait.until(ExpectedConditions.elementToBeClickable((By.xpath(Xpath))));  
        break; // if no exceptions breaks out of loop
    } 
    catch (org.openqa.selenium.StaleElementReferenceException e1) { 
        Thread.sleep(3000); // you can set your value here maybe 2 secs
        continue; // continues to loop if exception is found
    }
}

Answer 12

可能存在导致 StaleElementReferenceException 的潜在问题，迄今为止没有人提及（关于操作）。

我用 Javascript 解释，但在 Java 中是一样的。

这行不通：

let actions = driver.actions({ bridge: true })
let a = await driver.findElement(By.css('#a'))
await actions.click(a).perform() // this leads to a DOM change, #b will be removed and added again to the DOM.
let b = await driver.findElement(By.css('#b'))
await actions.click(b).perform()

但是再次实例化动作会解决它：

let actions = driver.actions({ bridge: true })
let a = await driver.findElement(By.css('#a'))
await actions.click(a).perform()  // this leads to a DOM change, #b will be removed and added again to the DOM.
actions = driver.actions({ bridge: true }) // new
let b = await driver.findElement(By.css('#b'))
await actions.click(b).perform()

Answer 13

通常当我们尝试访问的元素出现时 StaleElementReferenceException 但其他元素可能会影响我们感兴趣的元素的位置，因此当我们尝试单击或 getText 或尝试对 WebElement 执行某些操作时，我们会得到通常表示元素不存在的异常附有 DOM。

我试过的解决方法如下：

 protected void clickOnElement(By by) {
        try {
            waitForElementToBeClickableBy(by).click();
        } catch (StaleElementReferenceException e) {
            for (int attempts = 1; attempts < 100; attempts++) {
                try {
                    waitFor(500);
                    logger.info("Stale element found retrying:" + attempts);
                    waitForElementToBeClickableBy(by).click();
                    break;
                } catch (StaleElementReferenceException e1) {
                    logger.info("Stale element found retrying:" + attempts);
                }
            }
        }

protected WebElement waitForElementToBeClickableBy(By by) {
        WebDriverWait wait = new WebDriverWait(getDriver(), 10);
        return wait.until(ExpectedConditions.elementToBeClickable(by));
    }

在上面的代码中，我首先尝试等待，然后在发生异常时单击元素，然后我捕获它并尝试循环它，因为可能仍然无法加载所有元素，并且可能再次发生异常。

Answer 14

这适用于我使用 C#

public Boolean RetryingFindClick(IWebElement webElement)
    {
        Boolean result = false;
        int attempts = 0;
        while (attempts < 2)
        {
            try
            {
                webElement.Click();
                result = true;
                break;
            }
            catch (StaleElementReferenceException e)
            {
                Logging.Text(e.Message);
            }
            attempts++;
        }
        return result;
    }

Answer 15

问题在于，当您将元素从 Javascript 传递到 Java 时，它可能已经离开了 DOM。
尝试用 Javascript 做所有事情：

driver.executeScript("document.querySelector('#my_id')?.click()") 

Answer 16

也许它是最近添加的，但其他答案没有提到 Selenium 的隐式等待功能，它为您完成上述所有操作，并且内置于 Selenium 中。

driver.manage().timeouts().implicitlyWait(10,TimeUnit.SECONDS);

这将重试 findElement() 调用，直到找到该元素，或持续 10 秒。

来源 - http://www.seleniumhq.org/docs/04_webdriver_advanced.jsp