AndroidでBroadcastReceiverをプログラムから動的に登録する方法【サンプルコード付き】

この記事では、AndroidアプリでBroadcastReceiver（ブロードキャストレシーバー）をマニフェストに静的に宣言する代わりに、Javaコードから動的に登録・解除する方法を、ステップごとのサンプルコードとともに解説します。例として、ネットワーク接続状態の変化を検知してToastを表示するレシーバーを実装していきます。

ステップ1：Android Studioで新規プロジェクトを作成する

Android Studioを起動し、メニューから「File」→「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成してください。

ステップ2：レイアウトファイル（activity_main.xml）を編集する

res/layout/activity_main.xml に以下のコードを追加します。ここでは、画面中央に「Hello World」と表示するだけのシンプルなRelativeLayoutを定義しています。

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="https://schemas.android.com/apk/res/android"
    xmlns:tools="https://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">
    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World"
        android:layout_centerInParent="true"/>
</RelativeLayout>

ステップ3：MainActivity.java にレシーバーの登録・解除を実装する

src/MainActivity.java に以下のコードを追加します。ポイントは次の2つです。

• onStart()：IntentFilterで受け取りたいアクション（ここでは CONNECTIVITY_ACTION）を指定し、registerReceiver() でレシーバーを登録する
• onStop()：unregisterReceiver() でレシーバーを解除し、メモリリークを防ぐ

このように実装することで、アクティビティが画面に表示されている間だけブロードキャストを受信できるようになります。

import android.content.IntentFilter;
import android.net.ConnectivityManager;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
public class MainActivity extends AppCompatActivity {
    ExampleBroadcastReceiver exampleBroadcastReceiver = new ExampleBroadcastReceiver();
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
    protected void onStart(){
        super.onStart();
        IntentFilter filter = new IntentFilter(ConnectivityManager.CONNECTIVITY_ACTION);
        registerReceiver(exampleBroadcastReceiver, filter);
    }
    @Override
    protected void onStop(){
        super.onStop();
        unregisterReceiver(exampleBroadcastReceiver);
    }
}

ステップ4：ExampleBroadcastReceiverクラスを作成する

新しいJavaクラス「ExampleBroadcastReceiver.java」を作成し、以下のコードを記述します。onReceive() メソッド内で受信したインテントのアクションを判定し、EXTRA_NO_CONNECTIVITY の値に応じて、接続時は「Connected」、切断時は「Disconnected」というToastを表示します。

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.net.ConnectivityManager;
import android.widget.Toast;
class ExampleBroadcastReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {
        if (ConnectivityManager.CONNECTIVITY_ACTION.equals(intent.getAction())) {
            boolean noConnectivity = intent.getBooleanExtra(ConnectivityManager.EXTRA_NO_CONNECTIVITY, false);
            if (noConnectivity) {
                Toast.makeText(context, "Disconnected", Toast.LENGTH_SHORT).show();
            } else {
                Toast.makeText(context, "Connected", Toast.LENGTH_SHORT).show();
            }
        }
    }
}

ステップ5：AndroidManifest.xml を編集する

androidManifest.xml に以下のコードを追加します。動的登録の場合、レシーバーをマニフェストに宣言する必要はありません。ランチャーとして起動する MainActivity の宣言だけで十分です。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android" package="app.com.sample">
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

アプリを実行して動作を確認する

それでは、実際にアプリを実行してみましょう。ここでは、実機のAndroidスマートフォンをPCに接続しているものとします。Android Studioでプロジェクト内のいずれかのアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックしてください。実行デバイスとして自分のスマートフォンを選択すると、端末にアプリの初期画面が表示されます。

動作確認の際は、端末の機内モードのオン／オフを切り替えてみてください。ネットワーク接続状態の変化をレシーバーが検知し、接続時には「Connected」、切断時には「Disconnected」というToastが画面に表示されるはずです。

補足：CONNECTIVITY_ACTIONは非推奨

なお、ConnectivityManager.CONNECTIVITY_ACTION は API レベル28以降で非推奨（deprecated）となっています。また、Android 7.0（API 24）以降をターゲットとするアプリでは、マニフェストに静的に宣言したレシーバーではこのブロードキャストを受信できません。最新のプロジェクトでは、NetworkCallback（registerNetworkCallback()）による監視が推奨されています。さらに、Android 13（API 33）以降をターゲットとする場合、システムブロードキャスト以外を受信するコンテキスト登録レシーバーには、RECEIVER_EXPORTED または RECEIVER_NOT_EXPORTED フラグの指定が必要になる点にも注意してください。本記事のコードは、BroadcastReceiverを動的に登録する仕組みそのものを理解するためのサンプルとしてご活用ください。