1.    背景

使用SDK自帶的NotePad應用作為實踐目標應用，目的是對MonkeyDevice擁有的成員方法做一個初步的了解。

以下是官方列出的方法的Overview。

其實官方這個表是沒有及時更新的，我現在手頭上用到的MonkeyRunner是當前最新的，里面就擁有好幾個官網沒有列出來的API，我懷疑是不是自從UIAutomator在03年出來后，google就不打算再繼續維護MonkeyRunner了？如果有朋友知道事實的話，還麻煩告知。

以下是我整理出來的源碼多出來的可用公共API列表

但可惜的是在本人嘗試以上多出來的API的時候，發現除了最上面兩個可用之外，其他的都不可用并拋出錯誤。且網上資料少的可憐，別人碰到同樣的問題也找不到解決辦法。所以本人懷疑這些“隱藏”API是不是并沒有完善，或者說google不準備完善，所以才沒有列出到官網上面去。本人用的SDK tools和Platform tools已經是當前最新的23.0.2和20.

一個臺灣網友碰到的問題描述：http://imsardine.simplbug.com/note/monkeyrunner/api/hierarchy-viewer.html

2.    Void broadcastIntent 

(string uri, string action,string data, string mimetype, iterable categories dictionary extras, componentcomponent, iterable flags)

2.1 分析

本人理解的此方法的本意是想廣播一個Intent給我們的AndroidDevice，目標應用接收到該Intent做相應的處理，比如打開一個Activity等。但在我的多次嘗試下并沒有成功！

targetDevice.broadcastIntent(action='android.intent.action.INSERT',                            mimetype='vnd.android.cursor.dir/contact',                            extras = {'name':'user1501488', 'phone':'123-15489'} 

如果使用同樣的參數，使用下面的startActivity是沒有問題的。

targetDevice.startActivity(action='android.intent.action.INSERT',                            mimetype='vnd.android.cursor.dir/contact',                            extras = {'name':'user1501488', 'phone':'123-15489'}) 

google了半天網上根本找不到這個方法的使用例子，倒是stackOverFlow上有人建議用Shell來達到同樣的效果。

targetDevice.shell("am start -a android.intent.action.INSERT -t vnd.android.cursor.dir/contact -e name 'Donald Duck' -e phone 555-1234").

所以可見這個方法并沒有多少人在用，原因應該是它完全可以用上面介紹的兩個方法替代。

3. void startActivity 

(string uri, string action, string data, string mimetype, iterable categories dictionary extras, component component, flags)

3.1 示例

targetDevice.startActivity(action='android.intent.action.VIEW',                           mimetype='vnd.android.cursor.dir/vnd.google.note')

targetDevice.startActivity(component="com.example.android.notepad/com.example.android.notepad.NotesList")

targetDevice.startActivity(action='android.intent.action.INSERT',                            mimetype='vnd.android.cursor.dir/contact',                            extras = {'name':'user1501488', 'phone':'123-15489'})

4.  void drag (tuple start, tuple end, floatduration, integer steps)

這個方法的目的是按住一個控件然后把她拖動到其他位置

4.1 實例

viewer = targetDevice.getHierarchyViewer() note = viewer.findViewById('id/text1') point = viewer.getAbsoluteCenterOfView(note) startX = point.x startY = point.y  targetDevice.drag((startX,startY),(startX,startY),1)  targetDevice.press('KEYCODE_BACK', MonkeyDevice.DOWN_AND_UP) 

4.2 分析和建議

以上示例是通過drag的方法來模擬LongPress，只要把參數中的起始坐標和目標坐標都設置成同樣一個值，然后時常設置成一個有效的值就好了。

5 Object getProperty (string key)

 通過環境變量的key來獲得其對應的值。以下是官方提供的可用化境變量列表

5.1示例

displayWidth =targetDevice.getProperty ('display.width') printdisplayWidth.encode('utf-8')   displayHight =targetDevice.getProperty('display.width') printdisplayHight.encode('utf-8')  

5.2  分析和建議

以上示例的目的是獲得目標設備的長和高，當我們使用坐標點來操作控件的時候，調試的時候在一臺機器上通過了，但是如果換了另外一個屏幕大小不一樣的機器的話就會失敗，因為控件的坐標點位置可能就變了。這個時候我們就需要用到示例中的連個屬性來動態計算控件在不同屏幕大小的設備上面的坐標點了。

這里需要注意參數應該填寫的格式是以上列表中前兩列的組合PropertyGroup.Property

6． Object getSystemProperty (string key)

6.1 示例

displayWidth = targetDevice.getSystemProperty ('service.adb.tcp.port') print displayWidth.encode('utf-8') 

6.2 分析和建議

根據官網的描述，這個函數和getProperty函數應該有同樣的功能（Synonym for getProperty().），使用的屬性表也如上面的屬性列表一樣。但是按照我的實踐并非如此，不過它確實如官方描述的等同于命令“adb shell getprop <key>.”倒是真的。

以上的例子是獲取adb這個服務所打開的TCP端口，等同于如下的shell命令：“adb shell getprop service.adb.tcp.port“

如果我嘗試使用下面的方法去獲得設備的長度，返回的結果其實會是None

displayWidth = targetDevice.getSystemProperty ('display.width') print displayWidth.encode('utf-8') 

7 Boolean installPackage (string path)

7.1示例

if True == targetDevice.installPackage('D:\\Projects\\Workspace\\PythonMonkeyRunnerDemo\\apps\\MPortal.apk'):    print "Installationfinished successfully" else:     print "Failedto install the apk"

7.2 分析和建議

這里有兩點需要注意的：

• 官方網站描述的這個API是沒有返回值的（見背景中的表），而最新版本的API里面是Boolean值。
• 參數輸入的應該是PC端這邊的Local路徑而非目標系統的Local路徑。

注意這里碰到一個路徑問題，如果我的路徑寫成：

'D:\Projects\Workspace\PythonMonkeyRunnerDemo\apps\MPortal.apk'

那么會出現下圖這樣的錯誤：

如果在“apps”前面加多個轉義符就沒有問題：

'D:\Projects\Workspace\PythonMonkeyRunnerDemo\\apps\MPortal.apk'

所以這里MonkeyRunner處理路徑字串應該是存在Bug的，但是時間問題就先不去研究，建議所有路徑的話“\“都加上轉義符就好了

'D:\\Projects\\Workspace\\PythonMonkeyRunnerDemo\\apps\MPortal.apk'

8 boolean removePackage(string package)

8.1 示例

if True == targetDevice.removePackage('com.majcit.portal'):    print "Succeed toremove the package" else:     print "Failedto remove teh package"

8.2 注意事項

·        如上面的installPackageAPI一樣，官網描述的該API是沒有返回值的，而最新的是返回boolean值

9. dictionary instrument (string className, dictionary args)

9.1 示例

只指定第一個參數（將會跑所有指定Component下的所有case+ NotePad項目本身的使用了Instrumentation的用例，具體意思請看下一節的分析）

dict = targetDevice.instrument('com.example.android.notepad.tryout/android.test.InstrumentationTestRunner') print dict 

指定只跑其中的一個Case：

dict = dict = targetDevice.instrument('com.example.android.notepad.tryout/android.test.InstrumentationTestRunner',                                       {'class':'com.example.android.notepad.tryout.TCCreateNote'}) print dict 

9.2 分析

這里首先需要看下官方的描述

Runs the specifiedcomponent under Android instrumentation, and returns the results in adictionary whose exact format is dictated by the component being run. Thecomponent must already be present on this device

這里重點是第一句“Runs the specified component under Android instrumentation“，剩下的是說返回值根據模塊不一樣而有所差別。那么第一句翻譯過來就是”運行使用了Anroid Instrumentation的指定模塊“。那么究竟什么是使用了Android Instrumentation的指定模塊呢？其實如果你有用過Robotium的話應該知道，腳本的每個case都是從Instrumentation相關的類中繼承下來的。

以下是本人之前寫的一個Robotium的測試case（具體請查看本人之前的一篇《Robotium創建一個Note的實例》，可以看到它是繼承于“ActivityInstrumentationTestCase2”的，其實它就滿足了剛才的描述“使用了Anroid Instrumentation的指定模塊“

package com.example.android.notepad.tryout;  import com.robotium.solo.Solo;  import android.test.ActivityInstrumentationTestCase2; import android.app.Activity;  @SuppressWarnings("rawtypes") public class TCCreateNote extends ActivityInstrumentationTestCase2{  	private static Solo solo = null; 	public Activity activity; 	 	private static final int NUMBER_TOTAL_CASES = 2; 	private static int run = 0; 	 	private static Class<?> launchActivityClass;  	//對應re-sign.jar生成出來的信息框里的兩個值 	private static String mainActiviy = "com.example.android.notepad.NotesList"; 	private static String packageName = "com.example.android.notepad";  	static {  		try {  			launchActivityClass = Class.forName(mainActiviy);  		} catch (ClassNotFoundException e) {  			throw new RuntimeException(e);  		}  	} 	 	 	@SuppressWarnings("unchecked") 	public TCCreateNote() { 		super(packageName, launchActivityClass); 	}  	 	@Override 	public void setUp() throws Exception { 		//setUp() is run before a test case is started.  		//This is where the solo object is created. 		super.setUp();  		//The variable solo has to be static, since every time after a case's finished, this class TCCreateNote would be re-instantiated 		// which would lead to soto to re-instantiated to be null if it's not set as static 		if(solo == null) { 			TCCreateNote.solo = new Solo(getInstrumentation(), getActivity()); 		} 	} 	 	@Override 	public void tearDown() throws Exception { 		//Check whether it's the last case executed. 		run += countTestCases(); 		if(run >= NUMBER_TOTAL_CASES) { 			solo.finishOpenedActivities(); 		} 	}  	public void testAddNoteCNTitle() throws Exception { 		 		solo.clickOnMenuItem("Add note"); 		solo.enterText(0, "中文標簽筆記"); 		solo.clickOnMenuItem("Save"); 		solo.clickInList(0); 		solo.clearEditText(0); 		solo.enterText(0, "Text 1"); 		solo.clickOnMenuItem("Save"); 		solo.assertCurrentActivity("Expected NotesList Activity", "NotesList"); 		 		solo.clickLongOnText("中文標簽筆記"); 		solo.clickOnText("Delete"); 	} 	 	 	public void testAddNoteEngTitle() throws Exception { 		solo.clickOnMenuItem("Add note"); 		solo.enterText(0, "English Title Note"); 		solo.clickOnMenuItem("Save"); 		solo.clickInList(0); 		solo.clearEditText(0); 		solo.enterText(0, "Text 1"); 		solo.clickOnMenuItem("Save"); 		solo.assertCurrentActivity("Expected NotesList Activity", "NotesList"); 		 		solo.clickLongOnText("English Title Note"); 		solo.clickOnText("Delete"); 	} } 

那么我們先在目標機器上執行命令“pm list instrumentation”看是否能列出這個“Component”：

這其中哪一個是我們想要的呢？這要看我們的Robotium測試項目中的AndroidManifest.xml的定義了，根據下圖的packageName再對照上圖的輸出我們就定位到我們想要的Component了：

如果我們調用這個方法的時候只是填寫了第一個參數的話，上圖處在”com.example.andriod.notepad.tryout”這個Component下的所有三個方法都會執行。但在我的測試中，發現除了跑這個Case之外，它還跑多了一些步驟，就是額外的多創建了一個Note1。我查了半天，發現原來我之前除了編寫了基于ActivityInstrumentationTestCase2的Robotium的這個項目之外，還在NoetePad這個項目上直接用InstrumentationTestCase寫了一個基于Instrumentation的測試用例，做得事情就是增加一個Note1，具體請看本人另外一篇blog《SDK Instrumentation創建一個Note的實例》

其實調用這個方法相當于在shell腳本上執行如下的命令：

am instrument -w -r -e class com.example.android.notepad.tryout.TCCreateNote com.example.android.notepad.tryout/android.test.InstrumentationTestRunner

最后提一下的是，我們的腳本在執行示例的時候大概5秒左右就會失敗，但事實上在設備端所有的指定component的測試用例已經在執行的了。要解決這個問題需要重新編譯源碼，這里就免了，具體請查看：http://stackoverflow.com/questions/4264057/android-cts-is-showing-shellcommandunresponsiveexception-on-emulator

這里嘗試做一個簡單的總結

• 調用此方法之前先要找到第一個參數怎么寫：執行命令“pm list instrumentation”
•  調用次方法如果不指定第一個參數會執行指定Component下面的所有測試腳本和目標應用包中所有用到Instrumentation的測試用例
• 調用此方法最終事實上是在目標機器上根據指定的參數執行“am instrument xxxx”

10 void press (string name, integer type)

10.1 示例

targetDevice.press('KEYCODE_BACK',MonkeyDevice.DOWN_AND_UP)

10.2 分析

這個方法的目的是發送一個指定的Key事件到Android設備以觸發相應的動作，比如示例中發送“KEYCODE_BACK”這個key到設備端去觸發”返回“鍵的按下和升起（也就是點擊）的動作。

具體Key的Code請查看：http://developer.android.com/reference/android/view/KeyEvent.html

第二個參數是指導該Key應該如何Behave，比如先按下去，休眠一秒再彈起來（其實就相當于一個長按的動作）。具體支持behavior在本MonkeyDevice這個類的成員變量里有定義好：

11. void touch (integer x,integer y, integer type)

11.1 示例

viewer = targetDevice.getHierarchyViewer() note = viewer.findViewById('id/text1') point = viewer.getAbsoluteCenterOfView(note) startX = point.x startY = point.y  targetDevice.touch(startX,startY，MonkeyDevice.DOWN_AND_UP) 

11.2 分析

這個和上面的press方法在結果上有點類似，但是本方法是接受坐標進行點擊的，而上面方法接受的是keycode。

第二個參數同上。

12. void type (string message)

viewer =targetDevice.getHierarchyViewer()

note = viewer.findViewById('id/text1')

point = viewer.getAbsoluteCenterOfView(note)

startX = point.x

startY = point.y

targetDevice.touch(startX,startY,MonkeyDevice.DOWN_AND_UP)

MonkeyRunner.sleep(3)

targetDevice.type('NewContent')

12.1 示例

viewer = targetDevice.getHierarchyViewer() note = viewer.findViewById('id/text1') point = viewer.getAbsoluteCenterOfView(note) startX = point.x startY = point.y targetDevice.touch(startX,startY,MonkeyDevice.DOWN_AND_UP) MonkeyRunner.sleep(3) targetDevice.type('NewContent') 

12.2 分析

指定一串字符串進行模擬鍵盤輸入，等同于調用press方法按照一個一個的keycode用MonkeyDevice的DOWN_AND_UP進行輸入。

嘗試時發現中文不支持，鑒于項目不需要用到這種手機鍵盤，所以節省時間暫不研究。

13. Wake()

13.1示例

targetDevice.wake()

13.2 分析

注意這里只是喚醒屏保，如果手機已經鎖屏的話你是不能喚醒的。所以嘗試這個API的時候要注意把鎖屏功能先關閉掉。

14. MonkeyImange takeSnapshot()

14.1 示例

#Connect to the target targetDevice targetDevice = MonkeyRunner.waitForConnection()  easy_device = EasyMonkeyDevice(targetDevice)  #touch a button by id would need this targetDevice.startActivity(component="com.example.android.notepad/com.example.android.notepad.NotesList")  #invoke the menu options MonkeyRunner.sleep(6) #targetDevice.press('KEYCODE_MENU', MonkeyDevice.DOWN_AND_UP);  '''      public ViewNode findViewById(String id)       * @param id id for the view.      * @return view with the specified ID, or {@code null} if no view found. ''' #MonkeyRunner.alert("Continue?", "help", "Ok?")  pic = targetDevice.takeSnapshot() pic = pic.getSubImage((0,38,480,762))  newPic = targetDevice.takeSnapshot() newPic = newPic.getSubImage((0,38,480,762))  print (newPic.sameAs(pic,1.0)) newPic.writeToFile('./shot1.png','png')

14 object shell（string cmd）

14.1 示例

res = targetDevice.shell('ls /data/local/tmp|grep note') print res

14.2 分析

這個命令等同于你直接在命令行上“adb shell $command”

15 void reboot(string into)

其他參數沒有用到所以也就沒有嘗試，僅僅嘗試了不帶參數的情況，結果就是直接reboot目標設備了

targetDevice.reboot()