Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/facebook/stetho

Stetho is a debug bridge for Android applications, enabling the powerful Chrome Developer Tools and much more.
https://github.com/facebook/stetho

Last synced: 5 days ago
JSON representation

Stetho is a debug bridge for Android applications, enabling the powerful Chrome Developer Tools and much more.

Awesome Lists containing this project

README 

        
# Stetho [![Build Status](https://travis-ci.org/facebook/stetho.svg?branch=master)](https://travis-ci.org/facebook/stetho)



[Stetho](https://facebook.github.io/stetho) is a sophisticated debug bridge for Android applications. When enabled,

developers have access to the Chrome Developer Tools feature natively part of

the Chrome desktop browser. Developers can also choose to enable the optional

`dumpapp` tool which offers a powerful command-line interface to application

internals.



Once you complete the set-up instructions below, just start your app and point

your laptop browser to `chrome://inspect`.  Click the "Inspect" button to

begin.



## Set-up



### Download

Download [the latest JARs](https://github.com/facebook/stetho/releases/latest) or grab via Gradle:

```groovy

implementation 'com.facebook.stetho:stetho:1.6.0'

```

or Maven:

```xml



  com.facebook.stetho

  stetho

  1.6.0



```



Only the main `stetho` dependency is strictly required; however, you may also wish to use one of the network helpers:



```groovy

implementation 'com.facebook.stetho:stetho-okhttp3:1.6.0'

```

or:

```groovy

implementation 'com.facebook.stetho:stetho-urlconnection:1.6.0'

```



You can also enable a JavaScript console with:



```groovy

implementation 'com.facebook.stetho:stetho-js-rhino:1.6.0'

```

For more details on how to customize the JavaScript runtime see [stetho-js-rhino](stetho-js-rhino/).



### Putting it together

Integrating with Stetho is intended to be seamless and straightforward for

most existing Android applications.  There is a simple initialization step

which occurs in your `Application` class:



```java

public class MyApplication extends Application {

  public void onCreate() {

    super.onCreate();

    Stetho.initializeWithDefaults(this);

  }

}

```

Also ensure that your `MyApplication` Java class is registered in your `AndroidManifest.xml` file, otherwise you will not see an "Inspect" button in `chrome://inspect/#devices` :



```xml



        

         

                

```



This brings up most of the default configuration but does not enable some

additional hooks (most notably, network inspection).  See below for specific

details on individual subsystems.



### Enable network inspection

If you are using the popular [OkHttp](https://github.com/square/okhttp)

library at the 3.x release, you can use the

[Interceptors](https://github.com/square/okhttp/wiki/Interceptors) system to

automatically hook into your existing stack.  This is currently the simplest

and most straightforward way to enable network inspection:



```java

new OkHttpClient.Builder()

    .addNetworkInterceptor(new StethoInterceptor())

    .build()

```



Note that okhttp 2.x will work as well, but with slightly different syntax and you must use the `stetho-okhttp` artifact (not `stetho-okhttp3`).



As interceptors can modify the request and response, add the Stetho interceptor after all others to get an accurate view of the network traffic.



If you are using `HttpURLConnection`, you can use `StethoURLConnectionManager`

to assist with integration though you should be aware that there are some

caveats with this approach.  In particular, you must explicitly add

`Accept-Encoding: gzip` to the request headers and manually handle compressed

responses in order for Stetho to report compressed payload sizes.



See the [`stetho-sample` project](stetho-sample) for more details.



## Going further



### Custom dumpapp plugins

Custom plugins are the preferred means of extending the `dumpapp` system and

can be added easily during configuration.  Simply replace your configuration

step as such:



```java

Stetho.initialize(Stetho.newInitializerBuilder(context)

    .enableDumpapp(new DumperPluginsProvider() {

      @Override

      public Iterable get() {

        return new Stetho.DefaultDumperPluginsBuilder(context)

            .provide(new MyDumperPlugin())

            .finish();

      }

    })

    .enableWebKitInspector(Stetho.defaultInspectorModulesProvider(context))

    .build())

```



See the [`stetho-sample` project](stetho-sample) for more details.



## Improve Stetho!

See the [CONTRIBUTING.md](CONTRIBUTING.md) file for how to help out.



## License

Stetho is MIT-licensed. See LICENSE file for more details.