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['