PHP 閉包和生成器可以保存循環引用-php教程-PHP中文網

PHP Closures and Generators can hold circular references

PHP中的循環引用是記憶體洩漏的常見原因。當物件直接或間接地相互引用時，就會發生循環引用。幸運的是，PHP有一個垃圾收集器可以偵測和清理循環引用。但是，這會消耗CPU週期並可能減慢應用程式的速度。

垃圾收集器會在記憶體中存在10,000個可能的循環物件或陣列，並且其中一個超出作用域時觸發。

如果您有少量使用大量記憶體的對象，則永遠不會觸發垃圾收集。即使記憶體被垃圾收集器應該收集的孤立物件使用，您也可能達到記憶體限制。

這就是為什麼您應該識別建立循環引用的情況並避免它們的原因。

理想情況下，對於Web應用程序，您希望停用垃圾收集器，並在發送回應後讓PHP釋放所有記憶體。但這對於長時間運行的腳本（例如守護進程或工作進程）來說是危險的，因為記憶體洩漏會隨著時間的推移而累積，並透過頻繁調用垃圾收集器來減慢應用程式的速度。

在本文中，我們將探討閉包和產生器如何保存循環引用以及如何防止它們。

關於循環引用
- 循環引用的典型範例
- 使用弱引用防止循環引用
閉包與循環引用
產生器與循環引用
結論

關於循環引用

循環引用的典型範例

<code class="language-php">class A {
    public B $b;

    public function __construct()
    {
        $this->b = new B($this);
    }
}

class B {
    public function __construct(public A $a) {}
}</code>

登入後複製

在此範例中，A和B相互引用。當您建立A的實例時，它會建立一個引用A的B實例。這會建立一個循環引用。

為了偵測循環引用，我們可以使用gc_collect_cycles()手動觸發垃圾收集器，並使用gc_status()讀取收集到的引用的數量。

<code class="language-php">// 创建的对象但未分配给变量
new A();

gc_collect_cycles();
print_r(gc_status());</code>

登入後複製

這將輸出：

<code>Array
(
    ...
    [collected] => 2
    ...
)</code>

登入後複製

此範例顯示垃圾收集器已偵測到並刪除了2個具有循環引用的物件。

您也可以使用xdebug_debug_zval()函數查看物件的參考數量。

使用弱引用防止循環引用

當遇到循環引用時，一個簡單的解決方案是使用弱引用。弱引用是一個對象，它所持有的引用不會阻止垃圾收集器收集它所引用的對象。在PHP中，您可以使用WeakReference類別建立弱引用。

這需要對程式碼進行一些更改。 B類現在儲存WeakReference物件而不是A物件。您必須使用WeakReference物件的get()方法存取A物件。

<code class="language-php">class A {
    public B $b;

    public function __construct()
    {
        $this->b = new B($this);
    }
}

class B {
    /** @var WeakReference<a> $a */
    public WeakReference $a;

    public function __construct(A $a)
    {
        $this->a = WeakReference::create($a);    
    }
}</code>

登入後複製

<code class="language-php">// 创建的对象但未分配给变量
new A();

gc_collect_cycles();
print_r(gc_status());
// [collected] => 0</code>

登入後複製

在輸出中，您將看到收集到的引用數量現在為0。

提示1：僅在必要時使用弱引用來防止循環引用。

閉包與循環引用

PHP中閉包的概念是建立一個可以存取父作用域中變數的函數。如果您不小心，這可能會導致循環引用。

<code class="language-php">class A {
    public B $b;

    public function __construct()
    {
        $this->b = new B($this);
    }
}

class B {
    public function __construct(public A $a) {}
}</code>

登入後複製

在此範例中，閉包$a->b引用父作用域中的變數$a。循環引用很容易發現，因為引用是明確的。

但是，如果您使用閉包的簡寫語法，則可能會以更隱藏的方式出現相同的問題。使用箭頭函數，變數$a不會在閉包中明確引用，但它仍然被按引用捕獲。

<code class="language-php">// 创建的对象但未分配给变量
new A();

gc_collect_cycles();
print_r(gc_status());</code>

登入後複製

在此範例中，收集到的引用數量為2，表示有循環引用。

閉包中對$this的引用

在類別方法中建立的任何非靜態閉包都會對物件實例（$this）具有引用，即使沒有存取$this也是如此。

<code>Array
(
    ...
    [collected] => 2
    ...
)</code>

登入後複製

這是因為$this引用總是在閉包中按引用捕獲。可以使用Reflection::getClosureThis()存取它。

<code class="language-php">class A {
    public B $b;

    public function __construct()
    {
        $this->b = new B($this);
    }
}

class B {
    /** @var WeakReference<a> $a */
    public WeakReference $a;

    public function __construct(A $a)
    {
        $this->a = WeakReference::create($a);    
    }
}</code>

登入後複製

如果從全域作用域或靜態方法建立閉包，則$this引用為null。

提示2：如果您不需要$this，請務必使用static function () {}或static fn () =>來建立閉包。

產生器與循環引用

我們來談談這篇文章的原因。我最近發現了一些東西：生成器會保留引用，只要它們沒有被耗盡。

在此範例中，該類別將生成器儲存在一個屬性中，但生成器對物件實例具有$this引用。生成器表現得像一個閉包，並保留對物件實例的參考。

<code class="language-php">// 创建的对象但未分配给变量
new A();

gc_collect_cycles();
print_r(gc_status());
// [collected] => 0</code>

登入後複製

類別實例被垃圾收集器收集，因為它對生成器有引用，而生成器對物件實例有引用。

一旦生成器被耗盡，參考就會被釋放，物件實例就會從記憶體中刪除。

<code class="language-php">function createCircularReference()
{
    $a = new stdClass();
    $a->b = function () use ($a) {
        return $a;
    };

    return $a;
}</code>

登入後複製