1. はじめに
ConcurrentBag<T> はスレッドセーフで、順序を保証しないコレクションです。その主な特徴と利点は「Bag(バッグ)」という言葉にあり、取り出し時に要素の順序が保証されないことを意味します。つまり、追加した順序に基づいて期待した要素が取り出されるとは限りません。代わりに、ConcurrentBag は特定のシナリオで非常に高速に動作するユニークな最適化を持っています。
ConcurrentBag の特徴
順序がないこと: キュー(FIFO)やスタック(LIFO)とは違い、ConcurrentBag は TryTake() が追加された順序に対して特定の順序で要素を返すと約束しません。これは 重要な違い です。
ローカルアクセス向けの最適化(Thread-Local Storage): ConcurrentBag が存在する主な理由は、要素を追加したスレッドがその要素を取り出す可能性が高いシナリオでのパフォーマンスです。
例: ConcurrentBag — 追加と取り出し
using System.Collections.Concurrent;
ConcurrentBag<string> itemBag = new ConcurrentBag<string>();
// 要素の追加
itemBag.Add("ポイント A");
itemBag.Add("ポイント B");
itemBag.Add("ポイント C");
Console.WriteLine($"バッグの要素数: {itemBag.Count}"); // 出力: バッグの要素数: 3
// 要素の取り出し(順序は保証されない!)
if (itemBag.TryTake(out string item1))
{
Console.WriteLine($"取り出した: {item1}"); // "ポイント C"、"ポイント B"、"ポイント A" のどれか
}
if (itemBag.TryTake(out string item2))
{
Console.WriteLine($"取り出した: {item2}");
}
Console.WriteLine($"残りの要素数: {itemBag.Count}"); // 出力: 残りの要素数: 1
このコードを何度か実行すると、取り出し順序が変わることに気づくでしょう。
メソッド Add(), TryTake()
Add(T item): 要素を ConcurrentBag に追加するために使います。この操作はスレッドセーフです。
TryTake(out T item): ConcurrentBag から要素を取り出す試みです。要素が正常に取り出されたら true を返し、バッグが空なら false を返します。重要なのは TryTake がスレッドをブロックしないことです。
2. 使用シナリオ
ConcurrentBag は ConcurrentQueue や ConcurrentStack の代替ではありません。特定のケースで輝きます:
オブジェクト/リソースプール: 再利用可能なオブジェクトのプールがあり、オブジェクトを返したスレッドがそのオブジェクトを再び取ることが多い場合。これにより共有リソースへの競合が減ります。
TPL における動的なタスク配分: Parallel.ForEach や Parallel.For のような構造はローカルバッグと「work-stealing」メカニズムを使って効率的に仕事を分配します。
ConcurrentBag とローカリティ最適化によるタスクプール
using System.Collections.Concurrent;
using System.Threading.Tasks;
using System.Threading;
ConcurrentBag<string> taskPool = new ConcurrentBag<string>();
// 初期タスクでプールを埋める
for (int i = 0; i < 10; i++)
{
taskPool.Add($"タスク {i}");
}
void Worker()
{
// 各スレッドはタスクを取りに行く
while (taskPool.TryTake(out string task))
{
Console.WriteLine($"スレッド {Thread.CurrentThread.ManagedThreadId}: 処理中 {task}");
Thread.Sleep(50); // 作業のシミュレーション
}
Console.WriteLine($"スレッド {Thread.CurrentThread.ManagedThreadId}: 作業終了。");
}
// 複数のワーカースレッドを起動
// Task.Run(Worker);
// Task.Run(Worker);
// Task.Run(Worker);
// Thread.Sleep(1000); // 実行時間を与える
この例では、ConcurrentBag によってスレッドが効率的にタスクを取り、内部構造のおかげでロックが最小化されます。
内部メカニズム
ConcurrentBag はスレッドローカルストレージ(TLS)を使うことで高いパフォーマンスを実現しています。スレッドが要素を追加すると、その要素はスレッドローカルな構造に置かれます。TryTake() のときはまずローカル構造を読んで、空なら他のスレッドやグローバルプールから「work-stealing」を行います。これにより競合が減り、アクセスのローカリティが重要で順序が重要でない場合に優れた選択肢になります。
3. スレッドセーフな辞書
ConcurrentDictionary<TKey, TValue> は最もよく使われるスレッドセーフなコレクションの一つです: 複数スレッドからの安全な追加、読み取り、更新、削除のための高性能な辞書です。
通常の Dictionary<TKey, TValue> は全くスレッドセーフではありません。書き込み(追加/変更/削除)中の読み取りや書き込みは例外(InvalidOperationException)を引き起こしたり、データ破損を招いたりします。
例: 通常の Dictionary の問題(繰り返し)
using System.Collections.Generic;
using System.Threading.Tasks;
Dictionary<int, int> concurrentDictProblem = new Dictionary<int, int>();
void AddToDict(int start, int count)
{
for (int i = 0; i < count; i++)
{
// 同時に追加/変更しようとする試み
// 例外や不正な動作を引き起こす可能性がある
concurrentDictProblem[start + i] = start + i;
}
}
// Mainでの実行例:
try
{
Task t1 = Task.Run(() => AddToDict(0, 10000));
Task t2 = Task.Run(() => AddToDict(5000, 10000)); // キーの重なり
Task.WaitAll(t1, t2);
Console.WriteLine($"(問題ある)辞書の要素数: {concurrentDictProblem.Count}");
}
catch (Exception ex)
{
Console.WriteLine($"通常の辞書でのエラー: {ex.Message}");
}
このコードはほぼ確実に例外を出すか、デッドロックする可能性があります。スレッドセーフの問題によるものです。
4. 基本操作
ConcurrentDictionary は「チェック + アクション」型の専用の原子的操作を提供します。
TryAdd(TKey key, TValue value): 原子的にキーと値のペアを追加します。キーが追加されたら true を返し、すでに存在する場合は false を返します。
ConcurrentDictionary<string, int> scores = new ConcurrentDictionary<string, int>();
if (scores.TryAdd("Alice", 100))
Console.WriteLine("Alice が追加されました。"); // 出力: Alice が追加されました。
if (!scores.TryAdd("Alice", 150))
Console.WriteLine("Alice は既にいます。"); // 出力: Alice は既にいます。
TryGetValue(TKey key, out TValue value): 原子的にキーから値を取得します。
if (scores.TryGetValue("Alice", out int aliceScore))
Console.WriteLine($"Alice のスコア: {aliceScore}"); // 出力: Alice のスコア: 100
TryUpdate(TKey key, TValue newValue, TValue comparisonValue): 現在の値が comparisonValue と等しい場合のみ原子的に更新します。レースを防ぎます。
// 現在の Alice の値 = 100
if (scores.TryUpdate("Alice", 120, 100)) // 100 を 120 に更新
Console.WriteLine("Alice のスコアが 120 に更新されました。"); // 出力: Alice のスコアが 120 に更新されました。
if (!scores.TryUpdate("Alice", 130, 100)) // 現在 120 のため更新されない
Console.WriteLine("Alice のスコアは更新されませんでした(古いデータ)。"); // 出力: ...
TryRemove(TKey key, out TValue value): 原子的にキーで要素を削除します。
if (scores.TryRemove("Alice", out int removedScore))
Console.WriteLine($"Alice が削除されました。スコアは: {removedScore}"); // 出力: Alice が削除されました。スコアは: 120
5. 進んだ原子的操作
次の二つのメソッドは ConcurrentDictionary の仕事の主力で、多くのシナリオをカバーします。
GetOrAdd(TKey key, TValue valueFactory(TKey key)): キーの既存値を原子的に返すか、ファクトリで新しい値を作って追加して返します。キャッシュやユニークなエンティティに最適です。
// 重いオブジェクトをキャッシュする想定
ConcurrentDictionary<int, HeavyObject> objectCache = new ConcurrentDictionary<int, HeavyObject>();
HeavyObject GetOrCreateHeavyObject(int id)
{
// 既にあればそれを返し、なければ作って追加する
return objectCache.GetOrAdd(id, (key) =>
{
Console.WriteLine($"ID: {key} のために新しい HeavyObject を作成しています");
return new HeavyObject(key); // 高コストなオブジェクト作成のシミュレーション
});
}
// Mainで:
HeavyObject obj1 = GetOrCreateHeavyObject(1); // 新規作成
HeavyObject obj2 = GetOrCreateHeavyObject(2); // 新規作成
HeavyObject obj3 = GetOrCreateHeavyObject(1); // 既存の obj1 を返す
AddOrUpdate(TKey key, TValue addValue, Func<TKey, TValue, TValue> updateValueFactory): キーが存在しなければ値を追加し、存在すればファクトリで更新する、という操作を原子的に行います。
- addValue: キーが見つからなかったときに追加する値。
- updateValueFactory: キーと現在の値に基づいて新しい値を計算する関数。
// ページビューのカウント
ConcurrentDictionary<string, int> pageViews = new ConcurrentDictionary<string, int>();
void IncrementPageView(string page)
{
pageViews.AddOrUpdate(page, 1, // 新しいページなら 1 を追加
(key, existingVal) => existingVal + 1); // そうでなければ +1
Console.WriteLine($"ページ '{page}' の訪問回数は {pageViews[page]} 回です。");
}
// Mainで:
IncrementPageView("Home"); // Home: 1
IncrementPageView("About"); // About: 1
IncrementPageView("Home"); // Home: 2
IncrementPageView("Home"); // Home: 3
IncrementPageView("Contact"); // Contact: 1
6. キャッシュや状態管理の使用例
データのキャッシュ: ConcurrentDictionary はインメモリキャッシュに最適です: GetOrAdd によって高コストなオブジェクトの重複作成を防げます。
ユーザーセッションの管理: 異なるリクエストからのデータの安全な保存と更新。
統計の集計: AddOrUpdate を使ってイベント、ビュー、投票などのカウンタをインクリメントするのに便利です。
レジストリ/Service Locator: 異なるスレッドからアクセスされる登録済みサービスやプラグインの保存。
ConcurrentDictionary<TKey, TValue> は高度に最適化されたコレクションで、原子的操作のセットによって辞書を使ったマルチスレッド開発を手作業の同期なしに大幅に簡単にします。
GO TO FULL VERSION