闭包绑定 $this 与垃圾回收器

Question

我已经设计实现了一个表示多种策略的策略类（Strategy）。每当创建此类策略的一个实例时，它会接收一个函数作为参数。然后，这个函数会被关联到相应的策略对象上，这样一来，在匿名函数内部就可以使用 $this 来引用当前策略对象。下面是一个具体的例子：

$a = new Strategy(function () {
    $this->getName(); // Strategy 1. $this refers to $a within this function.
});

在策略（Strategy）类的构造方法内部：

public function __construct(Closure $strategy)
{
    self::initCounter();
    $this->strategy = $strategy(...)->bindTo($this);

    $this->name = 'Strategy ' . self::$strategyCounter->getNextStrategyNumber();
}

initCounter方法用于初始化counter，它是一个简单的私有静态字段，存储的是StrategyCounter类的对象。该对象仅包含策略数量以及获取下一个编号的方法getNextNumber()和减小策略计数的方法decrementStrategyCounter()。

其工作原理很简单：

当创建一个新的策略时，默认会赋予一个名称："策略 X"，其中X代表下一个策略的编号。例如：

$a = new Strategy(function () {}); // Name = Strategy 1
$b = new Strategy(function () {}); // Name = Strategy 2
// and so on.

出现问题的点在哪里？我期望达成什么样的目标？

同时，我也期望确保策略的名称不会被持续占用。也就是说，当某个策略对象被销毁或不再引用时，计数器应当递减，以便于新创建的策略能够继续使用类似于以下形式的可用名称：

$a = new Strategy(function () {}); // Name = Strategy 1
$b = new Strategy(function () {}); // Name = Strategy 2
unset($b); // $b is unset => Counter decremented => Default name for next Strategy should be with number 2.
$c = new Strategy(function () {}); // Name = Strategy 2

遗憾的是，在闭包中存在对策略对象的引用，因此无法利用__destruct()方法达到自动递减计数器的目的。

我所做的尝试

我原本认为或许应当在析构函数里先移除闭包，但这并没有起作用：

public function __destruct()
{
    unset($this->strategy);
    self::$strategyCounter->decrementStrategyCounter();
}

这是因为实际上析构函数并未被执行。我的理解是这样的：

$a = new Strategy(function () {}); // Name = Strategy 1
$b = new Strategy(function () {}); // Name = Strategy 2
unset($b); // $b isn't unset, because Strategy still exists, because was bind to Closure within that Strategy, and since this is the case, no destuctor is called.
$c = new Strategy(function () {}); // Name = Strategy 3 Blehh ;C

// The script ends, all Strategies are removed one by one.

gsm2009 · Answer

您可以创建一个仅期望存在 run() 方法的简单接口。通过这个接口，您可以使用 $this 上下文来调用它。每个 $strategy 实例都有自己的 $this 作用域。
Demo: https://3v4l.org/eCtZU

interface StrategyInterface {
    public function run();
}

class Strategy implements StrategyInterface
{
    protected ?string $value = null;
    public function __construct(private Closure $closure)
    {
        $this->value = (string) rand(1, 100);
    }

    public function run()
    {
        $this->closure->call($this);
    }
}

for ($i = 0; $i < 10; ++$i) {
    $strategy = new Strategy(function() {
        var_dump($this->value);
    });

    $strategy->run();
}

这里是一个使用静态计数器的更复杂示例：
Demo: https://3v4l.org/smcDi

interface StrategyInterface
{
    public function run();
}

class Strategy implements StrategyInterface
{
    protected ?string $value = null;
    private static $counter = 0;

    public function __construct(private Closure $closure)
    {
        echo "Strategy Counter: ", ++self::$counter, PHP_EOL;
        $this->value = (string)rand(1, 100);
    }

    public function run()
    {
        $this->closure->call($this);
    }

    public function __destruct()
    {
        echo "Strategy Counter: ", --self::$counter, PHP_EOL;
    }
}

$strategy1 = new Strategy(function () {
    var_dump($this->value);
});

$strategy2 = new Strategy(function () {
    var_dump($this->value);
});

$strategy3 = new Strategy(function () {
    var_dump($this->value);
});


$strategy1->run(); // counter still 3, because 3 are created
$strategy1 = null; // destroy the first strategy, counter is 2
$strategy2->run();
unset($strategy2); // destroy the second strategy, counter is 1
$strategy3->run();

$strategy4 = new Strategy(function () { // create a new strategy, counter is 2
    var_dump($this->value);
});

// program ends, counter goes down to 0

gsm2009 · Answer

正如您所分析的那样，问题在于存在循环引用——策略对象引用了闭包，而闭包又引用了策略对象。

当PHP检测到孤立的循环引用时，析构函数最终会被调用。如果在您的代码中有特定位置取消设置了策略对象，那么您可以在执行此操作后立即调用gc_collect_cycles来立即销毁它们。

或者，您需要更改设计以避免循环引用。例如，与其将闭包绑定到策略对象上，不如每次调用闭包时都将策略对象作为参数传入：

// Inside Strategy class
public function invoke() {
    ($this->strategy)($this);
}

// Outside
$a = new Strategy(function (Strategy $s) {
    $strat->getName(); // Strategy 1. $strat will be passed the object $a
});

如果在实际代码中您已经向回调函数传递了参数，只需将策略对象置于这些参数之前——从概念上讲，$this 可以被视为一个具有特殊语法的参数。