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

概述

stetho是Facebook开源的一个Android调试工具,项目地址:facebook/stetho 通过Stetho,开发者可以使用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如何实现,就依赖实际使用场景了。

stetho 为开发者提供了一个很好的调试手段,但是自带的基础功能还比较弱,开发者可以根据自己的需求去改造。(不过官网文档是有点太少了……) 如果说这个工具有啥亮点,想来想去,大概App跟Chrome的通信,火狐的rhino引擎更可以被称之为亮点= .=|||3

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对我们的支持。如果你想了解更多相关内容请查看下面相关链接

(0)

相关推荐

  • Android添加音频的几种方法

    在res文件夹中新建一个文件夹,命名为raw.在里面放入我们需要的音频文件. 第一种: // 根据资源创建播放器对象 player = MediaPlayer.create(this, R.raw.xiaoxiaole); try { player.prepare();// 同步 } catch (IllegalStateException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (IOExcept

  • Android Java调用自己C++类库的实例讲解

    Android Java 如何调用自己的 C++ 的类库 下面以 Java 调用 C++ 的加法运算函数为例,做简单说明. (使用 Android Studio 3 编译) 首先编译 c++ 类库 创建独立目录存放 c++ 文件,例如 "app/src/main/cpp/add.cpp",内容如下 #include <jni.h> extern "C" JNIEXPORT jint JNICALL Java_com_example_liyi_demo_U

  • Android线程中Handle的使用讲解

    Android UI线程是不安全的,子线程中进行UI操作,可能会导致程序的崩溃,解决办法:创建一个Message对象,然后借助Handler发送出去,之后在Handler的handleMessage()方法中获得刚才发送的Message对象,然后在这里进行UI操作就不会再出现崩溃了 定义类继承Handler public class BallHandler extends Handler{ ImageView imageview; Bitmap bitmap; public BallHandle

  • Android可自定义神奇动效的卡片切换视图实例

    前言 面对众多卡片层叠效果,我们的产品童鞋也突发奇想,搞出了另一种卡片层叠切换展示的交互,而且产品狗们居然要求多做几种动效给他们看,好让他们选择,这简直就是要搞事情啊,what are you 弄啥咧?! "哥哥我做不到啊.....啊.....呸",做为一名有节操的程序猿,自然是不能说出这么没有出息的话,哥就满足你们,于是,出了个可自定义动效的卡片切换视图,效果如下所示 思路 首先,要展示出卡片层叠的视觉效果.在这里,我们通过方块的缩放大小差异以及在Y方向上的位置差异,来展现这种视觉效

  • Android手机获取Mac地址的几种方法

    最常用的方法,通过WiFiManager获取: /** * 通过WiFiManager获取mac地址 * @param context * @return */ private static String tryGetWifiMac(Context context) { WifiManager wm = (WifiManager) context.getApplicationContext().getSystemService(Context.WIFI_SERVICE); WifiInfo wi

  • Android获取当前应用分配的最大内存和目前使用内存的方法

    在Android里,程序内存被分为2部分:native和dalvik,dalvik就是我们普通的Java使用内存,分析堆栈的时候使用的内存.我们创建的对象是在这里面分配的,对于内存的限制是 native+dalvik 不能超过最大限制. Android 原生系统一般默认16M,但是国内手机一般都是特殊定制的,都有修改系统的内存大小,所有有时候,要查看具体应用系统分配的内存大小,还是需要实际去测试的, 测试方法如下: 方式一: ActivityManager activityManager = (

  • Android中数据解析的五种方式

    这里有一份XML文件,接下来我们用不同的解析方式来解析这份文件 <?xml version="1.0" encoding="UTF-8"?> <Movies> <Movie id="1"> <name>愤怒的小鸟</name> <type>Animation</type> <year>2016</year> </Movie> &

  • Android四大组件之Service详解

    一.Service简介 Service是Android程序中四大基础组件之一,它和Activity一样都是Context的子类,只不过它没有UI界面,是在后台运行的组件. Service是Android中实现程序后台运行的解决方案,它非常适用于去执行那些不需要和用户交互而且还要求长期运行的任务.Service默认并不会运行在子线程中,它也不运行在一个独立的进程中,它同样执行在UI线程中,因此,不要在Service中执行耗时的操作,除非你在Service中创建了子线程来完成耗时操作. 二.Serv

  • Android之在linux终端执行shell脚本直接打印当前运行app的日志的实现方法

    1.问题 我们一般很多时候会需要在ubuntu终端上打印当前运行app的日志,我们一般常见的做法是 1).获取包名 打开当前运行的app,然后输入如下命令,然后在第一行TASK后面的就可以看到包名 adb shell dumpsys activity top 2).我们的终端安装了pidcat.py脚本,然后执行如下的命令就可以打印当前运行app的全日志, pidcat.py packageName 3).思考,为什么每次都需要这样重复的操作呢?一说到重复,我们应该立马想到是否可以用脚本解决重复

  • Android亮屏速度分析总结

    前面聊的 最近在调试项目的亮屏速度,我们希望在按下power键后到亮屏这个时间能达到500MS以内,在Rockchip 3399和3288上面的时间都不能达到要求,因此引发了一系列的调试之路. 计算按下power键到亮屏的时间 Android 唤醒时间统计 刚开始的时候,我只在android阶段统计时间,也能看到时间的差异,但是不是最准确的,我统计的时间日志如下 01-18 09:13:40.992 683 772 D SurfaceControl: Excessive delay in set

随机推荐