Laravel Config—— 配置檔案的載入與原始碼解析

前言

本文 GitBook 地址： https://www.gitbook.com/book/leoyang90/laravel-source-analysis

本文主要介紹 laravel 載入 config 配置檔案的相關原始碼。

 

config 配置檔案的載入

config 配置檔案由類 \Illuminate\Foundation\Bootstrap\LoadConfiguration::class 完成：

class LoadConfiguration
{
    public function bootstrap(Application $app)
    {
        $items = [];

        if (file_exists($cached = $app->getCachedConfigPath())) {
            $items = require $cached;

            $loadedFromCache = true;
        }

        $app->instance('config', $config = new Repository($items));

        if (! isset($loadedFromCache)) {
            $this->loadConfigurationFiles($app, $config);
        }

        $app->detectEnvironment(function () use ($config) {
            return $config->get('app.env', 'production');
        });

        date_default_timezone_set($config->get('app.timezone', 'UTC'));

        mb_internal_encoding('UTF-8');
    }
}

可以看到，配置檔案的載入步驟：

• 載入快取
• 若快取不存在，則利用函式 loadConfigurationFiles 載入配置檔案
• 載入環境變數、時間區、編碼方式

函式 loadConfigurationFiles 用於載入配置檔案：

protected function loadConfigurationFiles(Application $app, RepositoryContract $repository)
{
    foreach ($this->getConfigurationFiles($app) as $key => $path) {
        $repository->set($key, require $path);
   }
}

載入配置檔案有兩部分：搜尋配置檔案、載入配置檔案的陣列變數值

搜尋配置檔案

getConfigurationFiles 可以根據配置檔案目錄搜尋所有的 php 為字尾的檔案，並將其轉化為 files 陣列，其 key 為目錄名以字元 . 為連線的字串 ，value 為檔案真實路徑：

protected function getConfigurationFiles(Application $app)
{
    $files = [];

    $configPath = realpath($app->configPath());

    foreach (Finder::create()->files()->name('*.php')->in($configPath) as $file) {
        $directory = $this->getNestedDirectory($file, $configPath);

        $files[$directory.basename($file->getRealPath(), '.php')] = $file->getRealPath();
    }

    return $files;
}

protected function getNestedDirectory(SplFileInfo $file, $configPath)
{
    $directory = $file->getPath();

    if ($nested = trim(str_replace($configPath, '', $directory), DIRECTORY_SEPARATOR)) {
        $nested = str_replace(DIRECTORY_SEPARATOR, '.', $nested).'.';
    }

    return $nested;
}

載入配置檔案陣列

載入配置檔案由類 Illuminate\Config\Repository\LoadConfiguration 完成：

class Repository
{
    public function set($key, $value = null)
    {
        $keys = is_array($key) ? $key : [$key => $value];

        foreach ($keys as $key => $value) {
            Arr::set($this->items, $key, $value);
        }
    }
}

載入配置檔案時間上就是將所有配置檔案的數值放入一個巨大的多維陣列中，這一部分由類 Illuminate\Support\Arr 完成：

class Arr
{
    public static function set(&$array, $key, $value)
    {
        if (is_null($key)) {
            return $array = $value;
        }

        $keys = explode('.', $key);

        while (count($keys) > 1) {
            $key = array_shift($keys);

            if (! isset($array[$key]) || ! is_array($array[$key])) {
                $array[$key] = [];
            }

            $array = &$array[$key];
        }

        $array[array_shift($keys)] = $value;

        return $array;
    }
}

例如 dir1.dir2.app ,配置檔案會生成 $array[dir1][dir2][app] 這樣的陣列。

 

配置檔案數值的獲取

當我們利用全域性函式 config 來獲取配置值的時候：

function config($key = null, $default = null)
{
    if (is_null($key)) {
        return app('config');
    }

    if (is_array($key)) {
        return app('config')->set($key);
    }

    return app('config')->get($key, $default);
}

配置檔案的獲取和載入類似，都是將字串轉為多維陣列，然後獲取具體陣列值：

public static function get($array, $key, $default = null)
{
    if (! static::accessible($array)) {
        return value($default);
    }

    if (is_null($key)) {
        return $array;
    }

    if (static::exists($array, $key)) {
        return $array[$key];
    }

    foreach (explode('.', $key) as $segment) {
        if (static::accessible($array) && static::exists($array, $segment)) {
            $array = $array[$segment];
        } else {
            return value($default);
        }
    }

    return $array;
}