AndroidのPriorityBlockingQueueでtake()メソッドを使う方法を徹底解説

PriorityBlockingQueueとは？

サンプルに入る前に、まずPriorityBlockingQueueについて理解しておきましょう。PriorityBlockingQueueは容量制限のない（無界）キューで、優先度キューと同じ順序ルールに従います。つまり、要素は自然順序付け、または指定されたComparatorに基づいて自動的に並べ替えられます。

このキュー最大の特徴はブロッキング機能を持っている点です。take()メソッドを呼び出したときにキューが空であっても、要素が追加されるまでスレッドが自動的に待機するため、メモリ不足（Out of Memory）エラーへの対処にも役立ちます。マルチスレッド環境でのproducer-consumerパターンなどに最適です。

本記事では、AndroidのPriorityBlockingQueueでtake()メソッドを使用する方法を、実際のコード例とともにわかりやすく解説します。

実装手順

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

Android Studioを起動し、「File」→「New Project」を選択して、必要事項を入力のうえ新しいプロジェクトを作成します。

ステップ2：レイアウトファイルを編集する

res/layout/activity_main.xml に以下のコードを記述します。

<?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>

上記のコードでは、PriorityBlockingQueueの要素を画面に表示するためのTextViewを中央に配置しています。

ステップ3：MainActivity.javaを編集する

src/MainActivity.java に以下のコードを記述します。

package com.example.myapplication;
import android.os.Build;
import android.os.Bundle;
import android.support.annotation.RequiresApi;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.TextView;
import java.util.concurrent.PriorityBlockingQueue;
public class MainActivity extends AppCompatActivity {
    PriorityBlockingQueue priorityBlockingQueue;
    @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        priorityBlockingQueue = new PriorityBlockingQueue();
        final TextView actionEvent = findViewById(R.id.actionEvent);
        priorityBlockingQueue.add("sai");
        priorityBlockingQueue.add("ram");
        priorityBlockingQueue.add("krishna");
        priorityBlockingQueue.add("prasad");
        priorityBlockingQueue.add("ram");
        actionEvent.setText("" + priorityBlockingQueue);
        actionEvent.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    actionEvent.setText("" + priorityBlockingQueue.take());
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        });
    }
}

このコードでは、まずadd()メソッドで複数の文字列をキューに追加し、初期状態をTextViewに表示しています。その後、TextViewをタップするとonClick()内でtake()が呼び出され、キューの先頭にある（最も優先度の高い）要素が1つ取り出されて表示されます。take()はInterruptedExceptionをスローする可能性があるため、try-catchでの例外処理が必要な点にも注目してください。

アプリを実行して結果を確認する

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

次に、TextViewをタップしてみてください。take()メソッドによってキューの先頭要素が取り出され、以下のように結果が表示されます。

まとめ

PriorityBlockingQueueのtake()メソッドを使えば、キューが空の場合でもスレッドをブロックしながら安全に要素を取得できます。並列処理やスレッド間のデータ受け渡しを行うAndroidアプリ開発において、非常に有用なクラスなので、ぜひ活用してみてください。