深入理解 PHP 闭包 - 郭华伟的博客

一、什么是闭包

闭包（Closures），又叫做匿名函数，也就是没有定义名字的函数，允许临时创建一个没有指定名称的函数，常用作回调函数（callable）参数的值。

闭包和匿名函数在 PHP5.3 中被引入。
闭包是指在创建时封装函数周围状态的函数，即使闭包所在的环境不存在了，闭包封装的状态依然存在。
闭包使用的语法和普通函数相同，但是本质上它是伪装成函数的对象，是 Closure 类的实例。闭包和字符串或整数一样，是一等值类型。
PHP 闭包是对象，可以使用 $this 关键字获取闭包的内部状态。
闭包的默认状态里面有一个__invoke() 魔术方法和 bindTo() 方法。我们可以使用 bindTo() 方法把 Closure 对象内部状态绑定到其他对象上。bindTo() 方法的第二个参数可以指定绑定闭包的那个对象所属的 PHP 类，我们就可以访问这个类的受保护和私有的成员变量。

1. 闭包示例

<?php
  
echo preg_replace_callback('~-([a-z])~', function ($match) {
    return strtoupper($match[1]);
}, 'hello-world');

// 输出 helloWorld
?>

2. 闭包作为变量

闭包函数也可以作为变量的值来使用。PHP 会自动把此种表达式转换成内置类 Closure 的对象实例。把一个 closure 对象赋值给一个变量的方式与普通变量赋值的语法是一样的，最后也要加上分号。

<?php

$closure = function($name)
{
    printf("Hello %s\r\n", $name);
};

$closure('World');
$closure('PHP');

?>

我们之所以可以调用 $closure 变量，是因为这个变量的值是一个闭包，闭包对象实现了__invoke() 魔术方法，只要后面跟着 ()，PHP 就会查找__invoke() 方法。

3. 闭包变量的作用域

闭包可以从父作用域中继承变量，变量必须在函数或类的头部声明。任何此类变量都应该用 use 语言结构传递进去。

PHP 7.1 起，不能传入此类变量： superglobals、 $this 或者和参数重名。

<?php
  
$message = 'hello';

// 没有 "use"
$example = function () {
    return $message;
};

echo $example(); // 输出 Undefined variable: message。

// 继承 $message
$example = function () use ($message) {
    return $message;
};

echo $example(); // 输出 hello

// 继承变量的值是定义时，而非调用时。
$message = 'world';

echo $example(); // 输出 hello

// 重新赋值
$message = 'hello';

// 重新定义
$example = function () use (&$message) {
    var_dump($message);
};

echo $example(); // 输出 hello

// 父级作用域的值变更，因为使用的是引用，所以闭包内部也会引起变化。
// is reflected inside the function call
$message = 'world'; 

echo $example(); // 输出 world

// 闭包也可以接受参数
$example = function ($arg) use ($message) {
    var_dump($arg . ' ' . $message);
};

$example("hello"); // 输出 hello world
?>

4. 闭包和作用域

从父作用域中继承变量与使用全局变量是不同的。

全局变量存在于一个全局的范围，无论当前在执行的是哪个函数。

闭包的父作用域是定义该闭包的函数（不一定是调用它的函数）。示例如下：

<?php

// 一个基本的购物车，包括一些已经添加的商品和每种商品的数量。
// 其中有一个方法用来计算购物车中所有商品的总价格，该方法使用了一个 closure 作为回调函数。

class Cart
{
    const PRICE_BUTTER  = 1.00;
    const PRICE_MILK    = 3.00;
    const PRICE_EGGS    = 6.95;

    protected   $products = array();
    
    public function add($product, $quantity)
    {
        $this->products[$product] = $quantity;
    }
    
    public function getQuantity($product)
    {
        return isset($this->products[$product]) ? $this->products[$product] :
               FALSE;
    }
    
    public function getTotal($tax)
    {
        $total = 0.00;
        // 闭包使用了父函数的环境变量 $tax, 和 $total
        $callback = function ($quantity, $product) use ($tax, &$total){
                $pricePerItem = constant(__CLASS__ . "::PRICE_" .strtoupper($product));
                $total += ($pricePerItem * $quantity) * ($tax + 1.0);
        };
        
        array_walk($this->products, $callback);
        return round($total, 2);;
    }
}

$my_cart = new Cart;

// 往购物车里添加条目
$my_cart->add('butter', 1);
$my_cart->add('milk', 3);
$my_cart->add('eggs', 6);

// 打出出总价格，其中有 5% 的销售税.
print $my_cart->getTotal(0.05) . "\n"; // 最后结果是 54.29
?>

5. 自动绑定 $this

闭包会自动绑定所在对象中的 $this，也就是说在闭包中可以访问到所在的对象。

<?php

class Test
{
    public function testing()
    {
        return function() {
            var_dump($this);
        };
    }
}

$object = new Test;
$function = $object->testing();
$function(); // 输出 object(Test)#1 (0) {}

6. 静态匿名函数

静态的匿名函数中，不能使用 $this。

<?php

class Foo
{
    function __construct()
    {
        $func = static function() {
            var_dump($this);
        };
        $func();
    }
};

new Foo(); // Using $this when not in object context

7. 静态闭包无法绑定到对象上

<?php

$func = static function() {
    echo  "hello";
};

$func = $func->bindTo(new StdClass);

$func(); //Cannot bind an instance to a static closure

二、闭包绑定到对象

闭包最开始主要是作为会调函数使用的，但是随着 php 语言的发展，有更多高级的用途，比如在 laravel 框架中，middleware，route 都主要的使用了闭包，通过绑定的方式能让开发人员在写业务逻辑的时候更加灵活。

Closure 类，包含两个方法：

Closure::bind：复制一个闭包，绑定指定的 $this 对象和类作用域。
Closure::bindTo：复制当前闭包对象，绑定指定的 $this 对象和类作用域。

Closure {   
    // closure：表示需要绑定的闭包对象。
    // newthis：表示需要绑定到闭包对象的对象，或者 NULL 创建未绑定的闭包。
    // newscope：表示想要绑定给闭包的类作用域，可以传入类名或类的示例，默认值是'static'，表示不改变。
    public static Closure bind (Closure $closure , object $newthis [, mixed $newscope = 'static' ])  
    public Closure bindTo (object $newthis [, mixed $newscope = 'static' ])  
}

可以看下具体的例子，在闭包中可以调用预期绑定对象中的成员，创建闭包之后，再绑定到具体的对象上。

class Animal {  
    private static $cat = "cat";  
    private $dog = "dog";  
    public $pig = "pig";  
}  

/*  
 * 获取Animal类静态私有成员属性 
 */  
$cat = static function() {  
    return Animal::$cat;  
};  

/*  
 * 获取Animal实例私有成员属性 
 */  
$dog = function() {
    return $this->dog;  
};  

/*  
 * 获取Animal实例公有成员属性 
 */  
$pig = function() {  
    return $this->pig;  
};  

$bindCat = Closure::bind($cat, null, new Animal());// 给闭包绑定了Animal实例的作用域，但未给闭包绑定$this对象  
$bindDog = Closure::bind($dog, new Animal(), 'Animal');// 给闭包绑定了Animal类的作用域，同时将Animal实例对象作为$this对象绑定给闭包  
$bindPig = Closure::bind($pig, new Animal());// 将Animal实例对象作为$this对象绑定给闭包,保留闭包原有作用域  
echo $bindCat(),'<br>';// 根据绑定规则，允许闭包通过作用域限定操作符获取Animal类静态私有成员属性  
echo $bindDog(),'<br>';// 根据绑定规则，允许闭包通过绑定的$this对象(Animal实例对象)获取Animal实例私有成员属性  
echo $bindPig(),'<br>';// 根据绑定规则，允许闭包通过绑定的$this对象获取Animal实例公有成员属性

// bindTo与bind类似，是面向对象的调用方式，这里只举一个，其他类比就可以
$bindCat = $cat->bindTo(null, 'Animal');
$bindDog = $dog->bindTo(new Animal(), 'Animal');
$bindPig = $pig->bindTo(new Animal());

再看一下官方的例子，该例子展示了闭包更换绑定对象，从而改变其所处的环境：

class A {
  
    function __construct($val) {
        $this->val = $val;
    }
  
    function getClosure() {
        //返回绑定了该对象和作用域的闭包
        return function() { 
          return $this->val; 
        };
    }
}

// 创建对象 ob1
$ob1 = new A(1);

// 创建对象 ob2
$ob2 = new A(2);

// 获取对象 ob1 中的闭包 c1
$cl = $ob1->getClosure();
// 执行闭包
echo $cl(), "\n";

// 将 c1 绑定到 ob2
$cl = $cl->bindTo($ob2);
// 执行闭包
echo $cl(), "\n";