uiautomatorviewer二次开发之自动生成控件定位符
前言
我们在使用Appium进行移动自动化测试脚本编写的时候,经常出现控件无法定位,如ListView下面的item,控件基本属性一样的、某些控件没有id、name等,这个时候,如果单纯靠id、name、text可能无法完全唯一定位一个控件,这个时候就需要编写xpath了,可是xpath语法、写法对于没有接触过的测试人员来说,又是个门槛,接下来,我们就来讨论如何通过二次开发uiautomatorviewer自动生成xpath供用户直接copy使用。
原理
uiautomatorviewer是android SDK包中原生的开源工具,给用户提供一种查看当前终端布局、控件属性的一个辅佐工具,
该工具的GUI是使用RCP组件进行开发的,然后通过uiautomator dump把当前终端布局文件dump到本地,uiautomatorviewer
通过xml布局文件,构造一棵tree,放到Canvas SWT组件中,和当前png截图叠加在一起,同时监听鼠标move等事件,自动
获取该tree的node节点,并且把该node节点的所有属性获取显示出来。
代码结构
com.android.uiautomator
:存放uiautomatorviewer工具的GUI界面代码,其中主入口UiAutomatorViewer.java文件里面有main函数入口,工具的窗口就在此创建。
com.android.uiautomator.actions
:存放所有anction操作,如:Device screenshot 、open等。
com.android.uiautomator.tree
:存放tree封装,dump出来的xml解析成一棵完整的tree,这个包是核心包。
二次开发
首先,dump出来的xml文件被uiautomationviewer解析成自定义的tree,每个节点代表一个控件,所以,如何添加Xpath属性呢?只需要在node节点中添加一个字段即可,其实很简单。通过阅读代码,在com.android.uiautomator.tree包下,有个node节点封装类,UiNode.java,看下以下代码片源:
public class UiNode extends BasicTreeNode {
private static final Pattern BOUNDS_PATTERN = Pattern
.compile("\\[-?(\\d+),-?(\\d+)\\]\\[-?(\\d+),-?(\\d+)\\]");
private final Map<String, String> mAttributes = new LinkedHashMap();
private String mDisplayName = "ShouldNotSeeMe";
private Object[] mCachedAttributesArray;
public void addAtrribute(String key, String value) {
this.mAttributes.put(key, value);
updateDisplayName();
if ("bounds".equals(key))
updateBounds(value);
}
public Map<String, String> getAttributes() {
return Collections.unmodifiableMap(this.mAttributes);
}
private void updateDisplayName() {
String className = (String) this.mAttributes.get("class");
if (className == null)
return;
String text = (String) this.mAttributes.get("text");
if (text == null)
return;
String contentDescription = (String) this.mAttributes
.get("content-desc");
if (contentDescription == null)
return;
String index = (String) this.mAttributes.get("index");
if (index == null)
return;
String bounds = (String) this.mAttributes.get("bounds");
if (bounds == null) {
return;
}
className = className.replace("android.widget.", "");
className = className.replace("android.view.", "");
StringBuilder builder = new StringBuilder();
builder.append('(');
builder.append(index);
builder.append(") ");
builder.append(className);
if (!text.isEmpty()) {
builder.append(':');
builder.append(text);
}
if (!contentDescription.isEmpty()) {
builder.append(" {");
builder.append(contentDescription);
builder.append('}');
}
builder.append(' ');
builder.append(bounds);
this.mDisplayName = builder.toString();
private final Map<String, String> mAttributes = new LinkedHashMap();
UiNode 节点下定义一个mAttributes LinkedHashMap,用于存储节点所有key-value属性,如:className、text 、index等等,所以,只需要在这个UiNode 类下添加一个获取xpath方法,如下:
public String getXpath()
{
String className=getNodeClassAttribute();
String xpath="//"+className;
String text = getAttribute("text");
if(text !=null&& !text.equals(""))
{
xpath += "[@text='"+text+"']";
return xpath;
}else
{
return getAttribute("content-desc") !=""?
xpath+"[@content-desc='"+getAttribute("content-desc")+"']"
:xpath+"[@index='"+getAttribute("index")+"']";
}
}
根据约定的优先级,进行筛选(text>content-desc>index),方法定义完毕后,如何触发getXpath()代码呢?
同样,在此包下UiHierarchyXmlLoader.java中,该类是用于处理把dump xml转换为BasicTreeNode对象,UiHierarchyXmlLoader 引用org.xml.sax.helpers处理基本xml文件(Default base class for SAX2 event handlers.),实现了ContentHandler接口下的startElement、endElement接口,
public void endElement(String uri, String localName, String qName)
throws SAXException {
if (this.mParentNode != null) {
this.mWorkingNode = this.mParentNode;
this.mParentNode = this.mParentNode.getParent();
`mTmpNode.addAtrribute("xpath",mTmpNode.getXpath());`
}
}
};
到这里,xpath就会自动出现在uiautomatorviewer界面上了,效果如下:
补充
其实uiautomatorviewer二次开发还不止这些,我们可以在uiautomatorviewer中加入录制自动生成java、python等appium脚本,还可以每次用户点击uiautomatorviewer界面,同步刷新(目前需要用户手动点击device screenshot 这个action)等等,如下:
第一次发分享贴,写的不好,希望大家多多鼓励,后续会继续分享
赞 也就是说即便开发没有定义控件的text description或者device ID,我们依然可以对这个控件进行唯一性的自主命名对吗?
#3楼 @james88233 一开始,想做成你说这个思路的,完全通过布局如://FrameLayout/View/TextView类似这样的方式,后来发现这样做,如果app布局一旦做了调整,解析出来的xpath就不能复用,所以,后来就改成了一个控件,按照text>content-desc>index的优先级进行唯一定位,如:有text内容的,优先,其次是content-desc
#4楼 @cpfeng0124 首先我明白你关于不能复用的那个解释,然后我不太理解的是你接下来说的这个操作,如果uiautomatorviewer可以获取到控件的text desc等信息,我还要xpath的信息做什么呢?
#7楼 @james88233 我们这边遇到这种问题,2个控件,id、text都一样,只有desc或者index不一样,这个时候,就需要些xpath来区分这2个控件了
#8楼 @cpfeng0124 谢谢分享,如果能上传uiautomatorviewer未修改的源码更棒了
#9楼 @yuwuhen333 uiautomatorviewer本身就是开源的哦,可以通过反编译直接生成代码
#10楼 @cpfeng0124 反编译是直接解压缩jar包吗?还是需要工具进行反编译
#11楼 @yuwuhen333 z直接解压缩jar包哦
赞!
有个疑问:如果遇到有两个控件 text 相同,那你生成的 xpath 是否就会一样?
#13楼 @mistyrain 基本可以的唯一定位的,目前通过xpath方式,还没发现定位不到的问题哦
#14楼 @chenhengjie123 吼吼,如果两个text相同的话,生成的xpath确实是一样的哦,有没有啥可以指点一下,如何改进啊?
@chenhengjie123 @cpfeng0124 看他这个代码逻辑只是判断了text是否为空,如果text相同,应该返回的xpath是一致的
#17楼 @app_testing 是的。
@cpfeng0124 ,如果是自定义控件的话,请问有没有思路呢,有人提议用HierachyViewer,但是感觉这个速度比较慢
#12楼 @cpfeng0124 压缩之后,文件夹中没有com.android.uiautomator.tree也没有UiNode.java,我的是Android19
#8楼 @cpfeng0124 我现在用的工具是黑盒的,所以我也不太清楚具体的架构,当你说的这种情况出现的时候,我们一般就用index=1 或者index=2来区分了 但是面对上图那种钟表式样的控件,就无能为力了,因为基本上text desc这些都没有,classname相同的一大堆,如果可以用xpath编译的话还是挺方便的,不过可能需要增加一些封装,让这个操作傻瓜化,比如tester点击控件可以直接对其命名
#19楼 @app_testing HierachyViewer我之前也做过,思路基本差不多,当时的需求是,需要测试手机整机全系统测试:如打电话、发短型、甚至并发,打电话的时候,上网啥的,当时就是基于HierachyViewer二次开发,全系统自动化测试的
#16楼 @cpfeng0124 大致思路:
在 dump 出来的 xml 文件中使用生成的 xpath 来查找节点,如果找到不止一个节点,就加上更多属性匹配条件(同样按照 text->content-desc->index,例如 android.view.view[@text="a" and @content-desc="b" and @index="1"]
)。如果都加上后还是不止一个元素,直接给个绝对路径吧。
可以录制脚本这个太赞了!能分享一下思路不?
@cpfeng0124 我的意思是HierachyViewer这个速度比较慢,你对这种情况有没有别的解决思路
#23楼 @chenhengjie123 录制脚本这个,我打算下周再做一次移动录制生成代码,因为第一次写这些分享,效率有点低啊,吼吼,谢谢你的指点!
#24楼 @app_testing 速度比较慢,主要卡在dump这个动作需要一定时间,这个我也在研究哦,吼吼!有啥想法,记得分享一下哈
#25楼 @cpfeng0124 期待你的分享!
#28楼 @yuwuhen333 你找错包啦,是这个uiautomatorviewer.jar包,在sdk\tools\lib\uiautomatorviewer.jar 这个目录下哦
#29楼 @cpfeng0124 太感谢了,顺便再问一句解压缩之后,按照文章中的说明进行修改后,怎么重新打包成jar?
#30楼 @yuwuhen333 正常打包就ok啦,要么导出来jar来,要么用maven打包
#32楼 @cpfeng0124 将uinode变为java类型添加你的代码后,在转换为uinode.class报错了UiNode.java:123: 错误: 非法的 Unicode 转义,继续调整。能不能先把你修改成生成的uiautomatorviewer.jar分享让我们感受下
#32楼 @cpfeng0124 在配置UINode.java.中一直报String className=getNodeClassAttribute();找不到这个方法,这个方法是从哪里来的啊
#36楼 @yuwuhen333 getNodeClassAttribute(),这个方法,需要你自己添加一下哦,骚瑞啊,没说清楚,getNodeClassAttribute
这个方法很简单,就返回private final Map<String, String> mAttributes = new LinkedHashMap()
;这里定义的mAttributes
即可
#37楼 @cpfeng0124 能不能贴出来下?mTmpNode.addAtrribute("xpath",mTmpNode.getXpath());
这个为什么在两边还有符号呢
#37楼 @cpfeng0124 不是返回这个map吧,String className=getNodeClassAttribute(), 这是String类型啊
#37楼 @cpfeng0124 是不是 要private String getNodeClassAttribute() {
// TODO Auto-generated method stub
return mAttributes.get("className");
}
#41楼 @cpfeng0124 public void endElement(String uri, String localName, String qName)
throws SAXException {
if (this.mParentNode != null) {
this.mWorkingNode = this.mParentNode;
this.mParentNode = this.mParentNode.getParent();
mTmpNode.addAtrribute("xpath",mTmpNode.getXpath());
}
}
};这个代码中你加的那行为什么多了``呢
#45楼 @yuwuhen333 我修改了,但是在eclipse里一直报错,我是改完之后export jar,然后从jar包里copy这2个class文件,然后复制到uiautomator.jar解压后的文件夹,然后jar cvf打包。。。
#46楼 @xxfcxx 相同的提示,我也是修改UiHierarchyXmlLoader.java的时候各种错误
#41楼 @cpfeng0124 能不能提供个你只是添加了xpath功能的jar包出来?
#37楼 @cpfeng0124 能不能提供个xpath的uiautomatorviewer.jar?