想象一下这样的场景：你正在开发一个用户管理系统，用户的配置信息以数组的形式存储。当用户更新了他们的设置时，你不仅需要保存新的配置，可能还需要记录下“具体是哪些设置从什么值变成了什么值”，或者只更新数据库中发生变化的部分，避免全量更新。
我曾面临的困境：
起初，我尝试自己编写递归函数来比较两个多维数组。这不仅代码量大，而且要考虑到新增、修改、删除三种操作，以及不同数据类型（字符串、数字、布尔、嵌套数组甚至对象）的比较逻辑，整个过程异常繁琐且容易出错。尤其当需要处理“部分更新”或“生成审计日志”时，仅仅知道“变了”是不够的，我们还需要知道“怎么变了”。如果数据结构中包含对象，简单的 === 比较也往往不适用，我可能需要根据对象的某个唯一标识符来判断是否是同一个对象。
Composer 在线学习地址：学习地址
diff/diff：我的救星
就在我为这些复杂逻辑焦头烂额之际，我发现了 diff/diff 这个 Composer 库。它是一款小巧而强大的独立 PHP 库，专门用于表示、计算和应用数据结构之间的差异。与处理文本差异的工具不同，diff/diff 专注于结构化数据，这正是我的痛点所在。
如何使用 Composer 引入 diff/diff？
使用 Composer 安装 diff/diff 库非常简单，只需在你的项目根目录执行：
composer require diff/diff:~3.0
这会将 diff/diff 添加到你的 composer.json 文件中，并下载到 vendor 目录。
diff/diff 的核心概念与实践
diff/diff 库主要由三个核心组件构成：
-
DiffOp： 表示差异操作的 Value Object。它定义了四种基本操作：
-
DiffOpAdd：添加了一个新值。 -
DiffOpChange：一个值发生了改变（包含旧值和新值）。 -
DiffOpRemove：移除了一个旧值。 -
Diff：一个复合操作，用于表示嵌套结构中的差异集合。
-
-
Differ： 用于计算两个数据集之间的差异，并返回一个
DiffOp数组。 -
Patcher： 用于将计算出的差异（
DiffOp数组）应用到一个基础数据结构上，从而生成新的数据结构。
实战案例：比较并应用用户配置差异
假设我们有用户新旧两份配置：
'alice',
'email' => 'alice@example.com',
'settings' => [
'theme' => 'dark',
'notifications' => true,
'language' => 'en',
],
'roles' => ['user', 'editor'],
];
$newConfig = [
'username' => 'alice_new', // 改变
'email' => 'alice.smith@example.com', // 改变
'settings' => [
'theme' => 'light', // 改变
'notifications' => false, // 改变
'timezone' => 'UTC', // 新增
],
// 'roles' 被移除
'status' => 'active', // 新增
];
// 1. 计算差异 (Diffing data)
$differ = new MapDiffer(); // MapDiffer 适用于关联数组，并支持递归比较
$diff = $differ->doDiff($oldConfig, $newConfig);
echo "--- 计算出的差异 ---" . PHP_EOL;
foreach ($diff as $key => $op) {
if ($op instanceof DiffOpAdd) {
echo "Added '{$key}': " . json_encode($op->getNewValue()) . PHP_EOL;
} elseif ($op instanceof DiffOpChange) {
echo "Changed '{$key}': from " . json_encode($op->getOldValue()) . " to " . json_encode($op->getNewValue()) . PHP_EOL;
} elseif ($op instanceof DiffOpRemove) {
echo "Removed '{$key}': " . json_encode($op->getOldValue()) . PHP_EOL;
} elseif ($op instanceof \Diff\DiffOp\Diff) { // 处理嵌套的 Diff
echo "Nested diff for '{$key}':" . PHP_EOL;
foreach ($op->getOps() as $nestedKey => $nestedOp) {
if ($nestedOp instanceof DiffOpAdd) {
echo " Added '{$nestedKey}': " . json_encode($nestedOp->getNewValue()) . PHP_EOL;
} elseif ($nestedOp instanceof DiffOpChange) {
echo " Changed '{$nestedKey}': from " . json_encode($nestedOp->getOldValue()) . " to " . json_encode($nestedOp->getNewValue()) . PHP_EOL;
} elseif ($nestedOp instanceof DiffOpRemove) {
echo " Removed '{$nestedKey}': " . json_encode($nestedOp->getOldValue()) . PHP_EOL;
}
}
}
}
// 2. 应用差异 (Applying patches)
$patcher = new MapPatcher();
$patchedConfig = $patcher->patch($oldConfig, $diff);
echo PHP_EOL . "--- 应用补丁后的配置 ---" . PHP_EOL;
echo json_encode($patchedConfig, JSON_PRETTY_PRINT) . PHP_EOL;
// 验证应用补丁后的配置是否与新配置一致
// assert($patchedConfig == $newConfig); // 实际项目中可以进行断言运行上述代码，你会看到 diff/diff 精确地识别出了 username、email、settings 中的变化，roles 的移除，以及 status 和 settings.timezone 的新增。最后，MapPatcher 成功地将这些差异应用到了 oldConfig 上，生成了一个与 newConfig 完全一致的新配置。
diff/diff 的优势与实际应用效果：
- 精确的差异表示： 它不仅仅告诉你“有变化”，而是精确地指出“哪个键被添加/修改/删除，旧值是什么，新值是什么”，这对于审计、日志记录和精细化控制至关重要。
-
灵活的比较策略：
diff/diff允许你定义自己的比较器（ValueComparer），这意味着你可以根据业务需求，自定义如何判断两个值是否相等。例如，你可以让它忽略某些字段的差异，或者根据对象的 ID 来比较两个对象是否相同。 - 易于集成： 作为独立的 Composer 库，它没有复杂的依赖，可以轻松集成到任何 PHP 项目中。
- 提高开发效率： 告别手写复杂的递归比较逻辑，将精力集中在业务核心。
实际应用场景：
- 配置管理： 比较应用程序不同版本的配置，只应用那些真正改变的配置项。
- 数据同步： 在分布式系统中，只同步发生变化的数据块，减少网络传输和数据库操作。
- 审计日志： 记录用户对关键数据（如产品信息、权限设置）的修改历史，明确每次操作的具体变更内容。
- 版本控制： 为结构化数据（如 JSON、YAML 文件解析后的数组）实现类似 Git 的版本控制，存储 diff 而非全量副本。
- API 测试： 比较不同版本的 API 响应，快速定位非预期的行为变化。
diff/diff 库为处理 PHP 中的结构化数据差异提供了一个优雅而强大的解决方案。如果你也曾为复杂的数组/对象比较而烦恼，不妨尝试一下 diff/diff，它定能让你的代码更健壮、更高效。
