本文旨在对Android Monkey的源码进行解析,这样能在后续的定制改造中得心应手。
对于此源码,自己获取的过程也是废了一般周折,尝试过去手机里反编译,去各种地方找,后来发现,通过Google搜索“android monkey source code”,第一条就是,附上地址:https://github.com/android/platform_development/tree/master/cmds/monkey
所以有个感想,有时候得用英文搜,然后最好用Google搜。
一、使用
Monkey的使用很简单,需要注意的是各个参数的意义要搞清楚。
这篇文章并不会讲其使用,具体可以参见Google的官方文档[1],或者一篇博客[2]。
二、源码解析
1 ,阅读代码首先得理清楚主线,也即是执行流程。对应到Monkey中,也就是怎么通过在控制台中输入一串命令,就可以得到相应的测试结果的。因为主类Monkey中有main方法存在,再调用run()方法,一路跟下去,便可以理清楚其主线。下图是自己画的一个UML顺序图。本小节先对主线做简要介绍,后面两小节重点解析MonkeyEventSource和MonkeyEvent。
1)在run() 方法中,第一个比较重要的是参数处理方法processOptions(),用来解析命令行传入的参数,设置相应的变量。
2)然后会初始化EventSource,主要是最后一种,MonkeySourceRandom。这时会把通过命令行读入的参数全部设置到对应的变量中。在通过调用validate()方法,将传入的参数结合默认的参数进行调整和校验。
3)再调用runMonkeyCycles()方法执行具体事件。通过EventSource调用getNextEvent()获取到MonkeyEvent,对于具体的事件则调用injectEvent()触发真正的执行。对于返回的结果做相应的处理。
4)处理好后,在打印相应的日志结果即可。
5)对于其中的ActivityController,由于继承的是内部隐藏的类,可不比关注。
2,对于MonkeyEventSource,它是一个接口,主要的实现类是MonkeySourceRandom,也就是默认的随机事件,当然也还有网络,脚本两种事件源,其继承关系如下图。
(这是一种典型的面向对象的编程范式)
1)由于基于网络的事件只能作用于localhost,而基于脚本的事件其脚本并不友好,因此一般就用MonkeySourceRandom这个事件源,也就是默认的通过命令行触发的事件。下面就分析下MonkeySourceRandom这个类。
2)该类首先是定义了10种事件,分别是TOUCH, MOTION, PINCHZOOM, TRACKBALL, NAV, MAJORNAV, SYSOPS, APPSWITCH, FLIP和ANYTHING,这些事件和命令行中的可设置10种参数对应。
在构造函数中设置了各个事件的初始占比,并定了一个用于存储事件的队列。并定义了3种手势,TAP,DRAG, PINCH_OR_ZOOM。
3)然后,提供接口setFactors()给Monkey类对各个参数进行设置。再通过接口adjustEventFactors(),结合命令行输入和默认值,调整10个事件的比例,进行归一化。
4)该类中关键的作用是用于生成随机事件,通过generateEvents()这个私有方法完成。
对于TOUCH, MOTION, PINCHZOOM这三种,分别对应于TAP,DRAG和 PINCH_OR_ZOOM三种手势,利用generatePointerEvent()方法完成;对于TRACKBALL,利用方法generateTrackballEvent()完成 。
在generatePointerEvent()方法里,实际生成的都是MonkeyTouchEvent。如果传入的手势是TAP,则随机按下一个点,移动一次,再放开;如果是DRAG,则按下后,会随机移动一定数量的点后再放开;如果是PINCH_OR_ZOOM,由于是按下的是两个点,各自的id分别为0和1,然后随机一定数量的点再放开。
在generateTrackballEvent()方法里,生成的是MonkeyTrackballEvent。首先是随机的移动10次,然后还有10%的概率在移动完进行一次点击。
对于APPSWITCH,生成一个MonkeyActivityEvent事件;对于FLIP,生成一个MonkeyFlipEvent事件;而剩下的NAV, MAJORNAV, SYSOPS,都从各自的可选点中随机选出一个,对于ANYTHING则随机生成一个,这四种最后都生成MonkeyKeyEvent事件。
由此可以总结出,命令行中可配置的10种事件类型,装换为了Monkey中的5种Event,其对应关系如下表:
命令行可选参数 | FACTOR | MonkeyEvent类型 |
--pct-touch | FACTOR_TOUCH | MonkeyTouchEvent |
--pct-motion | FACTOR_MOTION | |
--pct-pinchzoom | FACTOR_PINCHZOOM | |
--pct-trackball | FACTOR_TRACKBALL | MonkeyTrackballEvent |
--pct-syskeys | FACTOR_SYSOPS | MonkeyKeyEvent |
--pct-nav | FACTOR_NAV | |
--pct-majornav | FACTOR_MAJORNAV | |
--pct-anyevent | FACTOR_ANYTHING | |
--pct-appswitch | FACTOR_APPSWITCH | MonkeyActivityEvent |
--pct-flip | FACTOR_FLIP | MonkeyFlipEvent |
5)该类通过getNextEvent()方法,供主类Monkey调用。所有事件放在MonkeyEventQueue中维护,如果为空则创建,不为空则返回第一个。
3,对于MonkeyEvent,有多种,也都是继承了基类MonkeyEvent,其关系如下图。(这同样是一种典型的面向对象的编程范式)
1)对于基类MonkeyEvent,定义了七种事件类型,都以EVENT_TYPE_开头,有KEY, TOUCH, TRACKBALL, ACTIVITY, FLIP, THROTTLE, NOOP。分别对应上面的各个叶子类(Motion派生出了Touch和Trackball)。在各个子类的构造函数中,都会根据类型调用基类的构造函数。当然需要注意的是,对于ACTIVITY这个类型,除了MonkeyActivityEvent,还有MonkeyCommandEvent, MonkeyGetFrameRateEvent, MonkeyInstrumentationEvent, MonkeyPowerEvent这四种事件也对应该类型。(具体原因还有待分析)
2)基类MonkeyEvent中还定了了四种执行结果的返回码,分别是SUCESS, FAIL, REMOTE_EXCEPTION, SECURITY_EXCEPTION。在各个派生类都要覆写的抽象方法injectEvent()中,都需要按情况返回对应的某种结果编码。
3)下面重点看下MonkeyMotionEvent(以及其派生出的MonkeyTouchEvent和MonkeyTrackBallEvent)。在设计上,采用了构建者(Builder)设计模式,可以让MonkeySource方便的构建出所需的特定事件。在内部事件处理中,采用Android的view组件中的MotionEvent,具体执行时,将MotionEvent对象传给派生类TouchEvent和TrackBallEvent处理,它们分别调用系统内部IWindowManager,的接口执行对应的Touch和TrackBall事件。需要注意的事,MotionEvent执行完最好进行recycle()。
4)对于MonkeyKeyEvent,采用了和MonkeyMotionEvent类似的思路,采用Android的view组件中的KeyEvent,具体事件执行也是利用IWindowManager调用。而对于MonkeyActivityEvent,也类似,采用了Android的content组件中的Intent,利用IActivityManager执行具体事件。至于MonkeyThrottleEvent,就是休眠一段时间;而MonkeyNoopEvent,就什么都不干。
对于MonkeyCommandEvent, MonkeyGetFrameRateEvent, MonkeyInstrumentationEvent, MonkeyPowerEvent,主要用在脚本执行(MonkeySourceScript)中,现实中很少用到。
5)通过对各个具体Event的分析,主要是在方法injectEvent()中通过特定的方式去执行相应的事件,有的简单,有的利用了系统的接口。如果后面需要改造这个代码,让其在用在自己的项目中,那就必须得去掉这些系统的内部接口,改用其他的方式。
4,再看下MonkeyEventQueue这个类,它继承自LinkedList,用来维护Monkey Event。
(在MonkeySourceRandom中,产生的事件都放在MonkeyEventQueue定义的mQ中;当在Monkey中需要获取一个事件时,也通过mQ的getFirst来获取。)
重点看下MonkeyEventQueue覆写的LinedList的addLast方法,其主要是对有间隔时间的事件做特殊处理,如果设置间隔时间随机则还要取一个随机数。
1 public void addLast(MonkeyEvent e) {
2 super.add(e);
3 if (e.isThrottlable()) {
4 long throttle = mThrottle;
5 if (mRandomizeThrottle && (mThrottle > 0)) {
6 throttle = mRandom.nextLong();
7 if (throttle < 0) {
8 throttle = -throttle;
9 }
10 throttle %= mThrottle;
11 ++throttle;
12 }
13 super.add(new MonkeyThrottleEvent(throttle));
14 }
15 }
三、代码的改造
通过以上的分析,发现可改造的一点是,在具体事件的执行上,去掉对IWindowManager和IActivityManager的依赖。
(暂时先写到这边)
参考:
[1] Google关于monkey的官方文档:http://developer.android.com/tools/help/monkey.html
[2] 博客:http://www.cnblogs.com/by-dream/p/5157308.html