概要
ガベージ コレクションに関連して、弱参照というものがあります。 めったに使うものではありませんが、使い方・使い道を説明します。
サンプル
https://github.com/ufcpp/UfcppSample/tree/master/Chapters/Resource/WeakReference
弱参照とは
「ガベージ コレクション」(以下、GC)では、「他のオブジェクトから参照されているものは生きてる、誰からも参照されていないものはもう不要」という判定方法で、 不要なオブジェクトを削除します。 逆に言うと、誰か1つでも参照を持っているオブジェクトは削除されません。
一方で、「オブジェクトを使いたいんだけども、GC 的には参照していることにしないでほしい」、 「自分以外が全員参照を手放したらその時点で削除対象にしてほしい」というような要件がまれにあります。 こういう、GC の参照探索上は除外してほしい参照を、弱参照(weak reference)といいます。
.NET では、WeakReference クラス(System 名前空間)を使うことで弱参照を扱えます。 例えば以下のように使います。
using System;
using System.Threading.Tasks;
class Program
{
static void Main(string[] args)
{
RunAsync().Wait();
}
private static async Task RunAsync()
{
var obj = (object)123;
var t = StartLoop(new WeakReference<object>(obj));
// 2.5秒後にオブジェクトを消す
await Task.Delay(2500);
obj = null;
GC.Collect();
await t;
}
// 1秒に1回、「参照中」メッセージを表示
static async Task StartLoop(WeakReference<object> r)
{
while (true)
{
object obj;
if (r.TryGetTarget(out obj))
{
Console.WriteLine(obj + " を参照中");
}
else
{
Console.WriteLine("参照がなくなりました");
break;
}
await Task.Delay(1000);
}
}
}
この例では、RunAsync 側で GC.Collect (ガベージ コレクションを強制起動)を呼んだ時点で、(object)123 (整数を object 化(ボックス化)したもの)の参照が消えます。
つまり、WeakReference<object> r 越しに参照している分は、GC 的には参照扱いしていません。
そして、その後、StartLoop 側で TryGetTarget に失敗(false が返って、else 側に進む)して、ループが終了します。 GC により元のオブジェクト(Target)が削除されていたら、TryGetTarget が失敗します。
弱参照の用途
普通に C# を使っていて、WeakReference を見かけることはほとんどないと思います。 だいたいのプログラムでは、メモリ管理について気にすることはめったにありません(GC 任せ)。 弱参照を使うというのは、メモリ管理を自分で気にかけるということなので、当然、あまり出番はありません。
それに、弱参照を使うと、GC が掛かるタイミング(普通は制御しない。不定なタイミング)に依存することになるので、挙動が読めないという問題もあります。
ということで、弱参照を使う場面はほとんどありませんが、一応、いくつか用途を紹介しておきましょう。
用途1: 弱参照キーのテーブル
あるオブジェクトに、外から別のオブジェクトを紐づけたいとします。 これに対する手っ取り早い実現方法は Dictionary を使ったテーブル化です。
例えば、以下のようなクラス(名簿か何かで使う、「個人」型)があったとします。
/// <summary>
/// 仮に、このクラスが自作じゃなくて、どこか別のライブラリで定義されているものとする。
/// 自分のプログラムでは、ID と名前だけじゃなくて、住所も足したくなったとして...
/// </summary>
public class Person
{
public int Id { get; set; }
public string Name { get; set; }
}
元々の名簿管理では ID と名前くらいしか使っていなかったものに対して、追加で別の情報を足すことになったとしましょう。 一応、Dictionary を使えば、情報の関連付けはできます。 例えば、所在地を足すなら以下のようにします。
var people = new[]
{
new Person {Id = 1, Name = "Jurian Naul" },
new Person {Id = 2, Name = "Thomas Bent" },
new Person {Id = 3, Name = "Ellen Carson" },
new Person {Id = 4, Name = "Katrina Lauran" },
new Person {Id = 5, Name = "Monica Ausbach" },
};
var locations = new Dictionary<Person, string>();
locations[people[0]] = "Shinon";
locations[people[1]] = "Lance";
locations[people[2]] = "Pidona";
locations[people[3]] = "Loanne";
locations[people[4]] = "Loanne";
foreach (var p in people)
{
var location = locations[p];
Console.WriteLine(p.Name + " at " + location);
}
ここで、この Person 情報は追加・削除が結構あるとしましょう。 削除された Person に対しては、一緒に所在地情報も消えてほしかったりします。 locations テーブルが Person をキーとして参照していることによって、Person が GC 対象から外れる(いつまでたっても削除されない)ようでは困ります。 こういう場合に弱参照が使えます。 Dictionary のキー側を弱参照にすればいいわけです。
というような、キー側が弱参照なテーブルは、実は最初からあって、 ConditionalWeakTable というクラス(System.Runtime.CompilerServices 名前空間)です。 (実際には WeakReference クラスを使って弱参照管理しているのではなく、ネイティブ実装で弱参照管理しているようですが。)
var people = new[]
{
new Person {Id = 1, Name = "Jurian Naul" },
new Person {Id = 2, Name = "Thomas Bent" },
new Person {Id = 3, Name = "Ellen Carson" },
new Person {Id = 4, Name = "Katrina Lauran" },
new Person {Id = 5, Name = "Monica Ausbach" },
};
var locations = new ConditionalWeakTable<Person, string>();
locations.Add(people[0], "Shinon");
locations.Add(people[1], "Lance");
locations.Add(people[2], "Pidona");
locations.Add(people[3], "Loanne");
locations.Add(people[4], "Loanne");
foreach (var p in people)
{
string location;
if (locations.TryGetValue(p, out location))
Console.WriteLine(p.Name + " at " + location);
}
これなら、locations テーブルがあっても、キーになっている Person は GC の対象になります。
もっとも、ほとんどの場合、「自分の要件にあった別の Person クラスを作りなおす」という方が正しい解決策でしょう。 弱参照キーの出番もそれほど多くないです。 ConditionalWeakTable クラスも、名前空間が CompilerServices になっている通り、元々、C# のコンパイラーが使うために作られた用途の狭いクラスです。 (Java なんかは、同系統のクラスである WeakHashMap が java.util 名前空間にあったりしますが...)
用途2: 弱イベント
GC を持っている(ので、めったなことではメモリ リークしないはずの)プログラミング言語で、メモリ リークの温床になっているのがイベント購読です。 「【雑記】イベントの購読とその解除」で説明していますが、 イベント発生側と受取側の寿命が違う場合、イベント購読解除をしないとメモリ リークになります。
イベントの購読解除をきっちり行うためには、要は、Dispose 処理(参考: 「using ステートメント」)をちゃんとすればいいわけですが... まれに、Dispose 処理がものすごく面倒(ちゃんとするためにはコードがかなり複雑化してしまう)ものがあります(参考: 例えば、「Task クラス」)。
こういう、Dispose 処理が必須なのに Dispose しにくいものの救済策にも、弱参照が使えたりします。 弱参照を使って、イベント受取側が消えた時に自動的にイベント購読解除してしまうやり方を、 弱イベント(weak event)パターンとか、 弱購読(weak subscription)とか呼んだりします。
ちなみに、こういう要件が頻発する代表例は、GUI のデータ バインディングです(参考: WPFの「データ・バインディング」を理解する)。 なので、WPF は、弱イベント パターンを補助するために WeakEventManager というクラス(System.Windows 名前空間)を持っていたりします。 とはいえ、C# の event 構文に対する弱イベント パターン実装は結構めんどくさくて、この WeakEventManager もあんまり使いたい作りではなかったりします。
event 構文で弱イベントを使いにくい理由は、「【雑記】イベントの購読とその解除」 で説明してるような、add/remove 型の購読開始/解除だからだと思います。 IDisposable Subscribe 型のイベント購読なら、意外と簡単に書けます。 例えば、Reactive Extensions を使って実装するなら以下のような感じ。
using System;
using System.Reactive.Disposables;
public static class WeakEventExtensions
{
/// <summary>
/// 弱イベント購読。
/// 戻り値の <see cref="IDisposable"/> が誰からも参照されなくなったら自動的にイベント購読解除する。
/// </summary>
/// <typeparam name="T">イベント引数の型。</typeparam>
/// <param name="observable">イベント発生側。</param>
/// <param name="onNext">イベント受取側。</param>
/// <returns>イベント購読解除用の disposable。</returns>
/// <remarks>
/// 弱参照の性質上、<see cref="GC"/> がかかって初めて「誰も使ってない」判定を受ける。
/// それまではイベント購読解除されず、イベントが届き続ける。
/// GC タイミングに左右されるコードは推奨できないんで、可能な限り、
/// 戻り値の <see cref="IDisposable.Dispose"/> を明示的に呼ぶべき。
/// </remarks>
public static IDisposable WeakSubscribe<T>(this IObservable<T> observable, Action<T> onNext)
{
WeakReference<IDisposable> weakSubscription = null;
IDisposable subscription = null;
subscription = observable.Subscribe(x =>
{
IDisposable d;
if (!weakSubscription.TryGetTarget(out d))
{
// 弱参照のターゲットが消えてたらイベント購読解除。
subscription.Dispose();
return;
}
onNext(x);
});
// subscription は↑のラムダ式が参照を持っちゃうことになるので、
// 別の IDisposable を作ってラップ。
var s = new SingleAssignmentDisposable();
s.Disposable = subscription;
// 作った、外から呼ぶ用 IDisposable の弱参照を作る。
weakSubscription = new WeakReference<IDisposable>(s);
return s;
}
}
利用例も示しましょう。以下のようになります。
using System;
using System.Reactive.Subjects;
using System.Threading;
using System.Threading.Tasks;
class Program
{
static void Main()
{
RunAsync(true).Wait();
RunAsync(false).Wait();
}
private const int Interval = 100;
private static async Task RunAsync(bool manualDispose)
{
if (manualDispose) Console.WriteLine("ちゃんと Dispose");
else Console.WriteLine("GC 任せ");
// イベントを、
// d1: 通常のイベント購読
// d2: 弱イベント購読
var x = new Subject<int>();
var d1 = x.Subscribe(i => Console.WriteLine("subscribe " + i));
var d2 = x.WeakSubscribe(i => Console.WriteLine("weak subscribe " + i));
var cts = new CancellationTokenSource();
var t = EventSourceLoop(x, cts.Token);
// イベントが飛んでくる間隔の3倍待つ → 3回イベントが来る
await Task.Delay(3 * Interval);
if (manualDispose)
{
// ちゃんと Dispose。
// 当たり前だけども、以後、イベントは受け取らなくなる。
d1.Dispose();
d2.Dispose();
}
else
{
// Dispose 忘れたままオブジェクトを捨てる。
// d1 は、Subscribe 内で参照を握っているので GC 対象にならない。メモリ リーク。
// d2 は、WeakSubscribe 内は弱参照なので、こっちの参照なくせば GC 対象。
// 以後、イベントは subscribe 側にだけ届く。
d1 = null;
d2 = null;
GC.Collect();
}
// 同じく3回分待つ
await Task.Delay(300);
cts.Cancel();
await t;
}
// イベントを飛ばし続けるループ
static async Task EventSourceLoop(IObserver<int> observer, CancellationToken ct)
{
for (var i = 0; !ct.IsCancellationRequested; ++i)
{
observer.OnNext(i);
await Task.Delay(Interval);
}
}
}
ちゃんと Dispose subscribe 0 weak subscribe 0 subscribe 1 weak subscribe 1 subscribe 2 weak subscribe 2 GC 任せ subscribe 0 weak subscribe 0 subscribe 1 weak subscribe 1 subscribe 2 weak subscribe 2 subscribe 3 subscribe 4 subscribe 5
ちなみにこの例だと、戻り値の IDisposable が弱参照になっていますが、 弱参照な IObservable を作るような作り方もできます(例: WeakEventExtensions.AsWeakObservable.cs)。
あと、ファイナライザーを使う方法もなくはないです(例: WeakEventExtensions.FinalizeDiposable.cs )が、 こっちの方は、コードはシンプルになるものの、実行性能上はあんまりよくないはず。
まあ、この弱イベント購読も、割かし「最終手段」なもので、本来はちゃんと自前で Dispose 処理すべきものです。 Dispose 処理をかけるのが著しく困難な場面はそこまで頻出しないでしょう。 (ただ、Dispose し忘れを検出するのには、この弱参照やファイナライザーを使ったパターンを使うのも悪くないです。 自動解除がかかるタイミングにデバッグ ログを仕込んでおけば、解除漏れを探すのに役立ちます。)
誤用: オブジェクト キャッシュ
最後に、弱参照の用途としてたまに上がるものの、そんなによい効果を得られないものについて触れておきます。
オブジェクト作成にそこそこ時間がかかるので、作成したものをしばらく保存しておきたい(キャッシュ)場面は結構あります。 ここで、「しばらく」というのを「積極的に破棄はしないけども、GC のタイミングでは削除してもらって構わない」と考えると、 弱参照の出番のように思えます。
ただ、GC の gen0 (参考: 「C# のガベージ コレクション」)は GC 実行頻度が高すぎて想像以上にあっさりキャッシュが消えます。
逆に、gen2 が走るようなタイミングはメモリが不足している状況なので、 ページング(メモリの内容をハードディスクなどに退避して、見かけのメモリ容量を増やす)が発生するなど、 性能に深刻な影響が出たりします。 無頓着に gen2 に割り当てられるようなキャッシュを持ったりすると、かえって動作が遅くなったりするようです。