Appium API介绍

    在学习应用一个框架之前，应该了解一下这个框架的整体结构或是相应的API函数,在网上搜了一下，也没有找到相应的文档，我平时写测试用例的时候都是一边写一边查看找相应的API函数。

3.1常用的API函数

3.1.1 获取信息类API

（1）获取默认系统语言对应的Strings.xml文件内的数据。

get_app_string()

（2）查找某一个语言环境对应的字符串文件Strings.xml内数据。

get_app_string(Stringlanguage)

（3）获取当前activity,比如（.ApiDemos）

current_activity()

3.1.2App安装与卸载类API

（1）根据bundleId来判断该应用是否已经安装

is_app_installed(StringbundleId)

（2）安装app，appPath为应用的本地路径

install_app(StringappPath)

（3）卸载app.bundleId在android中代表的是包名，而在ios中有专门的bundleId号。

remove_app(StringbundleId)

（4）关闭应用，其实就是按home键把应用置于后台

close_app()

（5）启动应用

launch_app()

（6）先closeApp然后在launchAPP

reset_app()

3.1.3 文件操作类API

（1）将字符数组用64位格式写到远程目录的某个文件中。也可以理解为把本地文件push到设备上。

push_file(String remotePath, byte[]base64Data)

（2）将设备上的文件pull到本地硬盘上

pull_file(StringremotePath)

（3）将设备上的文件夹pull到本地硬盘上，一般远程文件为/data/local/tmp下的文件。

pull_folder(StringremotePath)

3.1.4 设置相关类API

（1）设置手机的网络连接状态，可以开关蓝牙、wifi、数据流量。通过NetworkConnectionSetting中的属性来设置各个网络连接的状态。

set_network_connect(NetworkConnectionSettingconnection)

（2）得到当前网络的状态

get_network_connection()

3.1.5 用户操作类API

（1）ios隐藏键盘

hide_keyboard()

（2）隐藏键盘，只能用于ios上。

hide_keyboard(String strategy, StringkeyName)

（3）按下某个键，具体哪个键由key值决定，key值定义在AndroidKeyCode类中

send_key_event(int key)

（4）执行一个touch动作，该touch动作是由TouchAction封装的。

perform_touchAction(TouchActiontouchAction)

（5）点击element控件中心点按下，duration*5毫秒秒后松开，如此重复fingers次。

tap(int fingers, WebElement element,int duration)

（6）点击(x,y)点按下，duration*5毫秒后松开，如此重复fingers次。

tap(int fingers, int x, int y, intduration)

（7）从(startx,starty)滑到（endx,endy），分duration步滑，每一步用时是5毫秒。

swipe(int startx, int starty, intendx, int endy, int duration)

（8）2个手指操作控件，从对角线向中心点滑动。

pinch(WebElement el)

（9）以（x,y）为基准，计算得出（x,y-100）,(x,y+100)两个点，然后2个手指按住这两个点同时滑到（x,y）

pinch(int x, int y)

(10)与pinch(el)的动作刚好相反。两个手指由控件的中心点慢慢向控件的左顶点后右底点滑动。

zoom(WebElement el)

(11)和pinch(x,y)相反。两个手指从（x,y）点开始向（x,y-100）和（x,y+100）滑动。

zoom(int x, int y)

(12)锁屏多少秒后解锁

lock_screen(int seconds)

(13)模拟摇晃手机

shake()

(14)滚动到某个text属性为指定的字符串的控件

scroll_to(String text)

(15)滚动到某个text属性包含传入的字符串的控件

scroll_to_exact(Stringtext)

(16)设置上下文

context(String name)

(17)可用上下文

get_context_handles()

(18)当前上下文

get_context()

(19)设置屏幕横屏或者竖屏

rotate(ScreenOrientationorientation)

(20)获取当前屏幕的方向

get_orientation()

3.1.6 获取控件类API

（1）利用ios中的uiautomation中的属性来获取控件

find_element_by_ios_uiautomation(String using)

（2）和上面一样，不过获得的是多个控件

find_elements_by_ios_uiautomation(String using)

（3）利用android的uiautoamtor中的属性来获取单个控件。

find_element_by_android_uiautomator(Stringusing)

（4）和上面一样，但是该方法获得是多个控件

find_elements_by_android_uiautomator(Stringusing)

（5）利用accessibility id来获取单个控件

find_element_by_accessibilityid(String using)

（6）利用accessibility id来获得多个控件

find_elements_by_accessibilityid(String using)

3.1.7AppiumDriver的辅助类

主要针对手势操作，比如滑动、长按、拖动等。TouchAction的原理是讲一系列的动作放在一个链条中，然后将该链条传递给服务器。服务器接受到该链条后，解析各个动作，逐个执行。

TouchAction()

（1）在控件上执行press操作

press(WebElement el)

（2）在坐标为（x,y）的点执行press操作

press(int x, int y)

（3）在控件el的左上角的x坐标偏移x单位，y左边偏移y单位的坐标上执行press操作。

press(WebElement el, int x, inty)

（4）释放操作，代表该系列动作的一个结束标志。

release() 

（5）以el为目标，从另一个点移动到该目标上

move_to(WebElement el)

（6）以（x,y）点为目标，从另一个点移动到该目标上

move_to(WebElement el, int x, inty)

(7) 在控件的中心点上敲击一下

tap(WebElement el)

(8)在（x,y）点轻击一下

tap(int x, int y)

(9)以控件el的左上角为基准，x轴向右移动x单位，y轴向下移动y单位。在该点上轻击。

tap(WebElement el, int x, inty)

(10)代表一个空操作，等待一段时间

wait_action()

(11)等待ms秒

wait_action(int ms)

(12)控件长按

long_press(WebElement el)

(13)点长按

long_press(int x, int y)

（14）偏移点长按

long_press(WebElement el, int x, inty) 

（15）取消执行该动作

cancel()

3.2 关于API的一些说明

  Appium是一个庞大的测试框架，当然其对应的API也是很多的，我没有找到详细的介绍文档。就从网上找了一篇文档，常用的API都提及到了，不过也不可能面面俱到，当我们写自动化测试用例的时候，都要想一下有没有能解决你问题的函数？然后可以去Appium下查找，这样才能更好地解决你遇到的问题。

  举个例子，当我们对某个功能进行测试的时候，首先要对其进行操作，这个时候就要考虑到相应的点击函数，输入操作函数都有哪儿些儿？验证结果的时候，我们要检测操作产生的结果是不是与我们预期的一致？那这就要去考虑相应的Assert函数了。要有发散思维的精神，不能局限于程序本身。

3.3 本章小结

  在本章我们介绍了Appium常用的一些儿API函数，虽然不能面面俱到，大家看了一下也许不能全部会用，但也要有个印象。等你在编写测试用例的过程中，如果遇到了相关的操作，能有个印象，然后利用编辑器的联想功能就可以查找到相应的API函数了。在后面的教程中，我们会陆续进行展开，使你可以着手对任何一个App编写对应的自动化测试用例。