AndroidのCopyOnWriteArraySetでaddAll()を使う方法｜サンプルコードで解説

CopyOnWriteArraySetとは？

CopyOnWriteArraySetは、java.util.concurrentパッケージに属するスレッドセーフなSet実装です。内部ではCopyOnWriteArrayListが使われており、add()やset()など要素を変更する操作が呼ばれるたびに、基盤となる配列の新しいコピーが作成されます。

この仕組みにより、イテレーション中に別スレッドから要素が追加・削除されてもConcurrentModificationExceptionが発生しないため、マルチスレッド環境下でも安全に利用できるのが大きな特徴です。また、Setであるため重複した要素は自動的に排除されます。

本記事では、AndroidアプリでCopyOnWriteArraySetのaddAll()メソッドを使い、複数の要素をまとめて追加する方法を、サンプルコードとともに解説します。

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

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

ステップ2：レイアウトファイル（activity_main.xml）にコードを追加する

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>

上記コードでは、CopyOnWriteArraySetの内容を画面に表示するためのTextViewを1つ配置しています。

ステップ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.Arrays;
import java.util.concurrent.CopyOnWriteArraySet;

public class MainActivity extends AppCompatActivity {
    CopyOnWriteArraySet copyOnWriteArraySet;

    @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        copyOnWriteArraySet = new CopyOnWriteArraySet<String>();
        final TextView actionEvent = findViewById(R.id.actionEvent);

        copyOnWriteArraySet.add("sai");
        copyOnWriteArraySet.add("ram");
        copyOnWriteArraySet.add("krishna");
        copyOnWriteArraySet.add("prasad");
        copyOnWriteArraySet.add("ram"); // 重複は自動的に無視される

        actionEvent.setText("" + copyOnWriteArraySet);
        actionEvent.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                String[] strings = {"satish", "shiva"};
                copyOnWriteArraySet.addAll(Arrays.asList(strings));
                actionEvent.setText("" + copyOnWriteArraySet);
            }
        });
    }
}

このコードでは、まずCopyOnWriteArraySetに4つの名前を追加しています。同じ「ram」を2回追加していますが、Setなので重複分は登録されません。その後、TextViewにクリックリスナーを設定し、タップされたタイミングでaddAll()メソッドを使って配列の要素（satishとshiva）を一括追加しています。

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

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

続いて、画面中央のTextViewをタップしてみてください。addAll()によって「satish」と「shiva」がセットに追加され、以下のように結果が更新されます。

まとめ

CopyOnWriteArraySetは、変更のたびに配列をコピーすることでスレッドセーフ性を確保するSet実装です。addAll()を使えば、Collectionに格納された複数の要素を一度に追加でき、既存の要素との重複も自動的に排除されます。読み取りが多く・書き込みが少ないデータをマルチスレッドで扱う際に特に有効なクラスなので、ぜひ活用してみてください。