摘要：在啟動時會加載項目中的文件。我們來看一下的源碼來分析下是怎么加載中的配置的。我們來看看函數(shù)的源碼它直接通過內(nèi)建函數(shù)讀取環(huán)境變量。我們看到了在加載配置和讀取配置的時候，使用了和兩個函數(shù)。

Laravel在啟動時會加載項目中的.env文件。對于應(yīng)用程序運行的環(huán)境來說，不同的環(huán)境有不同的配置通常是很有用的。 例如，你可能希望在本地使用測試的Mysql數(shù)據(jù)庫而在上線后希望項目能夠自動切換到生產(chǎn)Mysql數(shù)據(jù)庫。本文將會詳細(xì)介紹 env 文件的使用與源碼的分析。

項目中env文件的數(shù)量往往是跟項目的環(huán)境數(shù)量相同，假如一個項目有開發(fā)、測試、生產(chǎn)三套環(huán)境那么在項目中應(yīng)該有三個.env.dev、.env.test、.env.prod三個環(huán)境配置文件與環(huán)境相對應(yīng)。三個文件中的配置項應(yīng)該完全一樣，而具體配置的值應(yīng)該根據(jù)每個環(huán)境的需要來設(shè)置。

接下來就是讓項目能夠根據(jù)環(huán)境加載不同的env文件了。具體有三種方法，可以按照使用習(xí)慣來選擇使用:

在環(huán)境的nginx配置文件里設(shè)置APP_ENV環(huán)境變量fastcgi_param APP_ENV dev;

設(shè)置服務(wù)器上運行PHP的用戶的環(huán)境變量，比如在www用戶的/home/www/.bashrc中添加export APP_ENV dev

在部署項目的持續(xù)集成任務(wù)或者部署腳本里執(zhí)行cp .env.dev .env

針對前兩種方法，Laravel會根據(jù)env("APP_ENV")加載到的變量值去加載對應(yīng)的文件.env.dev、.env.test這些。 具體在后面源碼里會說，第三種比較好理解就是在部署項目時將環(huán)境的配置文件覆蓋到.env文件里這樣就不需要在環(huán)境的系統(tǒng)和nginx里做額外的設(shè)置了。

env文件默認(rèn)放在項目的根目錄中，laravel 為用戶提供了自定義 ENV 文件路徑或文件名的函數(shù)，

例如，若想要自定義 env 路徑，可以在 bootstrap 文件夾中 app.php 中使用Application實例的useEnvironmentPath方法：

$app = new IlluminateFoundationApplication(
    realpath(__DIR__."/../")
);

$app->useEnvironmentPath("/customer/path")

若想要自定義 env 文件名稱，就可以在 bootstrap 文件夾中 app.php 中使用Application實例的loadEnvironmentFrom方法：

$app = new IlluminateFoundationApplication(
    realpath(__DIR__."/../")
);

$app->loadEnvironmentFrom("customer.env")

Laravel加載ENV的是在框架處理請求之前，bootstrap過程中的LoadEnvironmentVariables階段中完成的。

我們來看一下IlluminateFoundationBootstrapLoadEnvironmentVariables的源碼來分析下Laravel是怎么加載env中的配置的。

configurationIsCached()) {
            return;
        }

        $this->checkForSpecificEnvironmentFile($app);

        try {
            (new Dotenv($app->environmentPath(), $app->environmentFile()))->load();
        } catch (InvalidPathException $e) {
            //
        }
    }

    /**
     * Detect if a custom environment file matching the APP_ENV exists.
     *
     * @param  IlluminateContractsFoundationApplication  $app
     * @return void
     */
    protected function checkForSpecificEnvironmentFile($app)
    {
        if ($app->runningInConsole() && ($input = new ArgvInput)->hasParameterOption("--env")) {
            if ($this->setEnvironmentFilePath(
                $app, $app->environmentFile().".".$input->getParameterOption("--env")
            )) {
                return;
            }
        }

        if (! env("APP_ENV")) {
            return;
        }

        $this->setEnvironmentFilePath(
            $app, $app->environmentFile().".".env("APP_ENV")
        );
    }

    /**
     * Load a custom environment file.
     *
     * @param  IlluminateContractsFoundationApplication  $app
     * @param  string  $file
     * @return bool
     */
    protected function setEnvironmentFilePath($app, $file)
    {
        if (file_exists($app->environmentPath()."/".$file)) {
            $app->loadEnvironmentFrom($file);

            return true;
        }

        return false;
    }
}

在他的啟動方法bootstrap中，Laravel會檢查配置是否緩存過以及判斷應(yīng)該應(yīng)用那個env文件，針對上面說的根據(jù)環(huán)境加載配置文件的三種方法中的頭兩種，因為系統(tǒng)或者nginx環(huán)境變量中設(shè)置了APP_ENV，所以Laravel會在checkForSpecificEnvironmentFile方法里根據(jù) APP_ENV的值設(shè)置正確的配置文件的具體路徑， 比如.env.dev或者.env.test，而針對第三中情況則是默認(rèn)的.env， 具體可以參看下面的checkForSpecificEnvironmentFile還有相關(guān)的Application里的兩個方法的源碼：

protected function checkForSpecificEnvironmentFile($app)
{
    if ($app->runningInConsole() && ($input = new ArgvInput)->hasParameterOption("--env")) {
        if ($this->setEnvironmentFilePath(
            $app, $app->environmentFile().".".$input->getParameterOption("--env")
        )) {
            return;
        }
    }

    if (! env("APP_ENV")) {
        return;
    }

    $this->setEnvironmentFilePath(
        $app, $app->environmentFile().".".env("APP_ENV")
    );
}

namespace IlluminateFoundation;
class Application ....
{

    public function environmentPath()
    {
        return $this->environmentPath ?: $this->basePath;
    }
    
    public function environmentFile()
    {
        return $this->environmentFile ?: ".env";
    }
}

判斷好后要讀取的配置文件的路徑后，接下來就是加載env里的配置了。

(new Dotenv($app->environmentPath(), $app->environmentFile()))->load();

Laravel使用的是Dotenv的PHP版本vlucas/phpdotenv

class Dotenv
{
    public function __construct($path, $file = ".env")
    {
        $this->filePath = $this->getFilePath($path, $file);
        $this->loader = new Loader($this->filePath, true);
    }

    public function load()
    {
        return $this->loadData();
    }

    protected function loadData($overload = false)
    {
        $this->loader = new Loader($this->filePath, !$overload);

        return $this->loader->load();
    }
}

它依賴/Dotenv/Loader來加載數(shù)據(jù)：

class Loader
{
    public function load()
    {
        $this->ensureFileIsReadable();

        $filePath = $this->filePath;
        $lines = $this->readLinesFromFile($filePath);
        foreach ($lines as $line) {
            if (!$this->isComment($line) && $this->looksLikeSetter($line)) {
                $this->setEnvironmentVariable($line);
            }
        }

        return $lines;
    }
}

Loader讀取配置時readLinesFromFile函數(shù)會用file函數(shù)將配置從文件中一行行地讀取到數(shù)組中去，然后排除以#開頭的注釋，針對內(nèi)容中包含=的行去調(diào)用setEnvironmentVariable方法去把文件行中的環(huán)境變量配置到項目中去：

namespace Dotenv;
class Loader
{
    public function setEnvironmentVariable($name, $value = null)
    {
        list($name, $value) = $this->normaliseEnvironmentVariable($name, $value);

        $this->variableNames[] = $name;

        // Don"t overwrite existing environment variables if we"re immutable
        // Ruby"s dotenv does this with `ENV[key] ||= value`.
        if ($this->immutable && $this->getEnvironmentVariable($name) !== null) {
            return;
        }

        // If PHP is running as an Apache module and an existing
        // Apache environment variable exists, overwrite it
        if (function_exists("apache_getenv") && function_exists("apache_setenv") && apache_getenv($name)) {
            apache_setenv($name, $value);
        }

        if (function_exists("putenv")) {
            putenv("$name=$value");
        }

        $_ENV[$name] = $value;
        $_SERVER[$name] = $value;
    }
    
    public function getEnvironmentVariable($name)
    {
        switch (true) {
            case array_key_exists($name, $_ENV):
                return $_ENV[$name];
            case array_key_exists($name, $_SERVER):
                return $_SERVER[$name];
            default:
                $value = getenv($name);
                return $value === false ? null : $value; // switch getenv default to null
        }
    }
}

Dotenv實例化Loader的時候把Loader對象的$immutable屬性設(shè)置成了false，Loader設(shè)置變量的時候如果通過getEnvironmentVariable方法讀取到了變量值，那么就會跳過該環(huán)境變量的設(shè)置。所以Dotenv默認(rèn)情況下不會覆蓋已經(jīng)存在的環(huán)境變量，這個很關(guān)鍵，比如說在docker的容器編排文件里，我們會給PHP應(yīng)用容器設(shè)置關(guān)于Mysql容器的兩個環(huán)境變量

    environment:
      - "DB_PORT=3306"
      - "DB_HOST=database"

這樣在容器里設(shè)置好環(huán)境變量后，即使env文件里的DB_HOST為homestead用env函數(shù)讀取出來的也還是容器里之前設(shè)置的DB_HOST環(huán)境變量的值database(docker中容器鏈接默認(rèn)使用服務(wù)名稱，在編排文件中我把mysql容器的服務(wù)名稱設(shè)置成了database, 所以php容器要通過database這個host來連接mysql容器)。因為用我們在持續(xù)集成中做自動化測試的時候通常都是在容器里進(jìn)行測試，所以Dotenv不會覆蓋已存在環(huán)境變量這個行為就相當(dāng)重要這樣我就可以只設(shè)置容器里環(huán)境變量的值完成測試而不用更改項目里的env文件，等到測試完成后直接去將項目部署到環(huán)境上就可以了。

如果檢查環(huán)境變量不存在那么接著Dotenv就會把環(huán)境變量通過PHP內(nèi)建函數(shù)putenv設(shè)置到環(huán)境中去，同時也會存儲到$_ENV和$_SERVER這兩個全局變量中。

在Laravel應(yīng)用程序中可以使用env()函數(shù)去讀取環(huán)境變量的值，比如獲取數(shù)據(jù)庫的HOST：

env("DB_HOST`, "localhost");

傳遞給 env 函數(shù)的第二個值是「默認(rèn)值」。如果給定的鍵不存在環(huán)境變量，則會使用該值。

我們來看看env函數(shù)的源碼：

function env($key, $default = null)
{
    $value = getenv($key);

    if ($value === false) {
        return value($default);
    }

    switch (strtolower($value)) {
        case "true":
        case "(true)":
            return true;
        case "false":
        case "(false)":
            return false;
        case "empty":
        case "(empty)":
            return "";
        case "null":
        case "(null)":
            return;
    }

    if (strlen($value) > 1 && Str::startsWith($value, """) && Str::endsWith($value, """)) {
        return substr($value, 1, -1);
    }

    return $value;
}

它直接通過PHP內(nèi)建函數(shù)getenv讀取環(huán)境變量。

我們看到了在加載配置和讀取配置的時候，使用了putenv和getenv兩個函數(shù)。putenv設(shè)置的環(huán)境變量只在請求期間存活，請求結(jié)束后會恢復(fù)環(huán)境之前的設(shè)置。因為如果php.ini中的variables_order配置項成了 GPCS不包含E的話，那么php程序中是無法通過$_ENV讀取環(huán)境變量的，所以使用putenv動態(tài)地設(shè)置環(huán)境變量讓開發(fā)人員不用去關(guān)注服務(wù)器上的配置。而且在服務(wù)器上給運行用戶配置的環(huán)境變量會共享給用戶啟動的所有進(jìn)程，這就不能很好的保護(hù)比如DB_PASSWORD、API_KEY這種私密的環(huán)境變量，所以這種配置用putenv設(shè)置能更好的保護(hù)這些配置信息，getenv方法能獲取到系統(tǒng)的環(huán)境變量和putenv動態(tài)設(shè)置的環(huán)境變量。

本文已經(jīng)收錄在系列文章Laravel源碼學(xué)習(xí)里，歡迎訪問閱讀。