MonkeyRunner源碼分析之與Android設備通訊方式

如前文《誰動了我的截圖?--Monkeyrunner takeSnapshot方法源碼跟蹤分析》所述,本文主要會嘗試描述android的自動化測試框架MonkeyRunner究竟是如何和目標設備進行通信的。

在上一篇文章中我們其實已經描述了其中一個方法，就是通過adb協議發送adb服務器請求的方式驅動android設備的adbd守護進程去獲取FrameBuffer的數據生成屏幕截圖。那么MonkeyRunner還會用其他方式和目標設備進行通信嗎？答案是肯定的，且看我們一步步分析道來。

1.概述

MonkeyRunner和目標設備打交道都是通過ChimpChat層進行封裝分發但最終是在ddmlib進行處理的，其中囊括的方法大體如下:

• 發送monkey命令：MonkeyRunner先通過adb shell發送命令"monkey -port  12345"在目標機器上啟動monkey以監聽端口接受連接，然后MonkeyRunner通過連接該端口建立socket并發送monkey命令。所有與界面相關的操作都是通過這種方式發送到目標機器的。
• 發送adb協議請求：通過發送adb協議請求來與目標設備通信的，詳情請查看<<誰動了我的截圖?--Monkeyrunner takeSnapshot方法源碼跟蹤分析>>和<<adb概覽及協議參考>>，其實adb命令行客戶端的所有命令最終都是通過發送遵循adb協議的請求來實現的，只是做成命令行方式方便終端用戶使用而已
• 發送adb shell命令：模擬adb命令行工具發送adb shell命令，只是不是真正的直接命令行調用adb工具，而是在每一個命令執行之前先通過上面的“發送adb協議請求“發送“shell：”請求建立一個和adb服務器通信的adb shell的socket連接通道，adb服務器再和目標設備的adb守護進程進行通信

以下是MonkeyDevice所有請求對應的與設備通信方式

分析之前請大家準備好對應的幾個庫的源碼：

2. 發送monkey命令

在剖析如何發送monkey命令之前，我們需要先去了解一個類，因為這個類是處理所有monkey命令的關鍵，這就是ChimpChat庫的ChimpManager類。
我們先查看其構造函數，看它是怎么初始化的：

/*     */   private Socket monkeySocket; /*     */    /*     */   private BufferedWriter monkeyWriter; /*     */    /*     */   private BufferedReader monkeyReader; /*     */    /*     */  /*     */   public ChimpManager(Socket monkeySocket) /*     */     throws IOException /*     */   { /*  62 */     this.monkeySocket = monkeySocket; /*  63 */     this.monkeyWriter = new BufferedWriter(new OutputStreamWriter(monkeySocket.getOutputStream())); /*     */      /*  65 */     this.monkeyReader = new BufferedReader(new InputStreamReader(monkeySocket.getInputStream())); /*     */   }

• 把構造函數傳進來的monkeySocket這個socket對象保存起來，往下會分析這個socket是如何創立的
• 初始化monkeyWriter這個BufferedWriter，今后往monkey的socket發送命令的時候用的就是它
• 初始化monkeyReader這個BufferedReader,今后從monkey的socket讀返回的時候用的就是它

/*     */   private ChimpManager manager; /*     */    /*     */   public AdbChimpDevice(IDevice device) /*     */   { /*  70 */     this.device = device; /*  71 */     this.manager = createManager("127.0.0.1", 12345); /*     */      /*  73 */     Preconditions.checkNotNull(this.manager); /*     */   }

• MonkeyRunner在啟動的時候會先啟動MonkeyRunnerStarter這個類，該類的構造函數調用ChimpChat的getInstance方法實例化ChimpChat.
• ChimpChat的getInstance方法會先實例化AdbBackend這個類，然后構建 ChimpChat自身這個實例
• 用戶調用MonkeyRunner.waitForConnection()方法初始化MonkeyDevice
• 以上的waitForConnection()又調用的是ChimpChat的waitforConnection()方法
• ChimpChat的waitForConnection方法調用的是AdbBackend的waitForConnection方法最終會findAttachedDevice找到目標設備然后用該設備初始化AdbChimpDevice

好，那么我們繼續看AdbChimpDevice里面的方法createManager是如何對ChimpManager進行初始化的：

/*     */   private ChimpManager createManager(String address, int port) { /*     */     try { /* 125 */       this.device.createForward(port, port); /*     */     } catch (TimeoutException e) { /* 127 */       LOG.log(Level.SEVERE, "Timeout creating adb port forwarding", e); /* 128 */       return null; /*     */     } catch (AdbCommandRejectedException e) { /* 130 */       LOG.log(Level.SEVERE, "Adb rejected adb port forwarding command: " + e.getMessage(), e); /* 131 */       return null; /*     */     } catch (IOException e) { /* 133 */       LOG.log(Level.SEVERE, "Unable to create adb port forwarding: " + e.getMessage(), e); /* 134 */       return null; /*     */     } /*     */      /* 137 */     String command = "monkey --port " + port; /* 138 */     executeAsyncCommand(command, new LoggingOutputReceiver(LOG, Level.FINE)); /*     */      /*     */     try /*     */     { /* 142 */       Thread.sleep(1000L); /*     */     } catch (InterruptedException e) { /* 144 */       LOG.log(Level.SEVERE, "Unable to sleep", e); /*     */     } /*     */     InetAddress addr; /*     */     try /*     */     { /* 149 */       addr = InetAddress.getByName(address); /*     */     } catch (UnknownHostException e) { /* 151 */       LOG.log(Level.SEVERE, "Unable to convert address into InetAddress: " + address, e); /* 152 */       return null; /*     */     } /*     */      /*     */  /*     */  /*     */  /*     */  /* 159 */     boolean success = false; /* 160 */     ChimpManager mm = null; /* 161 */     long start = System.currentTimeMillis(); /*     */      /* 163 */     while (!success) { /* 164 */       long now = System.currentTimeMillis(); /* 165 */       long diff = now - start; /* 166 */       if (diff > 30000L) { /* 167 */         LOG.severe("Timeout while trying to create chimp mananger"); /* 168 */         return null; /*     */       } /*     */       try /*     */       { /* 172 */         Thread.sleep(1000L); /*     */       } catch (InterruptedException e) { /* 174 */         LOG.log(Level.SEVERE, "Unable to sleep", e); /*     */       } /*     */       Socket monkeySocket; /*     */       try /*     */       { /* 179 */         monkeySocket = new Socket(addr, port); /*     */       } catch (IOException e) { /* 181 */         LOG.log(Level.FINE, "Unable to connect socket", e); /* 182 */         success = false; } /* 183 */       continue; /*     */        /*     */       try /*     */       { /* 187 */         mm = new ChimpManager(monkeySocket); /*     */       } catch (IOException e) { /* 189 */         LOG.log(Level.SEVERE, "Unable to open writer and reader to socket"); } /* 190 */       continue; /*     */        /*     */       try /*     */       { /* 194 */         mm.wake(); /*     */       } catch (IOException e) { /* 196 */         LOG.log(Level.FINE, "Unable to wake up device", e); /* 197 */         success = false; } /* 198 */       continue; /*     */        /* 200 */       success = true; /*     */     } /*     */      /* 203 */     return mm; /*     */   }

• 通過調用ddmlib的device類里面的createForward方法來把主機pc端本地的端口轉發給目標機器端的monkey監聽端口，這樣子做的好處是我們通過直接連接主機pc端的轉發端口發送命令就會等同于通過網絡連接上目標機器的monkey監聽端口來發送monkey命令
• 調用executeAsyncCommand方法發送異步adb shell命令 “monkey -port"到目標機器開啟monkey并監聽以上描述的端口
• 創建連接到主機pc對應目標設備monkey監聽端口的monkeySocket
• 把該monkeySocket傳遞到本章節開頭說的ChimpManager構造函數對ChimpManager進行實例化

/*     */   public void press(String keyName, TouchPressType type) /*     */   { /*     */     try /*     */     { /* 326 */       switch (3.$SwitchMap$com$android$chimpchat$core$TouchPressType[type.ordinal()]) { /*     */       case 1:  /* 328 */         this.manager.press(keyName); /* 329 */         break; /*     */       case 2:  /* 331 */         this.manager.keyDown(keyName); /* 332 */         break; /*     */       case 3:  /* 334 */         this.manager.keyUp(keyName); /*     */       } /*     */     } /*     */     catch (IOException e) { /* 338 */       LOG.log(Level.SEVERE, "Error sending press event: " + keyName + " " + type, e); /*     */     } /*     */   }

/*     */   public boolean press(String name) /*     */     throws IOException /*     */   { /* 135 */     return sendMonkeyEvent("press " + name); /*     */   }

/*     */   private boolean sendMonkeyEvent(String command) /*     */     throws IOException /*     */   { /* 234 */     synchronized (this) { /* 235 */       String monkeyResponse = sendMonkeyEventAndGetResponse(command); /* 236 */       return parseResponseForSuccess(monkeyResponse); /*     */     } /*     */   }

/*     */   private String sendMonkeyEventAndGetResponse(String command) /*     */     throws IOException /*     */   { /* 182 */     command = command.trim(); /* 183 */     LOG.info("Monkey Command: " + command + "."); /*     */      /*     */  /* 186 */     this.monkeyWriter.write(command + "\n"); /* 187 */     this.monkeyWriter.flush(); /* 188 */     return this.monkeyReader.readLine(); /*     */   }

3. 發送adb協議請求

通過上一篇文章《誰動了我的截圖?--Monkeyrunner takeSnapshot方法源碼跟蹤分析》的分析，我們知道MonkeyRunner分發不同的設備控制信息是在ChimpChat庫的AdbChimpDevice這個類里面進行的。所以這里我就不會從頭開始分析我們是怎么進入到這個類里面的了，大家不清楚的請先查看上一篇投石問路的文章再返回來看本文。

這里我們嘗試以getSystemProperty這個稍微復雜點的方法為例子分析下MonkeyRunner是真么通過adb shell發送命令的，我們首先定位到AdbChimpDevice的該方法：

/*     */   public String getSystemProperty(String key) /*     */   { /* 224 */     return this.device.getProperty(key); /*     */   }

這里的device成員函數指的就是ddmlib庫里面的Device這個類（請查看上一篇文章），那么我們進去該類看下getProperty這個方法：

/*      */   public String getProperty(String name) /*      */   { /*  379 */     return (String)this.mProperties.get(name); /*      */   }

/*   65 */   private final Map<String, String> mProperties = new HashMap();

/*      */   void addProperty(String label, String value) { /*  779 */     this.mProperties.put(label, value); /*      */   }

/*    */   public void processNewLines(String[] lines) /*    */   { /* 49 */     for (String line : lines) { /* 50 */       if ((!line.isEmpty()) && (!line.startsWith("#"))) /*    */       { /*    */  /*    */  /* 54 */         Matcher m = GETPROP_PATTERN.matcher(line); /* 55 */         if (m.matches()) { /* 56 */           String label = m.group(1); /* 57 */           String value = m.group(2); /*    */            /* 59 */           if (!label.isEmpty()) { /* 60 */             this.mDevice.addProperty(label, value); /*    */           } /*    */         } /*    */       } /*    */     } /*    */   }

繼續之前我們先要了解下ddmlib這個庫里面的DeviceMonitor這個類，這個類會啟動一個線程來監控所有連接到主機的設備的狀態。

/*      */   boolean start() /*      */   { /*  715 */     if ((this.mAdbOsLocation != null) && (sAdbServerPort != 0) && ((!this.mVersionCheck) || (!startAdb()))) { /*  716 */       return false; /*      */     } /*      */      /*  719 */     this.mStarted = true; /*      */      /*      */  /*  722 */     this.mDeviceMonitor = new DeviceMonitor(this); /*  723 */     this.mDeviceMonitor.start(); /*      */      /*  725 */     return true; /*      */   } 

/*      */   boolean start() /*      */   { /*  715 */     if ((this.mAdbOsLocation != null) && (sAdbServerPort != 0) && ((!this.mVersionCheck) || (!startAdb()))) { /*  716 */       return false; /*      */     } /*      */      /*  719 */     this.mStarted = true; /*      */      /*      */  /*  722 */     this.mDeviceMonitor = new DeviceMonitor(this); /*  723 */     this.mDeviceMonitor.start(); /*      */      /*  725 */     return true; /*      */   }

private void deviceMonitorLoop() /*     */   { /*     */     do /*     */     { /*     */       try /*     */       { /* 161 */         if (this.mMainAdbConnection == null) { /* 162 */           Log.d("DeviceMonitor", "Opening adb connection"); /* 163 */           this.mMainAdbConnection = openAdbConnection(); /* 164 */           if (this.mMainAdbConnection == null) { /* 165 */             this.mConnectionAttempt += 1; /* 166 */             Log.e("DeviceMonitor", "Connection attempts: " + this.mConnectionAttempt); /* 167 */             if (this.mConnectionAttempt > 10) { /* 168 */               if (!this.mServer.startAdb()) { /* 169 */                 this.mRestartAttemptCount += 1; /* 170 */                 Log.e("DeviceMonitor", "adb restart attempts: " + this.mRestartAttemptCount); /*     */               } /*     */               else { /* 173 */                 this.mRestartAttemptCount = 0; /*     */               } /*     */             } /* 176 */             waitABit(); /*     */           } else { /* 178 */             Log.d("DeviceMonitor", "Connected to adb for device monitoring"); /* 179 */             this.mConnectionAttempt = 0; /*     */           } /*     */         } /*     */          /* 183 */         if ((this.mMainAdbConnection != null) && (!this.mMonitoring)) { /* 184 */           this.mMonitoring = sendDeviceListMonitoringRequest(); /*     */         } /*     */          /* 187 */         if (this.mMonitoring) /*     */         { /* 189 */           int length = readLength(this.mMainAdbConnection, this.mLengthBuffer); /*     */            /* 191 */           if (length >= 0) /*     */           { /* 193 */             processIncomingDeviceData(length); /*     */              /*     */  /* 196 */             this.mInitialDeviceListDone = true; /*     */           } /*     */         } /*     */       } /*     */       catch (AsynchronousCloseException ace) {}catch (TimeoutException ioe) /*     */       { /* 202 */         handleExpectionInMonitorLoop(ioe); /*     */       } catch (IOException ioe) { /* 204 */         handleExpectionInMonitorLoop(ioe); /*     */       } /* 206 */     } while (!this.mQuit); /*     */   } 

/*     */   private void processIncomingDeviceData(int length) throws IOException /*     */   { /* 298 */     ArrayList<Device> list = new ArrayList(); /*     */      /* 300 */     if (length > 0) { /* 301 */       byte[] buffer = new byte[length]; /* 302 */       String result = read(this.mMainAdbConnection, buffer); /*     */        /* 304 */       String[] devices = result.split("\n"); /*     */        /* 306 */       for (String d : devices) { /* 307 */         String[] param = d.split("\t"); /* 308 */         if (param.length == 2) /*     */         { /* 310 */           Device device = new Device(this, param[0], IDevice.DeviceState.getState(param[1])); /*     */            /*     */  /*     */  /* 314 */           list.add(device); /*     */         } /*     */       } /*     */     } /*     */      /*     */  /* 320 */     updateDevices(list); /*     */   }

 private void updateDevices(ArrayList<Device> newList) /*     */   { /* 329 */     synchronized () /*     */     { /*     */  /*     */  /* 333 */       ArrayList<Device> devicesToQuery = new ArrayList(); /* 334 */       synchronized (this.mDevices) /*     */       { /*     */  /*     */  /*     */  /*     */  /*     */  /*     */  /*     */  /*     */  /* 344 */         for (int d = 0; d < this.mDevices.size();) { /* 345 */           Device device = (Device)this.mDevices.get(d); /*     */            /*     */  /* 348 */           int count = newList.size(); /* 349 */           boolean foundMatch = false; /* 350 */           for (int dd = 0; dd < count; dd++) { /* 351 */             Device newDevice = (Device)newList.get(dd); /*     */              /* 353 */             if (newDevice.getSerialNumber().equals(device.getSerialNumber())) { /* 354 */               foundMatch = true; /*     */                /*     */  /* 357 */               if (device.getState() != newDevice.getState()) { /* 358 */                 device.setState(newDevice.getState()); /* 359 */                 device.update(1); /*     */                  /*     */  /*     */  /* 363 */                 if (device.isOnline()) { /* 364 */                   if ((AndroidDebugBridge.getClientSupport()) &&  /* 365 */                     (!startMonitoringDevice(device))) { /* 366 */                     Log.e("DeviceMonitor", "Failed to start monitoring " + device.getSerialNumber()); /*     */                   } /*     */                    /*     */  /*     */  /*     */  /* 372 */                   if (device.getPropertyCount() == 0) { /* 373 */                     devicesToQuery.add(device); /*     */                   } /*     */                 } /*     */               } /*     */                /*     */  /* 379 */               newList.remove(dd); /* 380 */               break; /*     */             } /*     */           } /*     */            /* 384 */           if (!foundMatch) /*     */           { /*     */  /* 387 */             removeDevice(device); /* 388 */             this.mServer.deviceDisconnected(device); /*     */           } /*     */           else { /* 391 */             d++; /*     */           } /*     */         } /*     */          /*     */  /*     */  /* 397 */         for (Device newDevice : newList) /*     */         { /* 399 */           this.mDevices.add(newDevice); /* 400 */           this.mServer.deviceConnected(newDevice); /*     */            /*     */  /* 403 */           if ((AndroidDebugBridge.getClientSupport()) &&  /* 404 */             (newDevice.isOnline())) { /* 405 */             startMonitoringDevice(newDevice); /*     */           } /*     */            /*     */  /*     */  /* 410 */           if (newDevice.isOnline()) { /* 411 */             devicesToQuery.add(newDevice); /*     */           } /*     */         } /*     */       } /*     */        /*     */  /* 417 */       for (Device d : devicesToQuery) { /* 418 */         queryNewDeviceForInfo(d); /*     */       } /*     */     } /* 421 */     newList.clear(); /*     */   } 

/*     */   private void queryNewDeviceForInfo(Device device) /*     */   { /*     */     try /*     */     { /* 446 */       device.executeShellCommand("getprop", new GetPropReceiver(device)); /*     */        /*     */  /* 449 */       queryNewDeviceForMountingPoint(device, "EXTERNAL_STORAGE"); /* 450 */       queryNewDeviceForMountingPoint(device, "ANDROID_DATA"); /* 451 */       queryNewDeviceForMountingPoint(device, "ANDROID_ROOT"); /*     */        /*     */  /* 454 */       if (device.isEmulator()) { /* 455 */         EmulatorConsole console = EmulatorConsole.getConsole(device); /* 456 */         if (console != null) { /* 457 */           device.setAvdName(console.getAvdName()); /* 458 */           console.close(); /*     */         } /*     */       } /*     */     } catch (TimeoutException e) { /* 462 */       Log.w("DeviceMonitor", String.format("Connection timeout getting info for device %s", new Object[] { device.getSerialNumber() })); /*     */  /*     */     } /*     */     catch (AdbCommandRejectedException e) /*     */     { /* 467 */       Log.w("DeviceMonitor", String.format("Adb rejected command to get  device %1$s info: %2$s", new Object[] { device.getSerialNumber(), e.getMessage() })); /*     */  /*     */     } /*     */     catch (ShellCommandUnresponsiveException e) /*     */     { /* 472 */       Log.w("DeviceMonitor", String.format("Adb shell command took too long returning info for device %s", new Object[] { device.getSerialNumber() })); /*     */  /*     */     } /*     */     catch (IOException e) /*     */     { /* 477 */       Log.w("DeviceMonitor", String.format("IO Error getting info for device %s", new Object[] { device.getSerialNumber() })); /*     */     } /*     */   }

但這里遺留了兩個問題

• 一個是之前提到的GetPropertyReceiver這個類里面的增加property的processNewLines方法是在哪里調用的
• 一個是executeShellCommand究竟是怎么工作的

各位看官不用著急，且看我們往下分析，很快就會水落石出了。我們繼續跟蹤executeShellCommand這個方法,在我們的例子中其以命令'getprop'和new的GetPropertyReceiver對象實例為參數，最終會調用到Device這個類里面的executeShellCommand這個方法。注意這個GetPropertyReceiver很重要，我們往后會看到。

/*      */   public void executeShellCommand(String command, IShellOutputReceiver receiver, int maxTimeToOutputResponse) /*      */     throws TimeoutException, AdbCommandRejectedException, ShellCommandUnresponsiveException, IOException /*      */   { /*  618 */     AdbHelper.executeRemoteCommand(AndroidDebugBridge.getSocketAddress(), command, this, receiver, maxTimeToOutputResponse); /*      */   }

/*     */   static void executeRemoteCommand(InetSocketAddress adbSockAddr, String command, IDevice device, IShellOutputReceiver rcvr, long maxTimeToOutputResponse, TimeUnit maxTimeUnits) /*     */     throws TimeoutException, AdbCommandRejectedException, ShellCommandUnresponsiveException, IOException /*     */   { /* 378 */     long maxTimeToOutputMs = 0L; /* 379 */     if (maxTimeToOutputResponse > 0L) { /* 380 */       if (maxTimeUnits == null) { /* 381 */         throw new NullPointerException("Time unit must not be null for non-zero max."); /*     */       } /* 383 */       maxTimeToOutputMs = maxTimeUnits.toMillis(maxTimeToOutputResponse); /*     */     } /*     */      /* 386 */     Log.v("ddms", "execute: running " + command); /*     */      /* 388 */     SocketChannel adbChan = null; /*     */     try { /* 390 */       adbChan = SocketChannel.open(adbSockAddr); /* 391 */       adbChan.configureBlocking(false); /*     */        /*     */  /*     */  /*     */  /* 396 */       setDevice(adbChan, device); /*     */        /* 398 */       byte[] request = formAdbRequest("shell:" + command); /* 399 */       write(adbChan, request); /*     */        /* 401 */       AdbResponse resp = readAdbResponse(adbChan, false); /* 402 */       if (!resp.okay) { /* 403 */         Log.e("ddms", "ADB rejected shell command (" + command + "): " + resp.message); /* 404 */         throw new AdbCommandRejectedException(resp.message); /*     */       } /*     */        /* 407 */       byte[] data = new byte['