Android调试神器stetho使用详解和改造

概述

stetho是Facebook开源的一个Android调试工具，开发者可以使用chrome的inspect功能，对Android应用进行调试和查看。

stetho提供的功能主要有：

  • Network Inspection：网络抓包，如果你使用的是当前流行的OkHttp或者Android自带的 HttpURLConnection，你可以轻松地在chrome inspect窗口的network一栏抓到所有的网络请求和回包，还用啥Postman，还用啥Fiddler哦（开个玩笑，一些场合还是需要用的，毕竟Stetho Network Inspection 只是用来查看回报和发送数据是否有误，在开发初期，调试API还是用Postman快一点）
  • Database Inspection：数据库查看，可以直接看到当前应用的sqlite数据库，而且是可视化的，不需要再下什么奇怪的工具或者用命令行看了。这个确实非常棒！
  • View Hierarchy：布局层级查看，免去使用查看布局边界的花花绿绿带来的痛苦和卡顿，而且能看到每个view和layout的各类属性。
  • Dump App：命令行拓展，构造了一个命令行与Android App的交互通道，在命令行输入一行命令，App可以收到并且在命令行上进行反馈输出。
  • Javascript Console：Javascript控制台，在inspect的console窗口，输入Javascript可以直接进行Java调用。使用这个功能，得先引入facebook/stethostetho-js-rhino和mozilla/rhino。

在这里，笔者先承认这个文章有点标题党了——在我实际使用体验过后，第一感觉是：这个所谓神器也没有特别神的感觉…造成首次使用感觉不太好的原因在于：

  • 使用教程不太全，尤其是Dump App的使用，不管是在README还是wiki中都没有太多的叙述。
  • Network Inspection 抓包只封装了OkHttp和HttpURLConnection的，然而大多数情况下，各个应用开发者可能都会有自己的一套网络请求库，它提供的接口这时候就不太友好了，得自己包装一下。
  • View Hierarchy 用起来有一丝丝的不方便，因为调试视图还包括了Android系统自带的状态栏布局之类的，导致Activity的布局天然处于一个比较深的节点，每次还要手动一层一层展开（其实这里有一个技巧，后面会提到）
  • Javascript Console 感觉是最鸡肋的功能，因为自带的console只能关联到application的context，能进行的操作非常有限，且在控制台写js调用Java层的函数是没有自动补全的，容易写错不说，要换成Js的语法也是相当费劲。就算解决这几个问题，也还是想不到什么合适的使用场景。

后面将会对Dump App和Network Inspection进行详细介绍（其他的几个功能都比较简单）。
初始化Stetho

首先引入在安卓项目中引用必要的依赖包，可以使用gradle，也可以直接下载jar包。

dependencies {
    compile ‘com.facebook.stetho:stetho:1.5.0‘
}

需要注意的是如果使用Javascript Console需要额外引入facebook/stethostetho-js-rhino和mozilla/rhino。 然后在应用的Application初始化时，进行Stetho初始化。这些都在官网有详细的说明，不再赘述了。

开始使用

由于大部分功能依赖于Chrome DevTools 所以第一步你需要先打开Chrome，然后在浏览器地址栏输入：chrome://inspect 接触过前端开发或者Webview开发的捧油应该是很熟悉这个套路了。你会看到一个如下界面：

inspect界面

你会发现这里有两项，是因为我的这个示例应用有两个进程。由于App的每个进程都会单独创建一个Application，所以在应用包含多个进程时，Stetho也会为每个进程都初始化一次。那么这里我要调试的是主进程，就点击第一项inspect就行了。 接下来我们就开始搞事情了：
View Hierarchy
查看布局层级没啥好说的，但是之前提到，由于系统的view层级也包括进来了，所以我们Activity的Layout层级都很深，每次一层一层点开很难找，这里提供一个简便方法，在Elements面板，按Ctrl + F。搜索@android：id/content 即可快速定位到我们当前界面根布局，例如这里的Constraintlayout:

Database Inspection
点击Resource-Web SQL即可查看App的数据库：

Javascript Console
在Console面板，输入context可以看到目前的ApplicationContext：

输入如下代码弹出Toast：

importPackage(android.widget);
importPackage(android.os);
var handler = new Handler(Looper.getMainLooper());
handler.post(function() { Toast.makeText(context, "Hello from JavaScript", Toast.LENGTH_LONG).show() });

应用场景比较有限，但是mozilla/rhino这个Javascript引擎倒是挺有意思的，可以用来做一些有趣的事情，以后有机会再分享一下。
Dump App
官方对dump app的使用说明实在太少了，感觉非常捉急。研究了一番，大概知道了使用流程，即首先需要在App内，通过enableDumpapp方法注册自己的插件： Stetho.initialize(Stetho.newInitializerBuilder(context)

.enableDumpapp(new DumperPluginsProvider() {
  @Override
  public Iterable<DumperPlugin> get() {
    return new Stetho.DefaultDumperPluginsBuilder(context)
        .provide(new MyDumperPlugin())
        .finish();
  }
})
.enableWebKitInspector(Stetho.defaultInspectorModulesProvider(context))
.build())

也可以使用默认的插件： Stetho.initialize(Stetho.newInitializerBuilder(this)

            .enableDumpapp(new DumperPluginsProvider() {
                public Iterable<DumperPlugin> get() {
                    return (new Stetho.DefaultDumperPluginsBuilder(StethoNetworkApplication.this)).finish();
                }
            }).enableWebKitInspector(Stetho.defaultInspectorModulesProvider(context))
.build())

然后，stetho的github项目地址下有一个script文件夹：facebook/stetho-script 把这个文件夹下到本地，发现里面有几个文件： .gitignore dumpapp hprof_dump.sh stetho_open.py 说实话第一眼看上去根本不知道这东西干啥用的，dumpapp这文件看起来就跟可执行文件似的，但事实上它又不是exe，用记事本打开一看，是Python3的文件，我也是醉了…

所以使用Python3.x来运行这个文件即可。（由于他还引用了stetho_open.py，为了看起来不那么别扭，我把几个文件都整合在一齐，搞了一个dump.py） 这里我并没有注册任何插件，但是由于Stetho自带了几个插件，我们可以看看他们的实现：

例如files插件，来试用一下：

即用户发送命令时，Plugin的dump方法会被调用，Plugin通过dumpContext.getStdout()来获取输出流，将反馈输出到命令行：

public void dump(DumperContext dumpContext) throws DumpException {
        Iterator<String> args = dumpContext.getArgsAsList().iterator();
        String command = ArgsHelper.nextOptionalArg(args, "");
        if("ls".equals(command)) {
            this.doLs(dumpContext.getStdout());
        } else if("tree".equals(command)) {
            this.doTree(dumpContext.getStdout());
        } else if("download".equals(command)) {
            this.doDownload(dumpContext.getStdout(), args);
        } else {
            this.doUsage(dumpContext.getStdout());
            if(!"".equals(command)) {
                throw new DumpUsageException("Unknown command: " + command);
            }
        }

    }

Network Inspection
其实这也是重点之一了。我在这里添加了一个OkHttp的Inspector。 注意：此处有坑，因为你会发现用gradle添加的stetho依赖中没有StethoInterceptor这个类，你可以到stetho的github页面下载一下，同事需要跟你的OkHttp版本对应，因为2.x跟3.x对应的StethoInterceptor还有差异）： 下载地址： facebook/stetho-okhttp3 facebook/stetho-okhttp 代码示例如下： public void testOkHttp(){

Thread thread = new Thread(new Runnable() {
    @Override
    public void run() {
        String url = "http://www.zhihu.com/";
        OkHttpClient.Builder builder = new OkHttpClient.Builder()

addNetworkInterceptor(new StethoInterceptor());

        OkHttpClient client = builder.build();
        Request request = new Request.Builder()
                .url(url)
                .get()
                .build();
        try {

            Response response = client.newCall(request).execute();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
});
thread.start();

运行这个函数，可以看到Network一栏的请求，每项网络请求发出时，Status处于Pending状态，收到回包后，Status等栏目都会变化，展示httpcode，请求耗时、回包数据类型等信息。


当然这不是重点。重点是我们要对这个东西改造一下，他是如何抓下包来发送给Chrome的呢？ 看一下StethoInterceptor的intercept函数，写了些注释：

private final NetworkEventReporter mEventReporter =
    NetworkEventReporterImpl.get();
public Response intercept(Chain chain) throws IOException {
    // 构造一个独特的eventID，一对网络事件（请求和回包）对应一个eventID
    String requestId = mEventReporter.nextRequestId();

    Request request = chain.request();

    // 准备发送请求
    RequestBodyHelper requestBodyHelper = null;
    if (mEventReporter.isEnabled()) {
      requestBodyHelper = new RequestBodyHelper(mEventReporter, requestId);
      OkHttpInspectorRequest inspectorRequest =
          new OkHttpInspectorRequest(requestId, request, requestBodyHelper);
      // 请求即将发送，构造一个OkHttpInspectorRequest，报告给Chrome，此时Network会显示一条请求，处于Pending状态
      mEventReporter.requestWillBeSent(inspectorRequest);
    }

    Response response;
    try {
      // 发送请求，获得回包
      response = chain.proceed(request);
    } catch (IOException e) {
      // 如果发生了IO Exception，则通知Chrome网络请求失败了，显示对应的错误信息
      if (mEventReporter.isEnabled()) {
        mEventReporter.httpExchangeFailed(requestId, e.toString());
      }
      throw e;
    }

    if (mEventReporter.isEnabled()) {
      if (requestBodyHelper != null && requestBodyHelper.hasBody()) {
        requestBodyHelper.reportDataSent();
      }

      Connection connection = chain.connection();

      // 回包的header已收到，构造一个OkHttpInspectorResponse,发送给Chrome用于展示
      mEventReporter.responseHeadersReceived(
          new OkHttpInspectorResponse(
              requestId,
              request,
              response,
              connection));

      // 展示回包信息
      ResponseBody body = response.body();
      MediaType contentType = null;
      InputStream responseStream = null;
      if (body != null) {
        contentType = body.contentType();
        responseStream = body.byteStream();
      }

      responseStream = mEventReporter.interpretResponseStream(
          requestId,
          contentType != null ? contentType.toString() : null,
          response.header("Content-Encoding"),
          responseStream,
          new DefaultResponseHandler(mEventReporter, requestId));
      if (responseStream != null) {
        response = response.newBuilder()
            .body(new ForwardingResponseBody(body, responseStream))
            .build();
      }
    }

    return response;
  }

所以整个流程我们可以简化为：发送请求时，给Chrome发了条消息，收到请求时，再给Chrome发条消息（具体怎么发的可以看NetworkEventReporterImpl的实现） 两条消息通过EventID联系起来，它们的类型分别是OkHttpInspectorRequest 和 OkHttpInspectorResponse，两者分别继承自NetworkEventReporter.InspectorRequest和NetworkEventReporter.InspectorResponse。我们只要也继承自这两个类，在自己的网络库发送和收到请求时，构造一个Request和Response并发送给Chrome即可。 发送部分示例：

PulseInspectorRequest 继承自NetworkEventReporter.InspectorRequest
   public void reportRequestSend(PulseInspectorRequest request){
        String requestId = request.id();

        // request will be sent
        RequestBodyHelper requestBodyHelper = null;
        if (mEventReporter.isEnabled()) {
            requestBodyHelper = new RequestBodyHelper(mEventReporter, requestId);
            mEventReporter.requestWillBeSent(request);

            // report request send
            if (requestBodyHelper.hasBody()) {
                requestBodyHelper.reportDataSent();
            }
        }

    }

回包获取成功：

public void reportRequestSuccess(PulseInspectorResponse response){
    mEventReporter.responseHeadersReceived(response);
    mEventReporter.responseReadFinished(response.requestId());

    String requestId = response.requestId();
    String contentType = "application/json";
    String encoding = null;
    InputStream responseStream = new ByteArrayInputStream(response.getResponseBody().getBytes());

    InputStream responseHandlingInputStream = mEventReporter.interpretResponseStream(
            requestId,
            contentType,
            encoding,
            responseStream,
            new DefaultResponseHandler(mEventReporter, requestId));
    try {
        if (responseHandlingInputStream == null) return;
        // 重点在这，这两行代码一定要加上,StethoInterceptor之所以不需要加，
        // 是因为OkHttp本身对请求采取了职责链式的处理，
        // 虽然在StethoInterceptor的intercept函数里没有进行read和close
        // 但是后续的Interceptor会进行这个操作，实际上这里，才把回包数据发送给了Chrome
        responseHandlingInputStream.read(response.getResponseBody().getBytes());
        responseHandlingInputStream.close();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

回包获取失败

public void reportRequestFail(String eventId,String errMsg){
        mEventReporter.httpExchangeFailed(eventId, errMsg);
}

至于PulseInspectorResponse 和PulseInspectorRequest如何实现，就依赖实际使用场景了。

原文地址：https://blog.51cto.com/14295695/2395199

时间： 2024-10-12 12:54:46

Android调试神器stetho使用详解和改造的相关文章

【转】段错误调试神器 - Core Dump详解

from:http://www.embeddedlinux.org.cn/html/jishuzixun/201307/08-2594.html 段错误调试神器 - Core Dump详解 来源:互联网 作者:Alex 时间:2013-07-08 Tag:Linux   点击: 11670 一.前言: 有的程序可以通过编译, 但在运行时会出现Segment fault(段错误). 这通常都是指针错误引起的. 但这不像编译错误一样会提示到文件某一行, 而是没有任何信息, 使得我们的调试变得困难起来

段错误调试神器 - Core Dump详解

一.前言: 有的程序可以通过编译, 但在运行时会出现Segment fault(段错误). 这通常都是指针错误引起的. 但这不像编译错误一样会提示到文件某一行, 而是没有任何信息, 使得我们的调试变得困难起来. gdb: 有一种办法是, 我们用gdb的step, 一步一步寻找. 这放在短小的代码中是可行的, 但要让你step一个上万行的代码, 我想你会从此厌恶程序员这个名字, 而把他叫做调试员. 我们还有更好的办法, 这就是core file. ulimit: 如果想让系统在信号中断造成的错误时

[Android新手区] SQLite 操作详解--SQL语法

该文章完全摘自转自:北大青鸟[Android新手区] SQLite 操作详解--SQL语法  :http://home.bdqn.cn/thread-49363-1-1.html SQLite库可以解析大部分标准SQL语言.但它也省去了一些特性并且加入了一些自己的新特性.这篇文档就是试图描述那些SQLite支持/不支持的SQL语法的.查看关键字列表. 如下语法表格中,纯文本用蓝色粗体显示.非终极符号为斜体红色.作为语法一部分的运算符用黑色Roman字体表示. 这篇文档只是对SQLite实现的SQ

Android高效率编码-第三方SDK详解系列(三)——JPush推送牵扯出来的江湖恩怨，XMPP实现推送，自定义客户端推送

Android高效率编码-第三方SDK详解系列(三)--JPush推送牵扯出来的江湖恩怨,XMPP实现推送,自定义客户端推送 很久没有更新第三方SDK这个系列了,所以更新一下这几天工作中使用到的推送,写这个系列真的很要命,你要去把他们的API文档大致的翻阅一遍,而且各种功能都实现一遍,解决各种bug各种坑,不得不说,极光推送真坑,大家使用还是要慎重,我们看一下极光推送的官网 https://www.jpush.cn/common/ 推送比较使用,很多软件有需要,所以在这个点拿出来多讲讲,我们本节

Android触摸屏事件派发机制详解与源码分析二(ViewGroup篇)

1 背景 还记得前一篇<Android触摸屏事件派发机制详解与源码分析一(View篇)>中关于透过源码继续进阶实例验证模块中存在的点击Button却触发了LinearLayout的事件疑惑吗?当时说了,在那一篇咱们只讨论View的触摸事件派发机制,这个疑惑留在了这一篇解释,也就是ViewGroup的事件派发机制. PS:阅读本篇前建议先查看前一篇<Android触摸屏事件派发机制详解与源码分析一(View篇)>,这一篇承接上一篇. 关于View与ViewGroup的区别在前一篇的A

Android APK优化工具Zipalign详解

最近在googl play上发布apk要优化 Android SDK中包含一个"zipalign"的工具,它能够对打包的应用程序进行优化.在你的应用程序上运行zipalign,使得在运行时Android与应用程序间的交互更加有效率.因此,这种方式能够让应用程序和整个系统运行得更快.我们强烈推荐在新的和已经发布的程序上使用zipalign工具来得到优化后的版本 一.这里下载android SDK,只为了用他的zipalign工具,当然什么时候大家有兴趣了用来开发两个小程序也是很简单的 A

Android触摸屏事件派发机制详解与源码分析

请看下面三篇博客,思路还是蛮清晰的,不过还是没写自定义控件系列哥们的思路清晰: Android触摸屏事件派发机制详解与源码分析一(View篇) http://blog.csdn.net/yanbober/article/details/45887547 Android触摸屏事件派发机制详解与源码分析二(ViewGroup篇) http://blog.csdn.net/yanbober/article/details/45912661 Android触摸屏事件派发机制详解与源码分析三(Activi

Android开发之Html类详解

在进行Android开发中经常回忽略Html类.这个类其实很简单,就是将HTML标签文本解析成普通的样式文本.下面就让我么看一下这个类的具体介绍. 类结构: java.lang.Object    ? android.text.Html 类概述: 这个类用于处理的HTML字符串并将其转换成可显示的样式文本.但并不是所有的HTML标记的支持. 公有方法: 说其简单是应为它就有四个方法: Public Methods static String escapeHtml(CharSequence tex

Android开发之通知栏Notification详解

Notification的用法  --- 状态栏通知 发送一个状态栏通知必须的两个类: 1. NotificationManager   --- 状态栏通知的管理类,负责发通知,清除通知等 NotificationManager : 是一个系统Service,必须通过 context.getSystemService(NOTIFICATION_SERVICE)方法获取 NotificationManager notificationManager = (NotificationManager)