如何在 PHP 中更改环境之间的不同配置设置？

Question

我有一些我通过 AJAX 调用调用的 php 文件。他们都有一个指向我的 config.php 的 URL。现在我遇到的问题是，当我在我的服务器上部署新版本时，我总是必须手动更改该配置文件的 URL。

本地路径：

define('__ROOT__', $_SERVER["DOCUMENT_ROOT"].'/mywebsite');

服务器路径：

define('__ROOT__', $_SERVER["DOCUMENT_ROOT"].'/../dev.my-website.tld/Modules/');

我想跟踪所有这些 PHP 文件的变化。我正在寻找自动更改此路径的解决方案。

例如 这是我目前的工作流程：

本地环境：

• （路径版本 A）
• 修改代码
• git add、git commit、git merge、git push 到我的服务器

服务器：

• git reset --hard
• 将路径更改为版本 B

Answer 1

您正在尝试在开发和实时之间运行不同的代码库，不建议这样做——它们应该是相同的。我解决这个问题的方法是使用环境变量来指定应该加载几个配置文件中的哪一个。

在我的 Apache vhost 中，我执行以下操作：

SetEnv ENVIRONMENT_NAME local

然后我使用一个函数来读取环境名称：

function getEnvironmentName()
{
    $envKeyName = 'ENVIRONMENT_NAME';
    $envName = isset($_SERVER[$envKeyName]) ? $_SERVER[$envKeyName] : null;
    if (!$envName)
    {
        throw new \Exception('No environment name found, cannot proceed');
    }

    return $envName;
}

然后可以在配置文件中使用该环境名称到include，或者从一个以环境为键的数组中检索值。

我经常将特定于环境的设置保存在名为 configs/ 的文件夹中，但您可以将它们存储在应用中任何有意义的位置。所以例如你可以有这个文件：

// This is /configs/local.php

return array(
    'path' => '/mywebsite',
    // As many key-values as you want
);

然后你可以这样做（假设你的前端控制器在你的项目中是一个层次，例如在/web/index.php中）：

$root = dirname(__DIR__);
$config = include($root . '/configs/' . getEnvironmentName() . '.php');

然后，您将可以访问 $config 中相应的每个环境设置。

Answer 2

实现此目的的纯 git 方法是 filters。过滤器非常酷，但经常被忽视。将过滤器视为您可以完全控制的 git 关键字扩展方式。

您的文件的签入版本例如如下所示：

define('__ROOT__', 'MUST_BE_REPLACED_BY_SMUDGE');

然后设置两个过滤器：

• 在您的本地计算机上，您将设置一个 smudge 过滤器来替换
  'MUST_BE_REPLACED_BY_SMUDGE'
  与
  $_SERVER["DOCUMENT_ROOT"].'/mywebsite'

• 在您的服务器上，您将设置一个 smudge 过滤器来替换
  'MUST_BE_REPLACED_BY_SMUDGE'
  与
  $_SERVER["DOCUMENT_ROOT"].'/../dev.my-website.tld/Modules/'

• 在两台机器上，clean 过滤器会将行恢复为
  define('__ROOT__', 'MUST_BE_REPLACED_BY_SMUDGE');

有关过滤器的更多信息，请参阅this answer 和Git Book。