PHPのWeakReferenceクラスとは？ウィークリファレンスの基本と使い方

はじめに

ウィークリファレンス（弱い参照）を使うと、オブジェクトへの参照を保持しながらも、そのオブジェクトの破棄を妨げないようにすることができます。この特性を活かせば、キャッシュのような構造を実装可能です。

ウィークリファレンスは通常の参照と似ていますが、ガベージコレクタによるオブジェクトの回収を妨げないという点が大きく異なります。対象のオブジェクトへの強い参照が存在しなくなった場合、そのオブジェクトは直ちにメモリから解放されます。この仕組みにより、メモリに関する問題を引き起こすことなく、キャッシュの持つ利点のほとんどを実現できます。

WeakReferenceクラスはPHP 7.4で導入されました。それ以前のバージョンでは、weakref拡張モジュールによって同等の機能を実現していました。WeakReferenceクラスは、次のような構造を持っています。

構文

WeakReference {    /* メソッド */    public __construct ( void )    public static create ( object $referent ) : WeakReference    public get ( void ) : ?object}

メソッド

public WeakReference::__construct ( void ) — WeakReferenceクラスの直接的なインスタンス化は禁止されています。インスタンスを生成するには、ファクトリメソッドであるWeakReference::create()を使用してください。

public static WeakReference::create ( object $referent ) : WeakReference — 新しいWeakReferenceを作成します。

public WeakReference::get ( void ) : ?object — 弱く参照されているオブジェクトを取得します。オブジェクトがすでに破棄されている場合はNULLを返します。

動作の流れ

次の例では、myclassのオブジェクトを作成し、そのオブジェクトへのWeakReferenceを生成しています。オブジェクトが存在する間はget()メソッドを通じてオブジェクトを取得できますが、unset()でオブジェクトを破棄した後は、WeakReferenceはNULLを返すようになります。

コード例

<?phpclass myclass{    function Hello(){       echo "Hello";    }}$obj = new myclass();$ref = WeakReference::create($obj);var_dump($ref->get());unset($obj);var_dump($ref->get());?>

出力結果

上記のプログラムを実行すると、次の出力が得られます。

object(myclass)#1 (0) {}NULL