Skip to content

Latest commit

 

History

History
223 lines (175 loc) · 10.3 KB

README-JP.md

File metadata and controls

223 lines (175 loc) · 10.3 KB
Raw
build:created version:maven-central

🇨🇳 中文 / 🇯🇵日本語 / 🇬🇧 English

🍼デバッグボットル

アンドロイド Java / Kotlin 開発者ツール

DEMOは今Google Playでダウンロードできます:

Get it on Google Play

実装されている機能

アプリのネットワークトラフィックを記録

この機能は、デバッグボットルがHTTPリクエストとリスポンスをログファイルに書き込む。記録されたログファイルはいつでも見えます。

アクティビティを3D化する

View のデバッグ用途として、画面をグリグリすると 3DCG みたいに View のヒエラルキーを見ることができるようになるツールです。

SharedPreferencesを編集する

アプリが使ってるすべてのSharedPreferencesをランタイム時に編集する。

Strictモードで開発

StrictModeはアプリケーションの動作をもっさりさせる原因となる、 ディスクやネットワークへのアクセスを検知するための仕組みです。使う方とかをオフィシャルサイトで見えます。

クラッシュログ

アプリがクラッシュするとログが保存され、デバッグボトルからログを取得して解析することができます。

Leak Canaryを使用する

Squareのメモリリークを検出するライブラリ Leak Canary を通じて、メモリリークを調査できます。デバッグボトルはすでにLeak Canaryを含んでいるから、その機能は使えます。もっと詳しくはこちらで。

UIフリーズを排除する

一旦UIフリーズが発生となると、デバッグボトルはノティファイで通知して、同じ時にログファイルを作成します。開発者はログファイルで、フリーズの原因を知り、排除するのは可能となります。

アクティビティをいつでも起動する

デバッグボトルはシンプルなエントリーを提供し、アクティビティやRunnableはそのエントリーを通じて起動できます。エントリーは３つあります：

  • すべてのアクティビティエントリー
  • カストマイズインテントエントリー
  • カストマイズRunnableエントリー

構築するには

1. Gradleプロジェクトファイルを構成する

まずはスナップショットリポジトリを配置します。

allprojects {
    repositories {
        ...
        mavenCentral()
    }
}

アプリのプライマリモジュールによるGradleファイルに依頼環境を導入します。

dependencies {
    debugCompile 'com.exyui.android:debug-bottle-runtime:1.0.5'

    // Javaの場合はこうして構築します
    releaseCompile 'com.exyui.android:debug-bottle-noop-java:1.0.5'
    testCompile 'com.exyui.android:debug-bottle-noop-java:1.0.5'

    // Kotlinの場合はこうして構築します
    releaseCompile 'com.exyui.android:debug-bottle-noop-kotlin:1.0.5'
    testCompile 'com.exyui.android:debug-bottle-noop-kotlin:1.0.5'

    compile 'com.android.support:appcompat-v7:23.2.0+'
}

Specially, Debug Bottle not only support API 23+, but also 22. To support API 22, please add dependencies like this:

dependencies {
    debugCompile 'com.exyui.android:debug-bottle-runtime:1.0.5-support22'

    // Javaの場合はこうして構築します
    releaseCompile 'com.exyui.android:debug-bottle-noop-java:1.0.5-support22'
    testCompile 'com.exyui.android:debug-bottle-noop-java:1.0.5-support22'

    // Kotlinの場合はこうして構築します
    releaseCompile 'com.exyui.android:debug-bottle-noop-kotlin:1.0.5-support22'
    testCompile 'com.exyui.android:debug-bottle-noop-kotlin:1.0.5-support22'

    compile 'com.android.support:appcompat-v7:22+'
}

To support API 23, add dependencies like this:

dependencies {
    debugCompile 'com.exyui.android:debug-bottle-runtime:1.0.5-support23'

    // Javaの場合はこうして構築します
    releaseCompile 'com.exyui.android:debug-bottle-noop-java:1.0.5-support23'
    testCompile 'com.exyui.android:debug-bottle-noop-java:1.0.5-support23'

    // Kotlinの場合はこうして構築します
    releaseCompile 'com.exyui.android:debug-bottle-noop-kotlin:1.0.5-support23'
    testCompile 'com.exyui.android:debug-bottle-noop-kotlin:1.0.5-support23'

    compile 'com.android.support:appcompat-v7:23+'
}

2. Manifestに加入

Manifestにデバッグボトルのプライマリアクティビティを加入します。

<activity
    android:name="com.exyui.android.debugbottle.components.DTDrawerActivity"
    android:theme="@style/Theme.AppCompat.Light"
    android:label="ほげほげツール"/>

「ほげほげツール」はこのツールの名前、欲しいネームを付けてよろしい、ただし空きでは行けません。

3. Applicationにデバッグボトルを注入

まずは「BlockCanaryContext」を実装します。

public class AppBlockCanaryContext extends BlockCanaryContext {...}

そしてデバッグボトルをApplicationに注入します。

public class MyApplication extends Application{
    @Override
    public void onCreate() {
        super.onCreate();
        DTInstaller.install(this)
            .setBlockCanary(new AppBlockCanaryContext(this))
            .setOkHttpClient(httpClient)
            .setInjector("your.package.injector.ContentInjector")
            .setPackageName("your.package")
            .enable()
            .run();
    }
}

Kotlinを使ってる場合は、以下の方法で注入します。

class MyApplication: Application() {
    override fun onCreate() {
        super.onCreate()
        DTInstaller.install(this)
            .setBlockCanary(AppBlockCanaryContext(this))
            .setOkHttpClient(httpClient)
            .setInjector("your.package.injector.ContentInjector")
            .setPackageName("your.package")
            .enable()
            .run()
    }
}

リンク先

License

Debug Bottle

Copyright 2016 Yuriel (http://exyui.com).

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Debug Bottle required features are based on or derives from projects below: