ネットワークトラフィックツールを使用してネットワークトラフィックデータを収集する

ネットワークトラフィックツールはサポートが終了しました。Android Studio 3.0 以降を使用している場合は、Network Profiler を使用して、ネットワーク経由でアプリがデータを転送する方法とタイミングについて調査することをおすすめします。

アプリが生成するネットワークトラフィックは、アプリが稼働しているデバイスのバッテリー寿命に大きな影響を与えます。トラフィックを最適化するには、トラフィックを測定して、ソースを識別する必要があります。ネットワークリクエストの直接的な発生源となるのは、ユーザーアクションや、アプリコード、アプリと通信するサーバーです。

DDMS ツールの一部であるネットワークトラフィックツールを使用すると、アプリがネットワーク経由でデータを転送する方法やタイミングについて確認できます。

このレッスンでは、ソースコードをタグ付けすることでネットワークリクエストを測定、分類する方法と、アプリのネットワークトラフィックをデプロイ、テスト、可視化する方法について説明します。

ネットワークリクエストをタグ付けする

アプリは、さまざまな理由でデバイス上のネットワークハードウェアを使用します。アプリのネットワークリソース使用を適切に最適化するには、アプリがどのくらいの頻度で、どのような理由でネットワークを使用しているのか把握する必要があります。パフォーマンス分析を行うために、ネットワークハードウェアの使用を以下のカテゴリに分類します。

ユーザー開始型ネットワークリクエスト - ユーザーが開始したリクエスト。たとえば、ニュースアプリ内の更新済み記事のリストに対するリクエストが該当します。
アプリ開始型ネットワークリクエスト - ユーザーアクションとは無関係に Android アプリのコード内で開始されたリクエスト。たとえば、ニュースアプリ内で未読記事のテキストをキャッシュする場合のアプリリクエストが該当します。
サーバー開始型ネットワークリクエスト - ユーザーアクションとは無関係にサーバーがアプリに対して開始したリクエスト。たとえば、ニュースアプリ内で新しく利用可能になった記事に関する通知が該当します。

以下では、定数を使用してアプリのソースコードをタグ付けし、トラフィックを 3 つのリクエストタイプのいずれかに分類する手順について説明します。ネットワークトラフィックツールは、トラフィックのタイプごとに色付けできるため、各トラフィックストリームを個別に可視化して最適化することができます。ここで説明する手順では、ユーザー開始型、アプリ開始型、サーバー開始型として識別されるアプリ内スレッドの実行に基づいて、ネットワークトラフィックがレポートされます。

アプリの開発プロジェクトで、ネットワーク使用の各タイプを示す 3 つの定数を定義します。

Kotlin

    const val USER_INITIATED: Int = 0x1000
    const val APP_INITIATED: Int = 0x2000
    const val SERVER_INITIATED: Int = 0x3000

Java

    public static final int USER_INITIATED = 0x1000;
    public static final int APP_INITIATED = 0x2000;
    public static final int SERVER_INITIATED =0x3000;

ネットワークを使用するうえで広く利用されているクラスを検索することで、アプリ内のネットワークコードを見つけます。
1. Android Studio で、[Edit] > [Find] > [Find in Path] を選択します。
2. 次の文字列を [Text to find] フィールドに貼り付けます。
  extends GcmTaskService|extends JobService|extends AbstractThreadedSyncAdapter|HttpUrlConnection|Volley|Glide|HttpClient
3. [Regular expression] チェックボックスをオンにします。
4. [File mask(s)] チェックボックスをオンにして、「*.java」と入力します。
5. [Find] ボタンをクリックします。
前のステップで判明した結果に基づいて、ネットワークリソースを使用するアプリ内の各実行スレッドに対して setThreadStatsTag(int) メソッドを追加して、アプリのネットワークトラフィック使用をタグ付けします。次のサンプルコードをご覧ください。
Kotlin
```
    if (BuildConfig.NETWORK_TEST && Build.VERSION.SDK_INT >= 14) {
        try {
            TrafficStats.setThreadStatsTag(USER_INITIATED)
            // make network request using HttpClient.execute()
        } finally {
            TrafficStats.clearThreadStatsTag()
        }
    }
    
```
Java
```
    if (BuildConfig.NETWORK_TEST && Build.VERSION.SDK_INT >= 14) {
        try {
            TrafficStats.setThreadStatsTag(USER_INITIATED);
            // make network request using HttpClient.execute()
        } finally {
            TrafficStats.clearThreadStatsTag();
        }
    }
    
```
注: タグ設定が実稼働コードに入らないように、必ず、APK を生成する際に使用したビルドタイプに基づいて、このコードの追加を条件付きにしてください。上記の例の場合、BuildConfig.NETWORK_TEST フィールドによって、この APK がテストバージョンであることが示されています。

注: アプリのネットワークトラフィックをタグ付けする方法は、使用している API がネットワークソケットにアクセスして管理する方法に応じて異なります。一部のネットワークライブラリでは、TrafficStats ユーティリティを使用してアプリのトラフィックをタグ付けすることができない場合があります。

ネットワークトラフィックツールを使用したネットワークトラフィックのタグ付けとトラッキングの詳細については、DDMS におけるネットワーク使用の詳細表示をご覧ください。

ネットワークテストのビルドタイプを設定する

パフォーマンステストを実施する場合、APK を可能な限り実稼働ビルドに近づける必要があります。ネットワークテストでこれを実現するには、debug ビルドタイプを使用するのではなく、network-test ビルドタイプを作成します。

Android Studio 内でアプリを開きます。

プロジェクトの build.gradle ファイルを編集して、ネットワークテスト用のデバッグ可能ビルドタイプを作成します。次のサンプルコードをご覧ください。

    android {
        ...
        buildTypes {
            debug {
                // debuggable true is default for the debug buildType
            }
            network-test {
                debuggable true
            }
        }
        ...
    }

ネットワークテスト APK をデプロイする

前の手順で設定した network-test ビルドタイプによって生成された APK をデプロイするには:

テストデバイスで、[開発者向けオプション] が有効になっているか確認します。このオプションを確認し有効にする方法については、ハードウェアデバイスを使用するをご覧ください。
USB ケーブルを使用して、テストデバイスを開発マシンに接続します。
Android Studio で、ウィンドウの左端にある [Build Variants] を選択します。
[Sync Project with Gradle Files] ボタンをクリックして、[Build Variants] リストにアプリモジュールの network-test を入力します。
リストから [network-test] を選択します。
アプリのデバッグ可能バージョンをデバイスにデプロイするには、[Run] > [Debug] を選択します。

ネットワークトラフィックツールを実行する

Android Studio のネットワークトラフィックツールを使用すると、実行中のアプリのネットワークリソース使用状況をリアルタイムで確認できます。

テストの再現性を高めるには、アプリのデータを消去して、アプリを既知の初期状態にしてから開始する必要があります。以下では、これまでのキャッシュデータとネットワークデータを含め、アプリデータをすべて消去する手順について説明します。この手順により、アプリは、以前キャッシュしたすべてのデータを再キャッシュする必要がある状態に戻ります。この手順は必ず行ってください。

ネットワークトラフィックツールを起動して、ネットワークリクエストを可視化するには:

Android Studio を起動して、Android Device Monitor を起動し、ネットワークトラフィックツールを起動します。プロンプトが表示された場合は、受信ネットワーク接続を許可します。
Android Device Monitor ウィンドウの上部にある [DDMS] ボタンをクリックして、[Network Statistics] タブを選択します。このタブが表示されない場合は、ウィンドウを広げて、[Window] > [Reset Perspective] を試してください。
[Devices] タブで、デバイス上にあるデバッグ可能アプリのリストから、デバッグするアプリを選択し、[Network Statistics] タブで [Start] ボタンをクリックします。
注: デバイスに対して [Allow USB Debugging] を求めるプロンプトが表示される場合があります。[OK] を選択してデバッグを続行します。
次の adb コマンドを使用して、アプリデータを消去します。
```
    adb shell pm clear package.name.of.app
    
```
アプリを起動して、アプリの主要なユースケースを実践するテストプランを実行します。このプランでは、ユーザーがアプリを操作していないアプリアイドル時間を許可する必要もあります。これにより、アプリ開始型とサーバー開始型のネットワークアクセスが発生するようになります。
アプリデータを消去し、テストプランをもう一度実行して、テストを繰り返します。テストを数回繰り返して、パフォーマンスデータの再現性を検証します。