PHP 闭包和生成器可以保存循环引用

再次运行垃圾收集器：

// 创建对象但不赋值给变量
new A();

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

输出结果中，收集的引用数量为 0。

提示 1： 仅在必要时使用弱引用来避免循环引用。

闭包与循环引用

PHP 中的闭包允许创建一个函数，该函数可以访问其父作用域中的变量。如果不注意，这可能会导致循环引用。

function createCircularReference() {
    $a = new stdClass();
    $a->b = function () use ($a) {
        return $a;
    };

    return $a;
}

在这个例子中，闭包 $a->b 引用了父作用域中的变量 $a。由于引用是显式的，所以很容易发现循环引用。

但是，如果使用闭包的简写语法（箭头函数），同样的问题可能会更隐蔽。使用箭头函数时，变量 $a 没有在闭包中显式引用，但仍然通过引用捕获。

function createCircularReference() {
    $a = new stdClass();
    $a->b = fn() => $a;

    return $a;
}

createCircularReference();

gc_collect_cycles();
print_r(gc_status());
// [collected] => 2

在这个例子中，收集的引用数量为 2，表示存在循环引用。

在闭包中引用 $this

在类方法中创建的任何非静态闭包都会持有对对象实例 ($this) 的引用，即使 $this 没有被访问。

class A {
    public Closure $closure;
    public function __construct() {
        $this->closure = function () {};
    }
}

new A();

gc_collect_cycles();
print_r(gc_status());
// [collected] => 2

这是因为 $this 引用总是被闭包隐式捕获。可以使用 Reflection::getClosureThis() 来访问它。

class A {
    public Closure $closure;
    public function __construct() {
        $this->closure = static function () {};
    }
}

new A();

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

如果闭包是在全局作用域或静态方法中创建的，则 $this 引用为 null。

提示 2： 如果不需要 $this，创建闭包时始终使用 static function () {} 或 static fn () => {}。

生成器与循环引用

生成器在未耗尽之前会保留引用。

在这个例子中，类将生成器存储在一个属性中，但生成器持有对对象实例 $this 的引用。生成器的行为类似于闭包，并保留对对象实例的引用。

class A {
    public iterable $iterator;

    public function __construct() {
        $this->iterator = $this->generator();
    }

    private function generator(): Generator {
        yield;
    }
}

new A();

gc_collect_cycles();
print_r(gc_status());
// [collected] => 1

类实例被垃圾收集器回收，因为它持有对生成器的引用，而生成器又持有对对象实例的引用。

一旦生成器耗尽，引用就会被释放，对象实例也会被删除。

iterator_to_array((new A())->iterator);

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

提示 3： 确保始终迭代以耗尽生成器。

提示 4： 使用静态方法或闭包创建生成器，避免保留对对象实例的引用。

总结

循环引用是 PHP 中内存泄漏的常见原因。即使垃圾收集器可以检测和清理循环引用，它也会消耗 CPU 资源并降低应用程序速度。必须识别创建这些循环引用并调整代码以防止它们发生。使用弱引用可以避免循环引用，但一些简单的技巧可以帮助你从一开始就避免循环引用：

• 如果不需要 $this，创建闭包时使用 static function () {} 或 static fn () => {}。
• 确保始终迭代以耗尽生成器。
• 使用静态方法或闭包创建生成器，避免保留对对象实例的引用。

更多阅读

• PHP 垃圾收集 — 性能注意事项
• 什么是 PHP 中的垃圾收集以及如何充分利用它？
• memprof — PHP 内存分析器，用于查找 PHP 脚本中的内存泄漏。
• Xdebug 的内置分析器

今天带大家了解了的相关知识，希望对你有所帮助；关于文章的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~