Android調(diào)試菠菜游戲平臺(tái)架設(shè)神器stetho使用詳解和

stetho是Facebook菠菜游戲平臺(tái)架設(shè)，需要的請(qǐng)找【大神源碼論壇】dsluntan.com，詳情咨詢企娥3393756370，開(kāi)源的一個(gè)Android調(diào)試工具，項(xiàng)目地址：facebook/stetho 通過(guò)Stetho，開(kāi)發(fā)者可以使用chrome的inspect功能，對(duì)Android應(yīng)用進(jìn)行調(diào)試和查看。 功能概述

stetho提供的功能主要有：

Network Inspection：網(wǎng)絡(luò)抓包，如果你使用的是當(dāng)前流行的OkHttp或者Android自帶的 HttpURLConnection，你可以輕松地在chrome inspect窗口的network一欄抓到所有的網(wǎng)絡(luò)請(qǐng)求和回包，還用啥Postman，還用啥Fiddler哦（開(kāi)個(gè)玩笑，一些場(chǎng)合還是需要用的，畢竟Stetho Network Inspection 只是用來(lái)查看回報(bào)和發(fā)送數(shù)據(jù)是否有誤，在開(kāi)發(fā)初期，調(diào)試API還是用Postman快一點(diǎn)）
Database Inspection：數(shù)據(jù)庫(kù)查看，可以直接看到當(dāng)前應(yīng)用的sqlite數(shù)據(jù)庫(kù)，而且是可視化的，不需要再下什么奇怪的工具或者用命令行看了。這個(gè)確實(shí)非常棒！
View Hierarchy：布局層級(jí)查看，免去使用查看布局邊界的花花綠綠帶來(lái)的痛苦和卡頓，而且能看到每個(gè)view和layout的各類(lèi)屬性。
Dump App：命令行拓展，構(gòu)造了一個(gè)命令行與Android App的交互通道，在命令行輸入一行命令，App可以收到并且在命令行上進(jìn)行反饋輸出。
Javascript Console：Javascript控制臺(tái)，在inspect的console窗口，輸入Javascript可以直接進(jìn)行Java調(diào)用。使用這個(gè)功能，得先引入facebook/stethostetho-js-rhino和mozilla/rhino。
在這里，筆者先承認(rèn)這個(gè)文章有點(diǎn)標(biāo)題黨了——在我實(shí)際使用體驗(yàn)過(guò)后，第一感覺(jué)是：這個(gè)所謂神器也沒(méi)有特別神的感覺(jué)…造成首次使用感覺(jué)不太好的原因在于：

使用教程不太全，尤其是Dump App的使用，不管是在README還是wiki中都沒(méi)有太多的敘述。
Network Inspection 抓包只封裝了OkHttp和HttpURLConnection的，然而大多數(shù)情況下，各個(gè)應(yīng)用開(kāi)發(fā)者可能都會(huì)有自己的一套網(wǎng)絡(luò)請(qǐng)求庫(kù)，它提供的接口這時(shí)候就不太友好了，得自己包裝一下。
View Hierarchy 用起來(lái)有一絲絲的不方便，因?yàn)檎{(diào)試視圖還包括了Android系統(tǒng)自帶的狀態(tài)欄布局之類(lèi)的，導(dǎo)致Activity的布局天然處于一個(gè)比較深的節(jié)點(diǎn)，每次還要手動(dòng)一層一層展開(kāi)（其實(shí)這里有一個(gè)技巧，后面會(huì)提到）。
Javascript Console 感覺(jué)是最雞肋的功能，因?yàn)樽詭У腸onsole只能關(guān)聯(lián)到application的context，能進(jìn)行的操作非常有限，且在控制臺(tái)寫(xiě)js調(diào)用Java層的函數(shù)是沒(méi)有自動(dòng)補(bǔ)全的，容易寫(xiě)錯(cuò)不說(shuō)，要換成Js的語(yǔ)法也是相當(dāng)費(fèi)勁。就算解決這幾個(gè)問(wèn)題，也還是想不到什么合適的使用場(chǎng)景。
后面將會(huì)對(duì)Dump App和Network Inspection進(jìn)行詳細(xì)介紹（其他的幾個(gè)功能都比較簡(jiǎn)單）。
菠菜游戲平臺(tái)架設(shè)，需要的請(qǐng)找【大神源碼論壇】dsluntan.com，詳情咨詢企娥3393756370，
初始化Stetho

首先引入在安卓項(xiàng)目中引用必要的依賴包，可以使用gradle，也可以直接下載jar包。

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

需要注意的是如果使用Javascript Console需要額外引入facebook/stethostetho-js-rhino和mozilla/rhino。 然后在應(yīng)用的Application初始化時(shí)，進(jìn)行Stetho初始化。這些都在官網(wǎng)有詳細(xì)的說(shuō)明，不再贅述了。

開(kāi)始使用
由于大部分功能依賴于Chrome DevTools 所以第一步你需要先打開(kāi)Chrome，然后在瀏覽器地址欄輸入：chrome://inspect 接觸過(guò)前端開(kāi)發(fā)或者Webview開(kāi)發(fā)的捧油應(yīng)該是很熟悉這個(gè)套路了。你會(huì)看到一個(gè)如下界面：

img

inspect界面
img

你會(huì)發(fā)現(xiàn)這里有兩項(xiàng)，是因?yàn)槲业倪@個(gè)示例應(yīng)用有兩個(gè)進(jìn)程。由于App的每個(gè)進(jìn)程都會(huì)單獨(dú)創(chuàng)建一個(gè)Application，所以在應(yīng)用包含多個(gè)進(jìn)程時(shí)，Stetho也會(huì)為每個(gè)進(jìn)程都初始化一次。那么這里我要調(diào)試的是主進(jìn)程，就點(diǎn)擊第一項(xiàng)inspect就行了。 接下來(lái)我們就開(kāi)始搞事情了：

View Hierarchy
查看布局層級(jí)沒(méi)啥好說(shuō)的，但是之前提到，由于系統(tǒng)的view層級(jí)也包括進(jìn)來(lái)了，所以我們Activity的Layout層級(jí)都很深，每次一層一層點(diǎn)開(kāi)很難找，這里提供一個(gè)簡(jiǎn)便方法，在Elements面板，按Ctrl + F，搜索 @android:id/content 即可快速定位到我們當(dāng)前界面根布局，例如這里的Constraintlayout:
菠菜游戲平臺(tái)架設(shè)，需要的請(qǐng)找【大神源碼論壇】dsluntan.com，詳情咨詢企娥3393756370，
img

Database Inspection
點(diǎn)擊Resource-Web SQL即可查看App的數(shù)據(jù)庫(kù)：

img

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

img

輸入如下代碼彈出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() });

應(yīng)用場(chǎng)景比較有限，但是mozilla/rhino這個(gè)Javascript引擎倒是挺有意思的，可以用來(lái)做一些有趣的事情，以后有機(jī)會(huì)再分享一下。

Dump App
官方對(duì)dump app的使用說(shuō)明實(shí)在太少了，感覺(jué)非常捉急。研究了一番，大概知道了使用流程，即首先需要在App內(nèi)，通過(guò)enableDumpapp方法注冊(cè)自己的插件： Stetho.initialize(Stetho.newInitializerBuilder(context)

.enableDumpapp(new DumperPluginsProvider() {@Override
br/>@Override
return new Stetho.DefaultDumperPluginsBuilder(context)
.provide(new MyDumperPlugin())
.finish();
}
})
.enableWebKitInspector(Stetho.defaultInspectorModulesProvider(context))
.build())

也可以使用默認(rèn)的插件： 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項(xiàng)目地址下有一個(gè)script文件夾：facebook/stetho-script 把這個(gè)文件夾下到本地，發(fā)現(xiàn)里面有幾個(gè)文件： .gitignore dumpapp hprof_dump.sh stetho_open.py 說(shuō)實(shí)話第一眼看上去根本不知道這東西干啥用的，dumpapp這文件看起來(lái)就跟可執(zhí)行文件似的，但事實(shí)上它又不是exe，用記事本打開(kāi)一看，是Python3的文件，我也是醉了…

img

所以使用Python3.x來(lái)運(yùn)行這個(gè)文件即可。（由于他還引用了stetho_open.py，為了看起來(lái)不那么別扭，我把幾個(gè)文件都整合在一齊，搞了一個(gè)dump.py） 這里我并沒(méi)有注冊(cè)任何插件，但是由于Stetho自帶了幾個(gè)插件，我們可以看看他們的實(shí)現(xiàn)：

例如files插件，來(lái)試用一下：

img

即用戶發(fā)送命令時(shí)，Plugin的dump方法會(huì)被調(diào)用，Plugin通過(guò)dumpContext.getStdout()來(lái)獲取輸出流，將反饋輸出到命令行：

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
其實(shí)這也是重點(diǎn)之一了。我在這里添加了一個(gè)OkHttp的Inspector。 注意：此處有坑，因?yàn)槟銜?huì)發(fā)現(xiàn)用gradle添加的stetho依賴中沒(méi)有StethoInterceptor這個(gè)類(lèi)，你可以到stetho的github頁(yè)面下載一下，同事需要跟你的OkHttp版本對(duì)應(yīng)，因?yàn)?.x跟3.x對(duì)應(yīng)的StethoInterceptor還有差異）： 下載地址： facebook/stetho-okhttp3 facebook/stetho-okhttp 代碼示例如下： public void testOkHttp(){

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

.addNetworkInterceptor(new StethoInterceptor());
菠菜游戲平臺(tái)架設(shè)，需要的請(qǐng)找【大神源碼論壇】dsluntan.com，詳情咨詢企娥3393756370，
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();

}

運(yùn)行這個(gè)函數(shù)，可以看到Network一欄的請(qǐng)求，每項(xiàng)網(wǎng)絡(luò)請(qǐng)求發(fā)出時(shí)，Status處于Pending狀態(tài)，收到回包后，Status等欄目都會(huì)變化，展示httpcode，請(qǐng)求耗時(shí)、回包數(shù)據(jù)類(lèi)型等信息。

img

img

當(dāng)然這不是重點(diǎn)。重點(diǎn)是我們要對(duì)這個(gè)東西改造一下，他是如何抓下包來(lái)發(fā)送給Chrome的呢？ 看一下StethoInterceptor的intercept函數(shù)，寫(xiě)了些注釋?zhuān)?/p>

private final NetworkEventReporter mEventReporter =
NetworkEventReporterImpl.get();
public Response intercept(Chain chain) throws IOException {
// 構(gòu)造一個(gè)獨(dú)特的eventID，一對(duì)網(wǎng)絡(luò)事件（請(qǐng)求和回包）對(duì)應(yīng)一個(gè)eventID
String requestId = mEventReporter.nextRequestId();

Request request = chain.request();

// 準(zhǔn)備發(fā)送請(qǐng)求
RequestBodyHelper requestBodyHelper = null;
if (mEventReporter.isEnabled()) {
  requestBodyHelper = new RequestBodyHelper(mEventReporter, requestId);
  OkHttpInspectorRequest inspectorRequest =
      new OkHttpInspectorRequest(requestId, request, requestBodyHelper);
  // 請(qǐng)求即將發(fā)送，構(gòu)造一個(gè)OkHttpInspectorRequest，報(bào)告給Chrome，此時(shí)Network會(huì)顯示一條請(qǐng)求，處于Pending狀態(tài)
  mEventReporter.requestWillBeSent(inspectorRequest);
}

Response response;
try {
  // 發(fā)送請(qǐng)求，獲得回包
  response = chain.proceed(request);
} catch (IOException e) {
  // 如果發(fā)生了IO Exception，則通知Chrome網(wǎng)絡(luò)請(qǐng)求失敗了，顯示對(duì)應(yīng)的錯(cuò)誤信息
  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已收到，構(gòu)造一個(gè)OkHttpInspectorResponse,發(fā)送給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;

}
菠菜游戲平臺(tái)架設(shè)，需要的請(qǐng)找【大神源碼論壇】dsluntan.com，詳情咨詢企娥3393756370，
所以整個(gè)流程我們可以簡(jiǎn)化為：發(fā)送請(qǐng)求時(shí)，給Chrome發(fā)了條消息，收到請(qǐng)求時(shí)，再給Chrome發(fā)條消息（具體怎么發(fā)的可以看NetworkEventReporterImpl的實(shí)現(xiàn)） 兩條消息通過(guò)EventID聯(lián)系起來(lái)，它們的類(lèi)型分別是OkHttpInspectorRequest 和 OkHttpInspectorResponse，兩者分別繼承自NetworkEventReporter.InspectorRequest和NetworkEventReporter.InspectorResponse。我們只要也繼承自這兩個(gè)類(lèi)，在自己的網(wǎng)絡(luò)庫(kù)發(fā)送和收到請(qǐng)求時(shí)，構(gòu)造一個(gè)Request和Response并發(fā)送給Chrome即可。 發(fā)送部分示例：

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;
    // 重點(diǎn)在這，這兩行代碼一定要加上,StethoInterceptor之所以不需要加，
    // 是因?yàn)镺kHttp本身對(duì)請(qǐng)求采取了職責(zé)鏈?zhǔn)降奶幚恚?    // 雖然在StethoInterceptor的intercept函數(shù)里沒(méi)有進(jìn)行read和close
    // 但是后續(xù)的Interceptor會(huì)進(jìn)行這個(gè)操作，實(shí)際上這里，才把回包數(shù)據(jù)發(fā)送給了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如何實(shí)現(xiàn)，就依賴實(shí)際使用場(chǎng)景了。

總結(jié)
stetho 為開(kāi)發(fā)者提供了一個(gè)很好的調(diào)試手段，但是自帶的基礎(chǔ)功能還比較弱，開(kāi)發(fā)者可以根據(jù)自己的需求去改造。（不過(guò)官網(wǎng)文檔是有點(diǎn)太少了……） 如果說(shuō)這個(gè)工具有啥亮點(diǎn)，想來(lái)想去，大概App跟Chrome的通信，火狐的rhino引擎更可以被稱之為亮點(diǎn)= .=|||3