【Android】LocalBroadcastManagerの使い方を実例付きでわかりやすく解説

LocalBroadcastManagerとは？

LocalBroadcastManagerは、アプリ内部だけで完結するブロードキャスト（Intent）の送受信を行うためのクラスです。システム全体や他アプリには通知されないため、セキュリティ面でも安全で、アプリ内のコンポーネント間でデータを受け渡したい場合に便利です。

本記事では、実際に動くサンプルプロジェクトを作りながら、LocalBroadcastManagerの基本的な実装手順をステップごとに紹介します。

Step 1：新規プロジェクトの作成

まず、Android Studioを起動し、「File → New Project」から新しいプロジェクトを作成します。必要な情報を入力してプロジェクトの雛形を生成してください。ここでは「Empty Activity」テンプレートを選ぶとスムーズです。

Step 2：レイアウトファイルの作成

次に、res/layout/activity_main.xmlに以下のコードを記述します。画面中央にTextViewを配置し、ここにブロードキャストで受け取った値を表示する構成です。

<?xml version = "1.0" encoding = "utf-8"?>
<LinearLayout xmlns:android = "https://schemas.android.com/apk/res/android"
    xmlns:app = "https://schemas.android.com/apk/res-auto"
    xmlns:tools = "https://schemas.android.com/tools"
    android:layout_width = "match_parent"
    android:gravity = "center"
    android:layout_height = "match_parent"
    tools:context = ".MainActivity"
    android:orientation = "vertical">
    <TextView
        android:id = "@+id/actionEvent"
        android:textSize = "40sp"
        android:layout_marginTop = "30dp"
        android:layout_width = "wrap_content"
        android:layout_height = "match_parent" />
</LinearLayout>

上記のコードでは、ブロードキャストで受け取ったデータを表示するためのTextViewを1つ配置しています。

Step 3：MainActivityへの実装

続いて、src/MainActivity.javaに以下のコードを追加します。レシーバーの登録、クリック時のブロードキャスト送信、受信後の表示更新までを一通り実装しています。

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.os.Bundle;
import android.support.v4.content.LocalBroadcastManager;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity {
    TextView actionEvent;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // カスタムアクション名でローカルブロードキャストのレシーバーを登録
        LocalBroadcastManager.getInstance(this).registerReceiver(mMessageReceiver,
                new IntentFilter("custom-action-local-broadcast"));

        actionEvent = findViewById(R.id.actionEvent);
        actionEvent.setText("Click");

        // クリック時にローカルブロードキャストを送信
        actionEvent.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Intent intent = new Intent("custom-action-local-broadcast");
                intent.putExtra("name", "Tutorialspoint.com");
                LocalBroadcastManager.getInstance(MainActivity.this).sendBroadcast(intent);
            }
        });
    }

    // ブロードキャストを受信するレシーバー
    private BroadcastReceiver mMessageReceiver = new BroadcastReceiver() {
        @Override
        public void onReceive(Context context, Intent intent) {
            // Intentに含まれる追加データを取得
            String message = intent.getStringExtra("name");
            actionEvent.setText(message);
        }
    };
}

ポイントは以下の3点です。

• registerReceiver()：カスタムアクション「custom-action-local-broadcast」に対してレシーバーを登録します。
• sendBroadcast()：TextViewクリック時にIntentへ付加情報（extra）をセットしてブロードキャストを送信します。
• onReceive()：受信したIntentからデータを取り出し、TextViewの表示内容を更新します。

アプリの実行と動作確認

それでは、アプリを実際に起動してみましょう。Android端末をPCに接続した状態で、Android Studioのツールバーにある「Run」アイコンをクリックし、接続中のデバイスを選択して実行します。

初回起動時のデフォルト画面は以下のように表示されます。

次に、画面上のTextViewをタップしてみてください。ブロードキャストが送信・受信され、以下のように結果が表示されます。

注意点：LocalBroadcastManagerは非推奨（Deprecated）

補足として、LocalBroadcastManagerは現在非推奨（Deprecated）となっています。公式ドキュメントでは、代わりにLiveDataやKotlin Flow、RxJavaなどのリアクティブな仕組みを利用することが推奨されています。既存コードの保守では引き続き登場するため覚えておいて損はありませんが、新規開発では代替手段の採用を検討しましょう。