深入理解 Laravel 中 config 配置加载原理

Laravel的配置加载其实就是加载config目录下所有文件配置。如何过使用php artisan config:cache则会把加载的配置合并到一个配置文件中,下次请求就不会再去加载config目录。

1.加载流程

  1. LoadEnvironmentVariables .env环境配置加载。如果缓存配置是不会加载.env
  2. LoadConfiguration 判断是否缓存配置
  3. 是,则直接加载配置,不会加载config目录所有文件了
  4. 否,则加载config目录所有PHP文件

2.什么时候加载配置?

内核启动的时候。加载以下启动类

\Illuminate\Foundation\Http\Kernel

protected $bootstrappers = [
        \Illuminate\Foundation\Bootstrap\LoadEnvironmentVariables::class,  // 加载 .env
        \Illuminate\Foundation\Bootstrap\LoadConfiguration::class, // 加载config配置
        ...
    ];

本文重点讲解第二个config配置加载。第一个请查看 深入理解 Laravel 中.env 文件读取
.

3. 源码分析

LoadConfiguration类中config配置加载的具体逻辑。

其实就是判断缓存是否存在,存在则加载,不存在则递归遍历config目录所有php文件。如果运行php artisan config:cache,则会把加载结果保存在bootstrap/cache目录中;你可能还会看到services.php文件,这是一个保存所有的服务提供者的文件,具体以后会讲。

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

       // 首先,我们将看看是否有缓存配置文件。 如果是,我们将从该文件加载配置项,因此它非常快。 
       // 否则,我们需要遍历每个配置文件并加载它们。
        if (file_exists($cached = $app->getCachedConfigPath())) {
            // 加载缓存的配置文件
            $items = require $cached;

            $loadedFromCache = true;
        }

        // 接下来,我们将遍历配置目录中的所有配置文件,并将每个配置文件加载到Repository中。
        // 这将使开发人员可以使用所有选项,以便在此应用程序的各个部分中使用。
        $app->instance('config', $config = new Repository($items));

        // 如果没有缓存配置才会去加载config目录
        if (! isset($loadedFromCache)) {
            // 加载config目录所有PHP文件
            $this->loadConfigurationFiles($app, $config);
        }

        //最后,我们将根据加载的配置值设置应用程序的环境。 
        // 我们将传递一个回调,该回调将用于在Web环境中获取环境,其中不存在“--env”开关。
        $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');
    }

    /**
     * 从所有文件加载配置项。因此效率很低
     *
     * @param  \Illuminate\Contracts\Foundation\Application  $app
     * @param  \Illuminate\Contracts\Config\Repository  $repository
     * @return void
     * @throws \Exception
     */
    protected function loadConfigurationFiles(Application $app, RepositoryContract $repository)
    {
        // 遍历出所有PHP文件
        $files = $this->getConfigurationFiles($app);

        if (! isset($files['app'])) {
            throw new Exception('Unable to load the "app" configuration file.');
        }

        // 一个一个的加载
        foreach ($files as $key => $path) {
            $repository->set($key, require $path);
        }
    }

4.小结与注意点

  1. php artisan config:cache之后不会加载config配置,即便你修改了config目录中的配置文件也是不生效的,除非清除缓存php artisna config:clear,或者重新缓存 php artisan config:cache
  2. 因为配置缓存可以提高效率,因此推荐生产环境使用配置缓存。
  3. 不能在config目录内定义配置以外的东西。比如在config目录内定义类,定义常量,自定义函数。这些都是不推荐的,因为配置缓存之后,config目录任何文件都不会加载,这些类或者常量不存在,最终导致自动加载失败。解决方案是使用composer.json的自动加载配置来加载:
"autoload": {
        "classmap": [
            "database/seeds",
            "database/factories"
        ],
        "psr-4": {
            "App\\": "app/"
        },
        "files": [
            # 这样那个会加载helpers.php文件了。该文件定义的是辅助函数
            "bootstrap/helpers.php"
        ]
    },
  1. config 中调用其他的 config('something.item') 是不会预期的加载的。因为不能保证配置something.item已经加载到了

我的个人博客:http://worthly.cn/

《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
讨论数量: 4

另外在 config 中调用其他的 config('something.item') 是不会预期的加载的。

9个月前 评论

@XiaohuiLam 嗯嗯,谢谢提醒。因为不能保证在使用config('something.item')的时候something.item配置已经加载完了。

9个月前 评论
raybon

这两天遇到这个小坑了,get一下

8个月前 评论
raybon

@XiaohuiLam 如果自定义的 config , 调用 app.php 的配置,如下代码:

'domain'    => config('app.gxd_url', 'http://qs.cindata.cn'),

最终调用的结果是空,但是本地测试确可以,查了一下源码,加载顺序应该没啥问题,这个如果执行了 php artisan config:cache 是正常读取,最近两天遇到的小坑

8个月前 评论

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!