bob体育appLaravel中env函数的小坑

2020-02-15 08:35栏目:bob体育平台
TAG:

bob体育平台,发现问题

不知道大家有没有遇到过,在 Laravel 中(除 app/config 目录下的配置文件中)使用 env 函数读取环境变量,有时有用,有时返回 null,究竟怎么回事?让我们一探究竟。

昨天同事在他的项目中遇到了一个技术难题让我协助解决

在 Laravel 项目中,如果执行了 php artisan config:cache 命令把配置文件缓存起来后,在 Tinker 中(Tinker 是 Laravel 自带的一个交互式命令行界面),使用 env函数读取环境变量的值为 null,只有执行 php artisan config:clear清除配置缓存后就可以读取了,这是为什么呢?

在 Laravel 项目中,如果执行了 php artisan config:cache 命令把配置文件缓存起来后,在 Tinker 中演示(Tinker 是 Laravel 自带的一个交互式命令行界面),使用 env 函数读取环境变量的值为 null,只有执行 php artisan config:clear 清除配置缓存后就可以读取了,这是为什么呢?

bob体育app,问题出在env helper 函数上,在Middleware中读取环境变量时取到的竟然是null

一探究竟

如图:

dump(env('APP_ENV') === null); // true

打开 .env 文件看,这些都是有值的:

bob体育app 1

据他反映,之前本地开发时功能都是正常的,上线之后才开始出现的问题

APP_ENV=localAPP_KEY=base64:JHE5bOkRg283uT0n1Zq/GgvGEer8ooYiB42/wIcCyvo=APP_DEBUG=trueAPP_LOG_LEVEL=debugAPP_URL=http://www.tanteng.me DB_CONNECTION=mysqlDB_HOST=127.0.0.1DB_PORT=3306DB_DATABASE=tanteng.meDB_USERNAME=homesteadDB_PASSWORD=secret

原因何在?#

在 Laravel 中,如果执行 php aritisan config:cache 命令,Laravel 将会把 app/config 目录下的所有配置文件“编译”整合成一个缓存配置文件到 bootstrap/cache/config.php,每个配置文件都可以通过 env 函数读取环境变量,这里是可以读取的。但是一旦有了这个缓存配置文件,在其他地方使用 env 函数是读取不到环境变量的,所以返回 null.

让我们看看这段代码,Illuminate/Foundation/Bootstrap/DetectEnvironment.php line 18:

public function bootstrap(Application $app)
{
    if (! $app->configurationIsCached()) {
        $this->checkForSpecificEnvironmentFile($app);

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

这个方法在框架启动后就会运行,这段代码说明了如果存在缓存配置文件,就不会去设置环境变量了,配置都读缓存配置文件,而不会再读环境变量了。

因此,在配置文件即 app/config 目录下的其他地方,读取配置不要使用 env 函数去读环境变量,这样你一旦执行 php artisan config:cache 之后,env 函数就不起作用了。所有要用到的环境变量,在 app/config 目录的配置文件中通过 env 读取,其他地方要用到环境变量的都统一读配置文件而不是使用 env 函数读取。

这个问题以前遇到过后来改了写法,在 github 上一个扩展包中发现一个 bug,发现也是这个问题导致的,跟作者反馈也确认这一点。

 

转载于:

原文地址:

查看env 的代码

原因何在?

// Illuminate/Foundation/helpers.php
function env($key, $default = null)
{
    $value = getenv($key);

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

    // 此处省略部分代码

    return $value;
}

在 Laravel 中,如果执行 php aritisan config:cache命令,Laravel 将会把 app/config 目录下的所有配置文件“编译”整合成一个缓存配置文件到 bootstrap/cache/config.php,每个配置文件都可以通过 env函数读取环境变量,这里是可以读取的。但是一旦有了这个缓存配置文件,在其他地方使用 env函数是读取不到环境变量的,所以返回 null.

可以发现,实际上调用的就是php自带的getenv函数,如果取不到值,那必定是某段执行putenv或者操作$_ENV全局变量的代码没有执行,而且这些环境变量设置操作一定是在初始化的时候进行的

让我们看看这段代码,Illuminate/Foundation/Bootstrap/DetectEnvironment.php line 18

如果对Laravel的Kernel执行顺序比较了解的话,应该知道,在Kernel启动阶段会首先执行一组bootstrappers

public function bootstrap{ if (! $app->configurationIsCached { $this->checkForSpecificEnvironmentFile; try { (new Dotenv($app->environmentPath(), $app->environmentFile; } catch (InvalidPathException $e) { // } }}
//Illuminate/Foundation/Http/Kernel.php
class Kernel implements KernelContract
{
    /**
     * The bootstrap classes for the application.
     *
     * @var array
     */
    protected $bootstrappers = [
        'IlluminateFoundationBootstrapDetectEnvironment',
        'IlluminateFoundationBootstrapLoadConfiguration',
        'IlluminateFoundationBootstrapConfigureLogging',
        'IlluminateFoundationBootstrapHandleExceptions',
        'IlluminateFoundationBootstrapRegisterFacades',
        'IlluminateFoundationBootstrapRegisterProviders',
        'IlluminateFoundationBootstrapBootProviders',
    ];

这个方法在框架启动后就会运行,这段代码说明了如果存在缓存配置文件,就不会去设置环境变量了,配置都读缓存配置文件,而不会再读环境变量了。

其中一个bootstrapper名为DetectEnvironment,而它的嫌疑是最大的,检查这个类

因此,在配置文件即 app/config 目录下的其他地方,读取配置不要使用 env函数去读环境变量,这样你一旦执行php artisan config:cache之后,env函数就不起作用了。所有要用到的环境变量,在 app/config 目录的配置文件中通过 env 读取,其他地方要用到环境变量的都统一读配置文件而不是使用 env函数读取。

//Illuminate/Foundation/Bootstrap/DetectEnvironment.php
class DetectEnvironment
{
    /**
     * Bootstrap the given application.
     *
     * @param  IlluminateContractsFoundationApplication  $app
     * @return void
     */
    public function bootstrap(Application $app)
    {
        if (! $app->configurationIsCached()) {
            $this->checkForSpecificEnvironmentFile($app);

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

    // ……
}

总结

在代码中,我们并没有发现任何执行putenv或者操作$_ENV全局变量的地方,实际上在整个Laravel的框架代码里也没有发现蛛丝马迹,那么这些环境变量是如何保存进来的呢?

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流。

如果Laravel框架里没有执行这些代码,我们应该可以推测是框架使用的第三方组件做了这些事情

版权声明:本文由bob体育app发布于bob体育平台,转载请注明出处:bob体育appLaravel中env函数的小坑