6 月 3 日の「#Android11: The Beta Launch Show」にぜひご参加ください。

ネットワーク使用状況を管理する

このレッスンでは、ネットワーク リソースの使用について微調整が可能なアプリを作成する方法を説明します。アプリで多数のネットワーク操作を実行する場合、データを同期する頻度や、Wi-Fi 上でのみアップロードやダウンロードを実行するようにするかどうか、ローミング時にデータを使用するかどうかなど、ユーザーがアプリのデータを制御できるようにユーザー設定を提供する必要があります。このような制御をユーザーに許可すると、ユーザー自身がアプリのデータ使用量を細かく管理できるため、上限に近づいたときにユーザーがバックグラウンド データへのアプリのアクセスを無効にする可能性が低くなります。

一定期間のネットワーク接続の数や種類など、アプリのネットワーク使用状況について詳しくは、Web アプリNetwork Profiler を使用してネットワーク トラフィックを検査するをご覧ください。ダウンロードとネットワーク接続が電池寿命に与える影響を最小限に抑える方法に関する一般的なガイドラインについては、電池寿命を最適化するおよび電池を消耗させずにデータを転送するをご覧ください。

ネットワーク接続サンプルもご確認ください。

デバイスのネットワーク接続を確認する

デバイスには、さまざまなタイプのネットワーク接続があります。このレッスンでは、Wi-Fi またはモバイル ネットワーク接続に焦点を当てて説明します。使用できるネットワーク タイプの完全なリストについては、ConnectivityManager をご覧ください。

通常、Wi-Fi は高速です。また、モバイル データは従量制であることが多く、高額になる可能性があります。アプリを使う場合の戦略として一般的なのが、大量のデータを取得するのは Wi-Fi ネットワークを利用できるときだけにするというものです。

ネットワーク操作を実行する前に、ネットワーク接続の状態を確認することをおすすめします。そうすれば、知らないうち誤った無線通信がアプリで使用されるのを防ぐことができます。ネットワーク接続を利用できない場合は、アプリによる適切な対応が必要になります。ネットワーク接続を確認するには、通常、次のクラスを使用します。

  • ConnectivityManager: ネットワーク接続の状態に関するクエリに応答します。また、ネットワーク接続が変更されたときにアプリに通知します。
  • NetworkInfo: 特定のタイプのネットワーク インターフェースのステータス(モバイル接続または Wi-Fi のどちらが使用されているか)を示します。

次のコード スニペットは、Wi-Fi およびモバイルに対してネットワーク接続をテストします。つまり、これらのネットワーク インターフェースが使用可能かどうか(ネットワーク接続が可能かどうか)、接続されているかどうか(ネットワーク接続が存在し、ソケットを確立してデータを渡すことができるかどうか)を判断します。

Kotlin

    private const val DEBUG_TAG = "NetworkStatusExample"
    ...
    val connMgr = getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager
    var isWifiConn: Boolean = false
    var isMobileConn: Boolean = false
    connMgr.allNetworks.forEach { network ->
        connMgr.getNetworkInfo(network).apply {
            if (type == ConnectivityManager.TYPE_WIFI) {
                isWifiConn = isWifiConn or isConnected
            }
            if (type == ConnectivityManager.TYPE_MOBILE) {
                isMobileConn = isMobileConn or isConnected
            }
        }
    }
    Log.d(DEBUG_TAG, "Wifi connected: $isWifiConn")
    Log.d(DEBUG_TAG, "Mobile connected: $isMobileConn")
    

Java

    private static final String DEBUG_TAG = "NetworkStatusExample";
    ...
    ConnectivityManager connMgr =
            (ConnectivityManager) getSystemService(Context.CONNECTIVITY_SERVICE);
    boolean isWifiConn = false;
    boolean isMobileConn = false;
    for (Network network : connMgr.getAllNetworks()) {
        NetworkInfo networkInfo = connMgr.getNetworkInfo(network);
        if (networkInfo.getType() == ConnectivityManager.TYPE_WIFI) {
            isWifiConn |= networkInfo.isConnected();
        }
        if (networkInfo.getType() == ConnectivityManager.TYPE_MOBILE) {
            isMobileConn |= networkInfo.isConnected();
        }
    }
    Log.d(DEBUG_TAG, "Wifi connected: " + isWifiConn);
    Log.d(DEBUG_TAG, "Mobile connected: " + isMobileConn);
    

判断の基準を、ネットワークが「使用可能」かどうかにしないようにしてください。ネットワーク操作を行う場合は、その前に必ず isConnected() を確認する必要があります。この isConnected() では、不安定なモバイル ネットワーク、機内モード、制限されたバックグラウンド データなども処理されます。

ネットワーク インターフェースが使用可能かどうかをより簡単に確認する方法を次に示します。getActiveNetworkInfo() メソッドは、最初に接続されたネットワーク インターフェースを表す NetworkInfo インスタンスを返します。インターフェースが接続されていない場合(つまり、インターネット接続を利用できない場合)は、null を返します。

Kotlin

    fun isOnline(): Boolean {
        val connMgr = getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager
        val networkInfo: NetworkInfo? = connMgr.activeNetworkInfo
        return networkInfo?.isConnected == true
    }
    

Java

    public boolean isOnline() {
        ConnectivityManager connMgr = (ConnectivityManager)
                getSystemService(Context.CONNECTIVITY_SERVICE);
        NetworkInfo networkInfo = connMgr.getActiveNetworkInfo();
        return (networkInfo != null && networkInfo.isConnected());
    }
    

より詳細な状態の照会には NetworkInfo.DetailedState を使用できますが、これはほとんど必要ありません。

ネットワーク使用状況を管理する

ネットワーク リソースのアプリの使用状況をユーザーが明示的に制御できるようにする設定アクティビティを実装できます。次に例を示します。

  • デバイスが Wi-Fi ネットワークに接続している場合にのみ、ユーザーが動画をアップロードできるようにする。
  • ネットワーク状態や時間間隔などの特定の基準に応じて同期させる(または同期させない)。

ネットワーク アクセスとネットワーク使用状況の管理をサポートするアプリを作成するには、マニフェストに適切な権限とインテント フィルタが必要です。

  • 以下のマニフェスト抜粋には、次の権限が含まれています。
  • ACTION_MANAGE_NETWORK_USAGE アクション(Android 4.0 で導入)のインテント フィルタを宣言することで、データ使用の制御オプションを提供するアクティビティをアプリが定義するように指定できます。ACTION_MANAGE_NETWORK_USAGE には、特定のアプリのネットワーク データ使用量を管理するための設定が示されます。ユーザーによるネットワーク使用の制御を許可する設定アクティビティがアプリにある場合は、そのアクティビティに対してこのインテント フィルタを宣言する必要があります。サンプルアプリでは、このアクションは SettingsActivity クラスによって処理されます。このクラスにより設定用 UI が表示され、ユーザーがフィードをダウンロードするタイミングを決定できます。
    <?xml version="1.0" encoding="utf-8"?>
    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
        package="com.example.android.networkusage"
        ...>

        <uses-sdk android:minSdkVersion="4"
               android:targetSdkVersion="14" />

        <uses-permission android:name="android.permission.INTERNET" />
        <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

        <application
            ...>
            ...
            <activity android:label="SettingsActivity" android:name=".SettingsActivity">
                 <intent-filter>
                    <action android:name="android.intent.action.MANAGE_NETWORK_USAGE" />
                    <category android:name="android.intent.category.DEFAULT" />
              </intent-filter>
            </activity>
        </application>
    </manifest>
    

設定アクティビティを実装する

上記のマニフェスト抜粋でわかるように、サンプルアプリのアクティビティ SettingsActivity には、ACTION_MANAGE_NETWORK_USAGE アクション用のインテント フィルタがあります。 SettingsActivityPreferenceActivity のサブクラスです。このサブクラスによって設定画面(図 1 を参照)が表示され、ユーザーが以下を指定できます。

  • 各 XML フィード エントリの概要を表示するか、各エントリのリンクのみを表示するか。
  • XML フィードを、任意のネットワーク接続が利用可能なときにダウンロードするか、Wi-Fi が利用可能なときだけダウンロードするか。
設定パネル ネットワーク設定の設定

図 1. 設定アクティビティ。

これは SettingsActivity です。OnSharedPreferenceChangeListener が実装されていることに注意してください。ユーザーが設定を変更すると、onSharedPreferenceChanged() が呼び出され、refreshDisplay が true に設定されます。これによりユーザーがメイン アクティビティに戻ったときに、表示が更新されます。

Kotlin

    class SettingsActivity : PreferenceActivity(), OnSharedPreferenceChangeListener {

        override fun onCreate(savedInstanceState: Bundle?) {
            super.onCreate(savedInstanceState)

            // Loads the XML preferences file
            addPreferencesFromResource(R.xml.preferences)
        }

        override fun onResume() {
            super.onResume()

            // Registers a listener whenever a key changes
            preferenceScreen?.sharedPreferences?.registerOnSharedPreferenceChangeListener(this)
        }

        override fun onPause() {
            super.onPause()

            // Unregisters the listener set in onResume().
            // It's best practice to unregister listeners when your app isn't using them to cut down on
            // unnecessary system overhead. You do this in onPause().
            preferenceScreen?.sharedPreferences?.unregisterOnSharedPreferenceChangeListener(this)
        }

        // When the user changes the preferences selection,
        // onSharedPreferenceChanged() restarts the main activity as a new
        // task. Sets the refreshDisplay flag to "true" to indicate that
        // the main activity should update its display.
        // The main activity queries the PreferenceManager to get the latest settings.

        override fun onSharedPreferenceChanged(sharedPreferences: SharedPreferences, key: String) {
            // Sets refreshDisplay to true so that when the user returns to the main
            // activity, the display refreshes to reflect the new settings.
            NetworkActivity.refreshDisplay = true
        }
    }
    

Java

    public class SettingsActivity extends PreferenceActivity implements OnSharedPreferenceChangeListener {

        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);

            // Loads the XML preferences file
            addPreferencesFromResource(R.xml.preferences);
        }

        @Override
        protected void onResume() {
            super.onResume();

            // Registers a listener whenever a key changes
            getPreferenceScreen().getSharedPreferences().registerOnSharedPreferenceChangeListener(this);
        }

        @Override
        protected void onPause() {
            super.onPause();

           // Unregisters the listener set in onResume().
           // It's best practice to unregister listeners when your app isn't using them to cut down on
           // unnecessary system overhead. You do this in onPause().
           getPreferenceScreen().getSharedPreferences().unregisterOnSharedPreferenceChangeListener(this);
        }

        // When the user changes the preferences selection,
        // onSharedPreferenceChanged() restarts the main activity as a new
        // task. Sets the refreshDisplay flag to "true" to indicate that
        // the main activity should update its display.
        // The main activity queries the PreferenceManager to get the latest settings.

        @Override
        public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
            // Sets refreshDisplay to true so that when the user returns to the main
            // activity, the display refreshes to reflect the new settings.
            NetworkActivity.refreshDisplay = true;
        }
    }
    

設定の変更に対応する

ユーザーが設定画面で設定を変更すると、通常は、アプリの動作が影響を受けます。このスニペットでは、アプリは onStart() の設定を確認します。設定がデバイスのネットワーク接続と一致する場合(たとえば、設定が "Wi-Fi" で、デバイスが Wi-Fi 接続されている場合)、アプリによってフィードがダウンロードされ、表示が更新されます。

Kotlin

    class NetworkActivity : Activity() {

        // The BroadcastReceiver that tracks network connectivity changes.
        private lateinit var receiver: NetworkReceiver

        public override fun onCreate(savedInstanceState: Bundle?) {
            super.onCreate(savedInstanceState)

            // Registers BroadcastReceiver to track network connection changes.
            val filter = IntentFilter(ConnectivityManager.CONNECTIVITY_ACTION)
            receiver = NetworkReceiver()
            this.registerReceiver(receiver, filter)
        }

        public override fun onDestroy() {
            super.onDestroy()
            // Unregisters BroadcastReceiver when app is destroyed.
            this.unregisterReceiver(receiver)
        }

        // Refreshes the display if the network connection and the
        // pref settings allow it.

        public override fun onStart() {
            super.onStart()

            // Gets the user's network preference settings
            val sharedPrefs = PreferenceManager.getDefaultSharedPreferences(this)

            // Retrieves a string value for the preferences. The second parameter
            // is the default value to use if a preference value is not found.
            sPref = sharedPrefs.getString("listPref", "Wi-Fi")

            updateConnectedFlags()

            if (refreshDisplay) {
                loadPage()
            }
        }

        // Checks the network connection and sets the wifiConnected and mobileConnected
        // variables accordingly.
        fun updateConnectedFlags() {
            val connMgr = getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager

            val activeInfo: NetworkInfo? = connMgr.activeNetworkInfo
            if (activeInfo?.isConnected == true) {
                wifiConnected = activeInfo.type == ConnectivityManager.TYPE_WIFI
                mobileConnected = activeInfo.type == ConnectivityManager.TYPE_MOBILE
            } else {
                wifiConnected = false
                mobileConnected = false
            }
        }

        // Uses AsyncTask subclass to download the XML feed from stackoverflow.com.
        fun loadPage() {
            if (sPref == ANY && (wifiConnected || mobileConnected) || sPref == WIFI && wifiConnected) {
                // AsyncTask subclass
                DownloadXmlTask().execute(URL)
            } else {
                showErrorPage()
            }
        }

        companion object {

            const val WIFI = "Wi-Fi"
            const val ANY = "Any"
            const val SO_URL = "http://stackoverflow.com/feeds/tag?tagnames=android&sort;=newest"

            // Whether there is a Wi-Fi connection.
            private var wifiConnected = false
            // Whether there is a mobile connection.
            private var mobileConnected = false
            // Whether the display should be refreshed.
            var refreshDisplay = true

            // The user's current network preference setting.
            var sPref: String? = null
        }
    ...

    }
    

Java

    public class NetworkActivity extends Activity {
        public static final String WIFI = "Wi-Fi";
        public static final String ANY = "Any";
        private static final String URL = "http://stackoverflow.com/feeds/tag?tagnames=android&sort;=newest";

        // Whether there is a Wi-Fi connection.
        private static boolean wifiConnected = false;
        // Whether there is a mobile connection.
        private static boolean mobileConnected = false;
        // Whether the display should be refreshed.
        public static boolean refreshDisplay = true;

        // The user's current network preference setting.
        public static String sPref = null;

        // The BroadcastReceiver that tracks network connectivity changes.
        private NetworkReceiver receiver = new NetworkReceiver();

        @Override
        public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);

            // Registers BroadcastReceiver to track network connection changes.
            IntentFilter filter = new IntentFilter(ConnectivityManager.CONNECTIVITY_ACTION);
            receiver = new NetworkReceiver();
            this.registerReceiver(receiver, filter);
        }

        @Override
        public void onDestroy() {
            super.onDestroy();
            // Unregisters BroadcastReceiver when app is destroyed.
            if (receiver != null) {
                this.unregisterReceiver(receiver);
            }
        }

        // Refreshes the display if the network connection and the
        // pref settings allow it.

        @Override
        public void onStart () {
            super.onStart();

            // Gets the user's network preference settings
            SharedPreferences sharedPrefs = PreferenceManager.getDefaultSharedPreferences(this);

            // Retrieves a string value for the preferences. The second parameter
            // is the default value to use if a preference value is not found.
            sPref = sharedPrefs.getString("listPref", "Wi-Fi");

            updateConnectedFlags();

            if(refreshDisplay){
                loadPage();
            }
        }

        // Checks the network connection and sets the wifiConnected and mobileConnected
        // variables accordingly.
        public void updateConnectedFlags() {
            ConnectivityManager connMgr = (ConnectivityManager)
                    getSystemService(Context.CONNECTIVITY_SERVICE);

            NetworkInfo activeInfo = connMgr.getActiveNetworkInfo();
            if (activeInfo != null && activeInfo.isConnected()) {
                wifiConnected = activeInfo.getType() == ConnectivityManager.TYPE_WIFI;
                mobileConnected = activeInfo.getType() == ConnectivityManager.TYPE_MOBILE;
            } else {
                wifiConnected = false;
                mobileConnected = false;
            }
        }

        // Uses AsyncTask subclass to download the XML feed from stackoverflow.com.
        public void loadPage() {
            if (((sPref.equals(ANY)) && (wifiConnected || mobileConnected))
                    || ((sPref.equals(WIFI)) && (wifiConnected))) {
                // AsyncTask subclass
                new DownloadXmlTask().execute(URL);
            } else {
                showErrorPage();
            }
        }
    ...

    }
    

接続の変更を検出する

パズルの最後のピースは BroadcastReceiver サブクラス、NetworkReceiver です。デバイスのネットワーク接続が変更されると、NetworkReceiverCONNECTIVITY_ACTION アクションを傍受してネットワーク接続ステータスを確認し、それに応じて wifiConnected フラグと mobileConnected フラグを true/false に設定します。その結果、ユーザーが次にアプリに戻ったとき、NetworkActivity.refreshDisplaytrue に設定されている場合にのみ、アプリによって最新のフィードがダウンロードされて表示が更新されます。

不必要に呼び出される BroadcastReceiver をセットアップすると、システム リソースの消耗につながる可能性があります。サンプルアプリは onCreate()BroadcastReceiver NetworkReceiver を登録し、onDestroy() で登録解除します。これは、マニフェストで <receiver> を宣言するよりも軽量です。マニフェストで <receiver> を宣言すると、数週間アプリを実行していなくても、この宣言によっていつでも起動できます。メイン アクティビティで NetworkReceiver を登録して登録解除すると、ユーザーがアプリを離れたら、そのアプリは起動されなくなります。マニフェストで <receiver> 宣言し、それを必要とする場所が正確にわかっている場合は、setComponentEnabledSetting() を使用して、必要に応じてその設定を有効および無効にできます。

これは NetworkReceiver です。

Kotlin

    class NetworkReceiver : BroadcastReceiver() {

        override fun onReceive(context: Context, intent: Intent) {
            val conn = context.getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager
            val networkInfo: NetworkInfo? = conn.activeNetworkInfo

            // Checks the user prefs and the network connection. Based on the result, decides whether
            // to refresh the display or keep the current display.
            // If the userpref is Wi-Fi only, checks to see if the device has a Wi-Fi connection.
            if (WIFI == sPref && networkInfo?.type == ConnectivityManager.TYPE_WIFI) {
                // If device has its Wi-Fi connection, sets refreshDisplay
                // to true. This causes the display to be refreshed when the user
                // returns to the app.
                refreshDisplay = true
                Toast.makeText(context, R.string.wifi_connected, Toast.LENGTH_SHORT).show()

                // If the setting is ANY network and there is a network connection
                // (which by process of elimination would be mobile), sets refreshDisplay to true.
            } else if (ANY == sPref && networkInfo != null) {
                refreshDisplay = true

                // Otherwise, the app can't download content--either because there is no network
                // connection (mobile or Wi-Fi), or because the pref setting is WIFI, and there
                // is no Wi-Fi connection.
                // Sets refreshDisplay to false.
            } else {
                refreshDisplay = false
                Toast.makeText(context, R.string.lost_connection, Toast.LENGTH_SHORT).show()
            }
        }
    }
    

Java

    public class NetworkReceiver extends BroadcastReceiver {

        @Override
        public void onReceive(Context context, Intent intent) {
            ConnectivityManager conn =  (ConnectivityManager)
                context.getSystemService(Context.CONNECTIVITY_SERVICE);
            NetworkInfo networkInfo = conn.getActiveNetworkInfo();

            // Checks the user prefs and the network connection. Based on the result, decides whether
            // to refresh the display or keep the current display.
            // If the userpref is Wi-Fi only, checks to see if the device has a Wi-Fi connection.
            if (WIFI.equals(sPref) && networkInfo != null
                && networkInfo.getType() == ConnectivityManager.TYPE_WIFI) {
                // If device has its Wi-Fi connection, sets refreshDisplay
                // to true. This causes the display to be refreshed when the user
                // returns to the app.
                refreshDisplay = true;
                Toast.makeText(context, R.string.wifi_connected, Toast.LENGTH_SHORT).show();

            // If the setting is ANY network and there is a network connection
            // (which by process of elimination would be mobile), sets refreshDisplay to true.
            } else if (ANY.equals(sPref) && networkInfo != null) {
                refreshDisplay = true;

            // Otherwise, the app can't download content--either because there is no network
            // connection (mobile or Wi-Fi), or because the pref setting is WIFI, and there
            // is no Wi-Fi connection.
            // Sets refreshDisplay to false.
            } else {
                refreshDisplay = false;
                Toast.makeText(context, R.string.lost_connection, Toast.LENGTH_SHORT).show();
            }
        }
    }