如何使用Java版Selenium调用AGGrid接口导出表格数据到Excel

核心原理 #

Selenium的Java SDK提供了JavascriptExecutor接口，可以直接在当前页面上下文执行JS代码，AGGrid的exportDataAsExcel方法挂载在页面对应的grid实例上，直接通过JS调用即可触发导出。

具体实现步骤 #

• 第一步：先确保页面AGGrid已经渲染完成，gridApi已经初始化完成，避免调用时报undefined错误，可以加显式等待判断grid是否加载完成，比如等待表格的行元素加载完毕。
• 第二步：获取AGGrid的DOM实例，通常AGGrid的挂载节点都会有对应框架的class标识，你可以提前用F12确认你的表格挂载节点的选择器，比如用div.ag-root-wrapper作为通用选择器。
• 第三步：通过JavascriptExecutor执行JS代码，从DOM节点上取gridApi然后调用导出方法，Java代码示例如下：

import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import java.util.concurrent.TimeUnit;

public class AgGridExportDemo {
    public static void main(String[] args) {
        WebDriver driver = new ChromeDriver();
        driver.manage().timeouts().implicitlyWait(10, TimeUnit.SECONDS);
        driver.get("你的应用页面地址");
        
        // 等待grid渲染完成，可根据实际页面调整等待条件
        driver.findElement(By.cssSelector("div.ag-row"));
        
        // 执行JS调用导出API
        JavascriptExecutor js = (JavascriptExecutor) driver;
        js.executeScript("""
            const gridNode = document.querySelector('div.ag-grid-angular');
            // 不同版本AGGrid的api挂载位置可能有差异，可在浏览器控制台先调试确认
            const gridApi = gridNode.__agGridInstance?.api || gridNode.gridOptions?.api;
            if(gridApi) {
                // 可自定义导出参数，比如文件名、是否仅导出选中行等
                gridApi.exportDataAsExcel({
                    fileName: '表格导出数据.xlsx'
                });
            } else {
                throw new Error('未找到gridApi，请检查选择器或grid加载状态');
            }
        """);
    }
}

• 第四步：如果需要验证导出结果，可以提前配置浏览器的固定下载路径，等待对应目录下生成xlsx文件即可。

常见问题排查 #

• 若提示gridApi未定义，先在浏览器控制台手动执行上述JS代码，确认你的AGGrid版本的api挂载位置，部分旧版本AGGrid的api会挂载在gridOptions.api下，打印grid节点属性即可确认。
• 若需要仅导出选中行，调用exportDataAsExcel时传入参数{onlySelected: true}即可。
• 若导出时需要忽略特定列，可以在参数中添加columnKeys: ['要保留的列ID1', '要保留的列ID2']配置。

内容的提问来源于stack exchange，提问作者Vivek Yadav