ゆっちのBlog

java.util.ConcurrentModificationException 対処法

Java

今日のエントリーも J2SE5.0 時代の古いものです。

しかし、あまり知られていない（目にする機会が少ない）と思われるのでブログ更新用のネタとしました。

今回の問題は二つのスレッドが並行して List オブジェクトにアクセスするよくある問題です。

ここで思い出してください。

Java の Iterator は Fail-Fast に設計されています。

これはイテレーション処理開始後にコレクションの内容が変更されたことを検出したら直ち java.util.ConcurrentModificationException をスローします。

これを回避するには一番手っ取り早いのは synchronized ブロックを使って制御するのが楽です。

synchronizedList() を使ってるから大丈夫だと思っている人は泣いてください。（ヲヒ

Iterator なめたらあかんぜよ！

さて、いったい何を言いたいのか良く解らないと思うので簡潔にまとめていないダラダラとしたサンプルコードをご覧ください。

package jp.yucchi.girlfriends_cme;

import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 *
 * @author Yucchi
 */
class GirlFriends_1 {

    private final List<String> girlFriends;

    GirlFriends_1(List<String> girlFriends) {
        this.girlFriends = girlFriends;
    }

    List<String> updateGirlFriend() {
        Thread.currentThread().setName(" Girls_1");
        girlFriends.add("北川景子");
        girlFriends.add("桐谷美玲");
        girlFriends.add("新垣結衣");
        girlFriends.add("剛力彩芽");

        girlFriends.forEach(e -> {
            System.out.println(e + Thread.currentThread().getName());
            try {
                TimeUnit.MILLISECONDS.sleep(1_000);
            } catch (InterruptedException ex) {
                Logger.getLogger(GirlFriends_1.class.getName()).log(Level.SEVERE, null, ex);
            }
        });

        return girlFriends;

    }
}

package jp.yucchi.girlfriends_cme;

import java.util.List;

import java.util.concurrent.TimeUnit;

import java.util.logging.Level;

import java.util.logging.Logger;

/**

* @author Yucchi

class GirlFriends_1 {

private final List<String> girlFriends;

GirlFriends_1(List<String> girlFriends) {

this.girlFriends = girlFriends;

}

List<String> updateGirlFriend() {

Thread.currentThread().setName(" Girls_1");

girlFriends.add("北川景子");

girlFriends.add("桐谷美玲");

girlFriends.add("新垣結衣");

girlFriends.add("剛力彩芽");

girlFriends.forEach(e -> {

System.out.println(e + Thread.currentThread().getName());

try {

TimeUnit.MILLISECONDS.sleep(1_000);

} catch (InterruptedException ex) {

Logger.getLogger(GirlFriends_1.class.getName()).log(Level.SEVERE, null, ex);

}

});

return girlFriends;

}

package jp.yucchi.girlfriends_cme;

import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 *
 * @author Yucchi
 */
class GirlFriends_2 {

    private final List<String> girlFriends;

    GirlFriends_2(List<String> girlFriends) {
        this.girlFriends = girlFriends;
    }

    List<String> updateGirlFriend() {
        Thread.currentThread().setName(" Girls_2");
        try {
            TimeUnit.MILLISECONDS.sleep(1_000);
        } catch (InterruptedException ex) {
            Logger.getLogger(GirlFriends_1.class.getName()).log(Level.SEVERE, null, ex);
        }
        girlFriends.remove("北川景子");
        girlFriends.remove("桐谷美玲");
        girlFriends.remove("新垣結衣");
        girlFriends.remove("剛力彩芽");

        girlFriends.forEach(e -> {
            System.out.println(e + Thread.currentThread().getName());
        });

        return girlFriends;
    }

}

package jp.yucchi.girlfriends_cme;

import java.util.List;

import java.util.concurrent.TimeUnit;

import java.util.logging.Level;

import java.util.logging.Logger;

/**

* @author Yucchi

class GirlFriends_2 {

private final List<String> girlFriends;

GirlFriends_2(List<String> girlFriends) {

this.girlFriends = girlFriends;

}

List<String> updateGirlFriend() {

Thread.currentThread().setName(" Girls_2");

try {

TimeUnit.MILLISECONDS.sleep(1_000);

} catch (InterruptedException ex) {

Logger.getLogger(GirlFriends_1.class.getName()).log(Level.SEVERE, null, ex);

}

girlFriends.remove("北川景子");

girlFriends.remove("桐谷美玲");

girlFriends.remove("新垣結衣");

girlFriends.remove("剛力彩芽");

girlFriends.forEach(e -> {

System.out.println(e + Thread.currentThread().getName());

});

return girlFriends;

}

package jp.yucchi.girlfriends_cme;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 *
 * @author Yucchi
 */
public class GirlFriends_CME {

    public static void main(String[] args) {

        List<String> girlFriends = new ArrayList<>();

        girlFriends.add("堀北真希");

        GirlFriends_1 girlFriend_1 = new GirlFriends_1(girlFriends);
        GirlFriends_2 girlFriend_2 = new GirlFriends_2(girlFriends);

        CompletableFuture<List<String>> girls_1 = CompletableFuture.supplyAsync(() -> girlFriend_1.updateGirlFriend());
        CompletableFuture<List<String>> girls_2 = CompletableFuture.supplyAsync(() -> girlFriend_2.updateGirlFriend());

        CompletableFuture<Void> allTask = CompletableFuture.allOf(girls_1, girls_2);
        allTask.join();

        girlFriends.add("綾瀬はるか");

        if (allTask.isDone()) {
            try {
                System.out.println("GirlFriend_1 List");
                girls_1.get().forEach(System.out::println);
                System.out.println("GirlFriend_2 List");
                girls_2.get().forEach(System.out::println);
            } catch (InterruptedException | ExecutionException ex) {
                Logger.getLogger(GirlFriends_CME.class.getName()).log(Level.SEVERE, null, ex);
            }
        }

        try {
            TimeUnit.MILLISECONDS.sleep(1_000);
            girlFriends.add("新垣結衣");
            girlFriends.add("剛力彩芽");
        } catch (InterruptedException ex) {
            Logger.getLogger(GirlFriends_1.class.getName()).log(Level.SEVERE, null, ex);
        }

        System.out.println("GirlFriend List");
        girlFriends.forEach(System.out::println);
    }

}

package jp.yucchi.girlfriends_cme;

import java.util.ArrayList;

import java.util.List;

import java.util.concurrent.CompletableFuture;

import java.util.concurrent.ExecutionException;

import java.util.concurrent.TimeUnit;

import java.util.logging.Level;

import java.util.logging.Logger;

/**

* @author Yucchi

public class GirlFriends_CME {

public static void main(String[] args) {

List<String> girlFriends = new ArrayList<>();

girlFriends.add("堀北真希");

GirlFriends_1 girlFriend_1 = new GirlFriends_1(girlFriends);

GirlFriends_2 girlFriend_2 = new GirlFriends_2(girlFriends);

CompletableFuture<List<String>> girls_1 = CompletableFuture.supplyAsync(() -> girlFriend_1.updateGirlFriend());

CompletableFuture<List<String>> girls_2 = CompletableFuture.supplyAsync(() -> girlFriend_2.updateGirlFriend());

CompletableFuture<Void> allTask = CompletableFuture.allOf(girls_1, girls_2);

allTask.join();

girlFriends.add("綾瀬はるか");

if (allTask.isDone()) {

try {

System.out.println("GirlFriend_1 List");

girls_1.get().forEach(System.out::println);

System.out.println("GirlFriend_2 List");

girls_2.get().forEach(System.out::println);

} catch (InterruptedException | ExecutionException ex) {

Logger.getLogger(GirlFriends_CME.class.getName()).log(Level.SEVERE, null, ex);

}

try {

TimeUnit.MILLISECONDS.sleep(1_000);

girlFriends.add("新垣結衣");

girlFriends.add("剛力彩芽");

} catch (InterruptedException ex) {

Logger.getLogger(GirlFriends_1.class.getName()).log(Level.SEVERE, null, ex);

}

System.out.println("GirlFriend List");

girlFriends.forEach(System.out::println);

}

このプログラムの実行結果は次のような実行時エラーがでます。

堀北真希 Girls_1
北川景子 Girls_1
堀北真希 Girls_2
Exception in thread “main” java.util.concurrent.CompletionException: java.util.ConcurrentModificationException
    at java.util.concurrent.CompletableFuture.encodeThrowable(CompletableFuture.java:273)
    at java.util.concurrent.CompletableFuture.completeThrowable(CompletableFuture.java:280)
    at java.util.concurrent.CompletableFuture$AsyncSupply.run(CompletableFuture.java:1584)
    at java.util.concurrent.CompletableFuture$AsyncSupply.exec(CompletableFuture.java:1574)
    at java.util.concurrent.ForkJoinTask.doExec(ForkJoinTask.java:289)
    at java.util.concurrent.ForkJoinPool$WorkQueue.runTask(ForkJoinPool.java:1056)
    at java.util.concurrent.ForkJoinPool.runWorker(ForkJoinPool.java:1689)
    at java.util.concurrent.ForkJoinWorkerThread.run(ForkJoinWorkerThread.java:157)
Caused by: java.util.ConcurrentModificationException
    at java.util.ArrayList.forEach(ArrayList.java:1252)
    at jp.yucchi.girlfriends_cme.GirlFriends_1.updateGirlFriend(GirlFriends_1.java:27)
    at jp.yucchi.girlfriends_cme.GirlFriends_CME.lambda$main$0(GirlFriends_CME.java:26)
    at jp.yucchi.girlfriends_cme.GirlFriends_CME$$Lambda$1/424058530.get(Unknown Source)
    at java.util.concurrent.CompletableFuture$AsyncSupply.run(CompletableFuture.java:1582)
    … 5 more
Java Result: 1

このプログラムは、GirlFriends_1 スレッドで要素を追加し、イテレーション処理を要素を一つ出力させるごとに一秒間スレッドをスリープさせています。

GirlFriends_2 スレッドでは、要素の削除処理の開始を一秒遅らせています。

GirlFriends_1 スレッドのイテレーション処理中に GirlFriends_2 スレッドによって List の内容が変更されてしまいます。

二つのスレッドで一つの List に何も考えずに並行処理している無残な結果が悲しいですね。

では、安全に並行処理するために synchronized ブロックを使って終わりではつまらないのでもう一つの解決方法を紹介します。

これを使う機会って滅多にないでしょうけど java.util.concurrent.CopyOnWriteArrayList<E> ってのがあります。

API ドキュメントには次のように書かれています。

基になる配列の新しいコピーを作成することにより、すべての推移的操作(add、setなど)が実装されるArrayListのスレッド・セーフな変数です。
通常、これは非常に効率が悪いのですが、トラバーサル操作が変更を数の点で大幅に上回る場合には、代替手段よりも効率が良い場合があります。
また、これは、トラバーサルを同期できない場合や、同期することを望まないが、並行スレッド間の干渉を排除する必要がある場合に有用です。
「スナップショット」スタイルのイテレータ・メソッドは、イテレータの作成時点での配列状態への参照を使用します。
この配列がイテレータの有効期間中に変更されることは決してないため、干渉は不可能であり、イテレータはConcurrentModificationExceptionをスローしないことが保証されます。
イテレータは、イテレータの作成以降のリストへの追加、削除、または変更を反映しません。
イテレータ自体に対する要素変更操作(remove、setおよびadd)はサポートされません。
これらのメソッドは、UnsupportedOperationExceptionをスローします。
nullを含むすべての要素が許可されます。
メモリー整合性効果: ほかの並行処理コレクションと同様、オブジェクトをCopyOnWriteArrayListに配置する前のスレッド内のアクションは、
別のスレッドでのその要素へのアクセスまたはCopyOnWriteArrayListからの削除に続くアクションよりも前に発生します。

今回のケースではお手軽に使えそうですね。

そう言うことでまたダラダラとコードをご覧ください。と、思ったけど List を CopyOnWriteArrayList に変更するだけなのでやめておきます。

いちおう、 GitHub にアップしておきますので見たい方はどうぞ。

https://github.com/Yucchi-1995/GirlFriends

プログラムの実行結果は次のようになります。

堀北真希 Girls_1
北川景子 Girls_1
堀北真希 Girls_2
桐谷美玲 Girls_1
新垣結衣 Girls_1
剛力彩芽 Girls_1
GirlFriend_1 List
堀北真希
綾瀬はるか
GirlFriend_2 List
堀北真希
綾瀬はるか
GirlFriend List
堀北真希
綾瀬はるか
新垣結衣
剛力彩芽

java.util.ConcurrentModificationException が投げられることなく並行処理が完了しています。

とても簡単です。

API ドキュメントにも書いてありますが CopyOnWriteArrayList はイテレータの作成時点での配列状態への参照を使用し、

この配列がイテレータの有効期間中に変更されることは決してないと言い切っているとおり、

プログラムの実行結果より Girls_1 スレッド、Girls_2 スレッドのイテレーション処理出力がそのとおりに出力されているのが確認できます。

堀北真希 Girls_1
北川景子 Girls_1
堀北真希 Girls_2
桐谷美玲 Girls_1
新垣結衣 Girls_1
剛力彩芽 Girls_1

そして、Girls_1 スレッド、Girls_2 スレッドから返される List の要素は「堀北真希」の一つとなります。

GirlFriend_1 List、GirlFriend_2 List の出力が

GirlFriend_1 List
堀北真希
綾瀬はるか
GirlFriend_2 List
堀北真希
綾瀬はるか

となっているのは main スレッドに戻ってから「綾瀬はるか」が追加され出力されているからです。

そして、最後に「新垣結衣」と「剛力彩芽」を追加して List を表示させています。

CopyOnWriteArrayList って本当に優れものですね！

どうでもいいことですが、このプログラムの欠陥は「北川景子」を削除して、あとで再び List に追加する予定だったのをすっかり忘れてしまったことです。(^_^;)

Hatena タグ: Java

TAGS: Java | 2015年5月8日7:58 AM

« 食事する哲学者の問題（Dining Philosophers Problem） Semaphore で遊ぶその２ Java 8 時代の ConcurrentHashMap で遊んでみた。 »

月	火	水	木	金	土	日
« 1月
						1
2	3	4	5	6	7	8
9	10	11	12	13	14	15
16	17	18	19	20	21	22
23	24	25	26	27	28	29
30	31

java.util.ConcurrentModificationException 対処法

Leave a Reply (or Cancel)

Trackback URL

Recent Comments

Java

NetBeans

カテゴリー

アーカイブ

RSS FEED

ねこび～ん

メタ情報

ゆっちのカレンダー

ゆっちのBlog

java.util.ConcurrentModificationException 対処法

Leave a Reply (or Cancel)

Trackback URL

Popular post ranking

Recent Comments

Java

NetBeans

カテゴリー

アーカイブ

RSS FEED

ねこび～ん

メタ情報

ゆっちのカレンダー