Appium 客户端Client完全解读客户端-服务器架构、WebDriver 协议与多语言客户端库实战【免费下载链接】appiumCross-platform automation framework for all kinds of apps, built on top of the W3C WebDriver protocol项目地址: https://gitcode.com/GitHub_Trending/ap/appiumAppium 基于 W3C WebDriver 规范实现了客户端-服务器Client-Server架构服务器端由 Appium 本体与其驱动程序、插件组成负责在真实设备上执行自动化客户端则由测试作者驱动负责通过网络向服务器发送命令并接收响应。本指南以 Appium 客户端简介 为核心结合本仓库中appium/base-driver的协议路由源码与sample-code中的多语言示例系统讲解客户端的概念模型、HTTP 协议层工作原理、五种主流语言的客户端用法以及如何挑选和维护合适的客户端库。一、客户端在 Appium 架构中的位置Appium 采用客户端-服务器架构这与它在 Appium 如何工作 中允许从任何编程语言轻松访问统一 API的目标直接相关。两个角色的分工如下服务器端Server由 Appium 本身以及您为自动化任务安装的任何驱动程序Driver和插件Plugin组成。它连接到被测设备模拟器、真机或云设备并实际负责在这些设备上执行自动化。客户端Client由您Appium 测试作者驱动负责通过网络向服务器发送命令并接收来自服务器的响应。这些响应既可以用来判断自动化命令是否成功也可能包含您查询到的应用程序状态信息。也就是说所有困难的部分——如何在一个给定平台上实现自动化——都被收敛在服务器端一次性处理而客户端只需要是瘦的库以适合该语言的方式把对服务器的 HTTP 请求编码出来即可。也正因为这种解耦Appium 服务器与 Appium 客户端不需要运行在同一台机器上只要两者之间存在可用的网络即可这也是云测试提供商得以托管 Appium 服务器、而您只需将客户端脚本指向其安全端点的基础。关于服务器端的更多细节即Appium 究竟如何控制设备请参阅 Appium 驱动程序介绍。二、自动化命令本质上是 HTTP API一个会话中到底有哪些自动化命令可用这取决于您在本次会话中使用的特定驱动程序和插件。一组标准的命令通常包括查找元素Find Element点击元素Click Element获取页面源代码Get Page Source截取屏幕截图Take Screenshot如果您查阅 WebDriver 规范会发现这些命令不是以任何特定编程语言定义的——它们不是 Java 命令、JavaScript 命令或 Python 命令而是一个可以从任何编程语言甚至不用编程语言直接用 cURL访问的 HTTP API。以Find Element查找元素命令为例它对应发送到 HTTP 端点/session/:sessionid/element的POST请求其中:sessionid是服务器在之前Create Session创建会话调用中生成的唯一会话 ID 的占位符。2.1 源码佐证路由定义与必填参数这一端点定义并非空谈在 w3c.ts 路由表 中有完整实现// packages/base-driver/lib/protocol/routes/w3c.ts /session/:sessionId/element: { POST: { command: findElement, payloadParams: {required: [using, value]}, }, },从源码可以看到两个关键事实命令到方法名的映射HTTP 端点/session/:sessionId/element的POST请求被映射到findElement这个命令名最终由驱动程序中同名的方法实现。驱动程序正是通过appium/base-driver中的这套路由表来确定协议命令 ↔ Node.js 方法名的对应关系并声明命令所需参数。必填参数findElement命令要求请求体必须携带using与value两个参数——using指明查找策略例如xpathvalue则是具体的查询表达式。这正是后文示例中find_element(byBy.XPATH, value//*[textFoo])调用形式的协议层根源。同理jsonwp.ts 路由表 中还保留了兼容旧 JSON Wire Protocol 的端点/session/:sessionId/element/:elementId用于按元素 ID 继续操作元素。这些协议层面的知识主要对开发与 WebDriver 规范配套技术例如编写客户端库、调试协议流量的人有用。对于绝大多数编写 Appium/Selenium 测试的开发者来说真正打交道的是下一节介绍的客户端库。三、为什么需要客户端库对普通测试作者而言手动拼写 HTTP 请求毫无吸引力。当您编写 Appium 测试时您希望使用自己熟悉的编程语言。幸运的是存在一组 Appium 客户端库它们承担了与 Appium 服务器进行 HTTP 通信的全部责任同时为特定编程语言暴露一组原生命令——对测试作者来说就像在直接编写 Python、JavaScript 或 Java 代码一样自然。这些库在 Appium 生态中有多种称呼含义完全相同客户端client客户端库client library客户端绑定client binding四、同一命令集在五种语言中的写法以下是使用各语言推荐的 Appium 客户端绑定在五种不同编程语言中实现同一套命令序列的示例。注意这不是包含全部导入语句的可直接运行代码完整的安装与命令参考请查阅各客户端库的文档。 JavaScriptWebdriverIOconst element await driver.$(//*[textFoo]); await element.click(); console.log(await element.getText()) console.log(await driver.getPageSource()) JavaWebElement element driver.findElement(By.Xpath(//*[textFoo])) element.click() System.out.println(element.getText()) System.out.println(driver.getPageSource()) Pythonelement driver.find_element(byBy.XPATH, value//*[textFoo]) element.click() print(element.text) print(driver.page_source) Rubyelement driver.find_element :xpath, //*[textFoo] element.click puts element.text puts driver.page_source C#AppiumElement element driver.FindElement(MobileBy.AccessibilityId(Views)); element.click(); System.Console.WriteLine(element.Text); System.Console.WriteLine(driver.PageSource);4.1 这些脚本在底层做的是同一件事尽管语言不同、API 风格各异上述五个脚本在协议层面完成的工作完全一致调用Find Element查找元素using参数值为xpathvalue参数表达用于查找元素的 XPath 查询表达式例如//*[textFoo]表示查找文本为 Foo 的任意元素。使用上一步返回的元素 ID 调用Click Element点击元素。使用同一元素的 ID 调用Get Element Text获取元素文本并打印到控制台。调用Get Page Source获取页面源代码检索页面/应用源码并打印到控制台。也就是说无论客户端 API 长成什么样子最终都会转化为对 WebDriver HTTP 端点的调用——点击元素对应POST /session/:sessionId/element/:elementId/click获取元素文本对应GET /session/:sessionId/element/:elementId/text这些端点同样定义在 w3c.ts 路由表中。4.2 本仓库中的完整可运行示例上述代码段为了聚焦命令调用而省略了连接建立、能力Capabilities配置等上下文。如果您想看到真正可运行的版本本仓库的 sample-code/quickstarts 提供了 JavaScript、Python、Ruby 三种语言的完整快速入门脚本。以 Python 为例# packages/appium/sample-code/quickstarts/py/test.py import unittest from appium import webdriver from appium.options.android import UiAutomator2Options from appium.webdriver.common.appiumby import AppiumBy capabilities dict( platformNameAndroid, automationNameuiautomator2, deviceNameAndroid, appPackagecom.android.settings, appActivity.Settings, languageen, localeUS ) appium_server_url http://localhost:4723 class TestAppium(unittest.TestCase): def setUp(self) - None: self.driver webdriver.Remote(appium_server_url, optionsUiAutomator2Options().load_capabilities(capabilities)) def tearDown(self) - None: if self.driver: self.driver.quit() def test_find_apps(self) - None: el self.driver.find_element(byAppiumBy.XPATH, value//*[textApps]) el.click()JavaScriptWebdriverIO版本则显式展示了客户端如何定位 Appium 服务器默认连接本机4723端口可通过环境变量覆盖// packages/appium/sample-code/quickstarts/js/test.js const wdOpts { hostname: process.env.APPIUM_HOST || localhost, port: parseInt(process.env.APPIUM_PORT, 10) || 4723, logLevel: info, capabilities, };Ruby 版本使用Appium::Core.for构建核心客户端并start_driver启动会话同样指向http://localhost:4723见 test.rb。各语言的官方快速入门文档还可在仓库中找到例如 test-js、test-py、test-java、test-rb、test-dotnet。五、选择客户端前必须知道的事在挑选或使用某个客户端之前有一个容易忽视却很重要的前提每个客户端都是独立维护的。这带来几个实际影响某个功能在一个客户端中可用并不代表在另一个客户端中也可用——不过所有客户端都至少支持标准的 W3C 协议以及常见的 Appium 扩展命令。某个客户端拥有一套好用的辅助函数另一个客户端不一定有。不同客户端的更新频率差异很大有的维护非常活跃有的则不然。因此选择客户端库时应按优先级考虑两个因素您想使用的编程语言——这是首要考虑因素该库的功能完善程度与维护状况——这决定您能获得多少 Appium 扩展能力、能否及时跟进新版本。5.1 官方客户端一览由 Appium 团队当前维护的官方客户端完整列表见 客户端列表包括客户端语言安装方式仓库文档示例Java ClientJavaMavenio.appium:java-clientscopetest/scopeGradletestImplementation io.appium:java-client:版本号Python ClientPythonpip install Appium-Python-ClientRuby Core ClientRubygem install appium_lib_core推荐Ruby ClientRubygem install appium_lib基于 Ruby Core 的封装含若干辅助方法但可能引入额外复杂度因此官方更推荐 Ruby Core.NET ClientC#dotnet add package Appium.WebDriver此外还有社区维护的其他语言客户端如 WebdriverIO、Nightwatch.js、RobotFramework AppiumLibrary、Rust 的 appium-client、SwiftAppium 等。原则上任何符合 W3C WebDriver 规范的客户端都能与 Appium 良好集成但一些 Appium 特有的命令可能未在其他客户端中实现。六、如何学习使用一个客户端要学习某个 Appium 客户端的具体用法请访问该客户端的主页获取文档。这里有一个常见的认知盲区需要特别留意在许多情况下特定语言的 Appium 客户端是构建在Selenium客户端之上的因此某些 Appium 客户端可能只记录它在 Selenium 客户端基础上新增的功能。这意味着要获得完整的参考您可能需要同时查阅两份文档Appium 客户端文档——了解 Appium 特有的能力移动端定位策略、触摸操作、会话管理等底层 Selenium 客户端文档——了解标准 WebDriver 命令元素查找、等待、页面导航等通用能力。因为 Appium 客户端继承了 Selenium 的技术遗产这种叠加关系在 Java、Python、Ruby、.NET 等生态中非常普遍。理解了这一点您在排查某个方法为什么在客户端文档里找不到之类的问题时会轻松很多。七、小结客户端是 Appium 架构中与测试作者距离最近的一环它屏蔽了 WebDriver 协议的所有 HTTP 细节把/session/:sessionid/element这样的端点调用翻译成您熟悉语言里的一个方法调用。回顾本篇的核心结论Appium 是客户端-服务器架构服务器负责在设备上执行自动化客户端负责发送命令与接收响应所有自动化命令本质上是 HTTP API 调用findElement等命令与端点的映射关系可在 w3c.ts 中查看客户端库让测试作者可以用自己熟悉的语言编写测试同一命令集在五种主流语言中的写法已在上文逐一对比选择客户端时先考虑语言再考虑功能完备性与维护活跃度官方维护的客户端列表与安装方式请前往 客户端列表 页面查看。这就是关于 Appium 客户端你需要知道的全部内容——现在可以挑选适合您的客户端开始编写第一条自动化测试了。【免费下载链接】appiumCross-platform automation framework for all kinds of apps, built on top of the W3C WebDriver protocol项目地址: https://gitcode.com/GitHub_Trending/ap/appium创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考