README

A PHP库，用于序列化闭包和匿名函数。

不再维护

此软件不再维护。请考虑使用opis/closure代替。

README的其余部分将保持软件被废弃前的状态。

简介

曾经，我尝试序列化一个PHP Closure对象。你可能已经猜到了，它根本不起作用。事实上，你会从PHP运行时得到一个非常具体的错误信息

未捕获异常 'Exception'，信息为 '不允许序列化 'Closure''

尽管PHP不允许序列化闭包，但SuperClosure库使它成为可能。以下是使用方法

use SuperClosure\Serializer;

$serializer = new Serializer();

$greeting = 'Hello';
$hello = function ($name = 'World') use ($greeting) {
    echo "{$greeting}, {$name}!\n";
};

$hello('Jeremy');
//> Hello, Jeremy!

$serialized = $serializer->serialize($hello);
// ...
$unserialized = $serializer->unserialize($serialized);

$unserialized('Jeremy');
//> Hello, Jeremy!

是的，非常酷，不是吗？

特性

SuperClosure提供了两种不同的Closure Analyzers，它们支持不同的闭包序列化特性。与AstAnalyzer相比，TokenAnalyzer不够健壮，但速度大约快20-25倍。使用下表，并考虑到你的闭包代码的样子，你应该选择一个支持所需特性的最快分析器。

注意事项

1. 对于任何使用引用的变量（例如，function () use (&$vars, &$like, &$these) {…}），在序列化后引用不会保持。唯一的例外是递归闭包引用。
2. 如果你在单行上定义了两个闭包（你为什么要这样做？），你将无法序列化任何一个，因为不清楚哪个闭包的代码应该被解析（它们毕竟都是匿名函数）。
3. 警告：要反序列化闭包，需要使用 eval() 函数。许多人都认为这个函数很危险，因此在使用此库时，您需要评估可能需要采取哪些预防措施。您应该只从可信来源反序列化闭包，否则您可能会面临代码注入攻击。如果计划存储或传输序列化的闭包，对它们进行签名是个好主意。有关如何操作的详细信息，请参阅下文中的 签名闭包 部分。
4. 无法序列化在 eval() 中定义的闭包。这包括重新序列化已反序列化的闭包。

分析器

在实例化 Serializer 时，您可以选择要使用的分析器。如果您没有指定，则默认使用 AstAnalyzer，因为它具有最强大的功能。

use SuperClosure\Serializer;
use SuperClosure\Analyzer\AstAnalyzer;
use SuperClosure\Analyzer\TokenAnalyzer;

// Use the default analyzer.
$serializer = new Serializer();

// Explicitly choose an analyzer.
$serializer = new Serializer(new AstAnalyzer());
// OR
$serializer = new Serializer(new TokenAnalyzer());

如果只是想对闭包对象进行一些内省，分析器也很有用。查看使用 AstAnalyzer 返回的内容。

use SuperClosure\Analyzer\AstAnalyzer;

class Calculator
{
    public function getAdder($operand)
    {
        return function ($number) use ($operand) {
            return $number + $operand;
        };
    }
}

$closure = (new Calculator)->getAdder(5);
$analyzer = new AstAnalyzer();

var_dump($analyzer->analyze($closure));
// array(10) {
//   'reflection' => class ReflectionFunction#5 (1) {...}
//   'code' => string(68) "function ($number) use($operand) {
//     return $number + $operand;
// };"
//   'hasThis' => bool(false)
//   'context' => array(1) {
//     'operand' => int(5)
//   }
//   'hasRefs' => bool(false)
//   'binding' => class Calculator#2 (0) {...}
//   'scope' => string(10) "Calculator"
//   'isStatic' => bool(false)
//   'ast' => class PhpParser\Node\Expr\Closure#13 (2) {...}
//   'location' => array(8) {
//     'class' => string(11) "\Calculator"
//     'directory' => string(47) "/Users/lindblom/Projects/{...}/SuperClosureTest"
//     'file' => string(58) "/Users/lindblom/Projects/{...}/SuperClosureTest/simple.php"
//     'function' => string(9) "{closure}"
//     'line' => int(11)
//     'method' => string(22) "\Calculator::{closure}"
//     'namespace' => NULL
//     'trait' => NULL
//   }
// }

签名闭包

SuperClosure 的 2.1+ 版本允许您在实例化 Serializer 时指定一个签名密钥。这样做将配置您的 Serializer 对您序列化的任何闭包进行签名，并验证您反序列化的任何闭包的签名。这样做可以帮助您保护自己免受潜在的代码注入攻击，这些攻击可能发生在有人篡改了序列化的闭包的情况下。《请记住，您的签名密钥是保密的》。

$serializer1 = new SuperClosure\Serializer(null, $yourSecretSigningKey);
$data = $serializer1->serialize(function () {echo "Hello!\n";});
echo $data . "\n";
// %rv9zNtTArySx/1803fgk3rPS1RO4uOPPaoZfTRWp554=C:32:"SuperClosure\Serializa...

$serializer2 = new SuperClosure\Serializer(null, $incorrectKey);
try {
    $fn = $serializer2->unserialize($data);
} catch (SuperClosure\Exception\ClosureUnserializationException $e) {
    echo $e->getMessage() . "\n";
}
// The signature of the closure's data is invalid, which means the serialized
// closure has been modified and is unsafe to unserialize.

安装

要使用 Composer 在您的项目中安装 Super Closure 库，只需使用 Composer 需求该项目。

$ composer require jeremeamia/superclosure

当然，如果您选择，您可以手动更新您的 require 块。

{
    "require": {
        "jeremeamia/superclosure": "^2.0"
    }
}

请访问Composer 主页 获取有关如何使用 Composer 的更多信息。

为什么我需要序列化闭包？

既然您正在查看这个 README，您可能已经有了用例。尽管这个概念最初是一个实验，但在野外已经出现了一些用例。

例如，在 UserScape 的一个关于 Laravel 和 IronMQ 的视频中，大约在 7:50 的位置，他们展示了如何将闭包推送到队列中作为一个作业，以便由工作进程执行。这很棒，因为您不需要为可能非常简单的作业创建整个类。

或者，您可能有一个依赖注入容器或通过编写闭包构建的路由对象。如果您想缓存它，您将需要能够序列化它。

然而，总的来说，可能应该避免序列化闭包。

告诉我这个项目是如何开始的

这一切始于 2010 年初，当时 PHP 5.3 正在逐渐流行起来。我着手证明，尽管 PHP 不允许我这样做，但序列化闭包是可行的。我在前雇主博客HTMList上写了一篇名为使用序列化和反射扩展 PHP 5.3 闭包的文章，展示了如何实现这一点。我还将代码发布在 GitHub 上。

从那时起，我对代码进行了一些迭代，最近几次迭代更加健壮，这得益于使用神奇的nikic/php-parser库。

谁在使用SuperClosure?

• Laravel - 将闭包序列化以推送到作业队列。
• HTTP Mock for PHP - 序列化闭包，在测试工作流程中发送到远程服务器。
• Jumper - 序列化闭包，通过SSH在远程主机上运行。
• nicmart/Benchmark - 使用ClosureParser显示被基准测试的闭包的代码。
• florianv/business - 序列化特殊日期，以存储工作日定义。
• zumba/json-serializer - 将PHP变量序列化为JSON格式。
• PHP-DI - 将闭包定义编译为优化的PHP代码。
• 请告诉我您的项目是否以及如何使用Super Closure。

替代方案

今年推出了Opis Closure库，该库也提供了序列化闭包的功能。您也应该检查它，看看哪一个最适合您的需求。

如果您希望将闭包导出为可执行的PHP代码，您可以查看brick/varexporter库。