在系统管理或自动化部署中，我们经常需要通过命令行修改配置文件。对于 php 配置文件，特别是那些包含复杂数组结构的，直接使用 sed 或 cat 等工具可能会因为破坏 php 语法而导致问题。例如，当一个 php 数组以 ); 结尾时，简单地追加内容会导致语法错误。本教程将展示如何巧妙地使用 awk 来解决这一挑战。
挑战分析：向 PHP 数组追加内容
假设我们有一个 config.php 文件，其中包含一个名为 $CONFIG 的 PHP 数组：
<?php $CONFIG = array ( 'installed' => true, 'instanceid' => 'sdsdfsfdsdf', 'ldapProviderFactory' => 'OCA\User_LDAP\LDAPProviderFactory', );
现在，我们需要向 $CONFIG 数组中追加一个新的配置项，例如一个存储配置：
array (
'class' => '\OC\Files\ObjectStore\S3',
'arguments' =>
array (
'val1' => 'val1x',
'val2' => 'val1x',
),
),如果直接使用 cat 命令将新内容追加到 config.php 的末尾，那么文件会变成这样：
<?php
$CONFIG = array (
'installed' => true,
'instanceid' => 'sdsdfsfdsdf',
'ldapProviderFactory' => 'OCA\User_LDAP\LDAPProviderFactory',
); // <-- 原始的结束符
array ( // <-- 新内容开始
'class' => '\OC\Files\ObjectStore\S3',
'arguments' =>
array (
'val1' => 'val1x',
'val2' => 'val1x',
),
),这显然会导致 PHP 语法错误。正确的做法是，将新内容插入到原始数组的最后一个元素和 ); 之间。最终期望的文件结构如下：
立即学习“PHP免费学习笔记（深入）”；
<?php
$CONFIG = array (
'installed' => true,
'instanceid' => 'sdsdfsfdsdf',
'ldapProviderFactory' => 'OCA\User_LDAP\LDAPProviderFactory',
array ( // <-- 新内容在此处
'class' => '\OC\Files\ObjectStore\S3',
'arguments' =>
array (
'val1' => 'val1x',
'val2' => 'val1x',
),
),
);使用 Awk 实现安全的数组追加
awk 是一个强大的文本处理工具，它允许我们按行处理文件，并在特定模式匹配时执行操作。我们可以利用 awk 来识别 ); 这一行，并在其之前插入我们的新内容。
步骤一：准备数据文件
首先，将要追加的 PHP 数组内容保存到一个单独的文件中，例如 add.txt：
array (
'class' => '\OC\Files\ObjectStore\S3',
'arguments' =>
array (
'val1' => 'val1x',
'val2' => 'val1x',
),
),请注意，为了保持格式一致性，新内容前的缩进与 $CONFIG 数组中的其他元素保持一致。
步骤二：创建 Awk 脚本
创建一个名为 merge.awk 的文件，并添加以下内容：
#!/usr/bin/awk -f
# 对于不包含 ");" 的行，直接打印
!/);/ {
print
}
# 当文件处理完毕后执行 END 块
END {
# 插入 add.txt 中的内容
system("cat add.txt")
# 重新打印 ");" 结束符
print ");"
}脚本解释：
- #!/usr/bin/awk -f：指定使用 awk 解释器执行此脚本。
- !/);/ { print }：这是一个模式-动作对。模式是 !/);/，表示“不匹配包含字符串 ); 的行”。如果一行不包含 );，则执行动作 { print }，即打印该行到标准输出。这样，除了最后一行（包含 );）之外的所有行都会被原样输出。
- END { ... }：这是一个特殊的 awk 块，它会在 awk 处理完所有输入文件后执行一次。
- system("cat add.txt")：在 END 块中，system() 函数用于执行一个外部 shell 命令。这里，它会执行 cat add.txt，将 add.txt 文件的内容输出到 awk 的标准输出。这正是我们插入新数组内容的地方。
- print ");"：最后，打印回 );，以确保 PHP 数组的正确闭合。
步骤三：执行 Awk 脚本
在命令行中执行 awk 脚本，将 config.php 作为输入文件：
chmod +x merge.awk # 赋予脚本执行权限 ./merge.awk config.php > new_config.php
执行上述命令后，new_config.php 文件将包含合并后的内容。
示例输出：
<?php
$CONFIG = array (
'installed' => true,
'instanceid' => 'sdsdfsfdsdf',
'ldapProviderFactory' => 'OCA\User_LDAP\LDAPProviderFactory',
array (
'class' => '\OC\Files\ObjectStore\S3',
'arguments' =>
array (
'val1' => 'val1x',
'val2' => 'val1x',
),
),
);您可以检查 new_config.php 的内容，确认数组已成功追加且语法正确。如果满意，可以将其替换原始文件：
mv new_config.php config.php
注意事项与最佳实践
- 备份文件： 在对任何重要配置文件进行修改之前，务必创建备份。例如：cp config.php config.php.bak。
- 文件路径： 确保 add.txt 和 config.php 的路径在执行命令时是正确的。如果它们不在当前目录，需要提供完整路径。
- 幂等性： 本教程提供的 awk 脚本并非幂等的。这意味着如果您多次运行它，它会多次追加相同的数组内容。在实际应用中，您可能需要添加逻辑来检查是否已存在该配置，以避免重复。
- 复杂 PHP 结构： 此 awk 脚本适用于数组以 ); 独立一行或作为文件最后一行结束的简单情况。对于更复杂的 PHP 结构，例如 ); 后面还有其他代码，或者数组嵌套非常深，此脚本可能需要调整，甚至可能需要更专业的 PHP 解析器来处理。
- 缩进和格式： add.txt 中的内容应该有正确的缩进，以确保最终文件的可读性。
- 错误处理： 脚本没有内置的错误处理机制。例如，如果 add.txt 不存在，system("cat add.txt") 会失败。在生产环境脚本中，应考虑添加错误检查。
总结
通过本教程，我们学习了如何利用 awk 这一强大的 Linux 命令行工具，以一种安全且语法友好的方式向 PHP 配置文件中的数组追加新的配置项。这种方法尤其适用于自动化脚本和部署场景，能够有效避免手动修改可能引入的错误，并确保 PHP 配置文件的完整性。记住，在进行任何文件修改时，备份总是最重要的第一步。
