概述与挑战
在系统管理或自动化部署场景中，我们经常需要通过脚本修改服务器上的配置文件。对于 php 应用而言，这意味着可能需要向 config.php 这类文件中定义的 php 数组追加新的配置项。然而，直接使用 cat 等命令简单地追加内容，往往会导致 php 语法错误，因为 php 数组通常以 ); 结尾，直接追加会破坏其结构。例如，一个典型的 php 数组配置文件可能如下所示：
true, 'instanceid' => 'sdsdfsfdsdf', 'ldapProviderFactory' => 'OCA\\User_LDAP\\LDAPProviderFactory', );
我们希望追加一个新的数组元素，使其最终结构变为：
true,
'instanceid' => 'sdsdfsfdsdf',
'ldapProviderFactory' => 'OCA\\User_LDAP\\LDAPProviderFactory',
array (
'class' => '\\OC\\Files\\ObjectStore\\S3',
'arguments' =>
array (
'val1' => 'val1x',
'val2' => 'val1x',
),
),
);显然，这需要将新数组内容插入到 ) 之前，并重新添加 );。
解决方案：利用 awk 进行精确插入
awk 是一个功能强大的文本处理工具，它能够逐行扫描文件，并根据模式匹配执行相应的操作。这使得 awk 非常适合处理这种需要精确插入和结构调整的任务。
核心思路是：
立即学习“PHP免费学习笔记（深入）”；
- 逐行读取原始 PHP 文件。
- 当遇到表示数组结束的 ); 之前，将所有行照常输出。
- 在遇到 ); 时，不立即输出它，而是先输出我们想要追加的新数组元素。
- 最后，再输出被“推迟”的 );。
准备工作
为了演示方便，我们假设原始 PHP 配置内容保存在 config.php 文件中，而要追加的数组元素内容保存在 new_array_element.txt 文件中。
config.php (原始文件):
true, 'instanceid' => 'sdsdfsfdsdf', 'ldapProviderFactory' => 'OCA\\User_LDAP\\LDAPProviderFactory', );
new_array_element.txt (要追加的内容):
array (
'class' => '\\OC\\Files\\ObjectStore\\S3',
'arguments' =>
array (
'val1' => 'val1x',
'val2' => 'val1x',
),
),请注意，new_array_element.txt 中的内容需要包含正确的缩进和逗号，以确保与 $CONFIG 数组的现有格式兼容。
awk 脚本编写
我们可以创建一个 awk 脚本文件，例如 append_array.awk：
#!/usr/bin/awk -f
# 对于不包含 ");" 的行，直接打印
!/);/ {
print
}
# 当文件处理结束时执行 END 块
END {
# 使用 system 命令将新数组元素文件内容插入
system("cat new_array_element.txt")
# 重新打印数组的结束符
print ");"
}脚本解释：
- #!/usr/bin/awk -f: 指定使用 awk 解释器执行此脚本。
- !/);/ { print }: 这是一个条件语句。!/);/ 表示“如果当前行不包含字符串 );”，则执行 { print }，即打印当前行。这样，除了最后一行 ); 之外，所有行都会被原样输出。
- END { ... }: END 块在 awk 处理完所有输入行之后执行。
- system("cat new_array_element.txt"): 在这里，我们使用 system() 函数执行一个 shell 命令，将 new_array_element.txt 文件的内容输出到标准输出。这正是我们想要插入的新数组元素。
- print ");": 最后，我们手动打印出被“跳过”的 );，从而正确闭合 PHP 数组。
执行 awk 脚本
要执行此脚本并查看输出，可以使用以下命令：
awk -f append_array.awk config.php
或者，如果 append_array.awk 具有执行权限：
chmod +x append_array.awk ./append_array.awk config.php
预期输出：
true,
'instanceid' => 'sdsdfsfdsdf',
'ldapProviderFactory' => 'OCA\\User_LDAP\\LDAPProviderFactory',
array (
'class' => '\\OC\\Files\\ObjectStore\\S3',
'arguments' =>
array (
'val1' => 'val1x',
'val2' => 'val1x',
),
),
);将输出重定向到文件
要将结果保存回原始文件或新文件，可以使用重定向操作符：
# 将输出保存到新文件 awk -f append_array.awk config.php > config_new.php # 或者，谨慎地覆盖原文件（建议先备份） # awk -f append_array.awk config.php > temp_config.php && mv temp_config.php config.php
重要提示： 直接将 awk 的输出重定向回原始文件 (awk ... config.php > config.php) 可能会导致文件内容丢失，因为 shell 会在 awk 读取文件之前清空目标文件。因此，始终建议先输出到临时文件，再进行替换。
注意事项与最佳实践
-
备份文件： 在进行任何文件修改操作之前，务必备份原始配置文件。这是防止数据丢失和系统不稳定的最重要步骤。
cp config.php config.php.bak
- 新数组元素的格式： 确保 new_array_element.txt 中的内容是合法的 PHP 数组元素，并且其缩进和逗号与目标数组的现有格式保持一致，以保证生成的 PHP 文件语法正确。
- 模式匹配的精确性： 本例中我们依赖 ); 作为数组结束的标志。如果 PHP 文件中有其他地方也包含 );，但并非数组的结束符，则需要更精确的模式匹配来避免误操作。例如，可以匹配 $CONFIG 数组块内的 );。
- 幂等性： 如果脚本需要多次运行，考虑如何避免重复添加相同的数组元素。这可能需要 awk 脚本在添加前检查元素是否已存在。
-
动态内容： 如果要添加的数组元素是动态生成的，可以通过 shell 变量或管道将内容传递给 awk，而不是硬编码到 new_array_element.txt 文件中。
# 示例：通过变量传递内容 NEW_ELEMENT=" 'new_key' => 'new_value'," awk -v new_element="$NEW_ELEMENT" '!/);/ {print} END {print new_element; print ");"}' config.php这种方法可以避免创建临时文件。
总结
通过 awk 结合其强大的文本处理能力，我们可以精确地在 PHP 配置文件中插入新的数组元素，同时确保生成的 PHP 文件保持正确的语法结构。这种方法比简单的 cat 命令更健壮，也比手动编辑更适合自动化。掌握这类命令行工具的使用，对于提高系统管理和部署的效率至关重要。始终记住在生产环境中操作前进行充分的测试和备份。
