Laravel中env函数的小坑

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

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

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

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

查看env 的代码

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

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

    // 此处省略部分代码

    return $value;
}

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

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

//Illuminate/Foundation/Http/Kernel.php
class Kernel implements KernelContract
{
    /**
     * The bootstrap classes for the application.
     *
     * @var array
     */
    protected $bootstrappers = [
        'Illuminate\Foundation\Bootstrap\DetectEnvironment',
        'Illuminate\Foundation\Bootstrap\LoadConfiguration',
        'Illuminate\Foundation\Bootstrap\ConfigureLogging',
        'Illuminate\Foundation\Bootstrap\HandleExceptions',
        'Illuminate\Foundation\Bootstrap\RegisterFacades',
        'Illuminate\Foundation\Bootstrap\RegisterProviders',
        'Illuminate\Foundation\Bootstrap\BootProviders',
    ];

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

//Illuminate/Foundation/Bootstrap/DetectEnvironment.php
class DetectEnvironment
{
    /**
     * Bootstrap the given application.
     *
     * @param  \Illuminate\Contracts\Foundation\Application  $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框架里没有执行这些代码,我们应该可以推测是框架使用的第三方组件做了这些事情

而事实也确实如此,可以看到在DetectEnvironment类的bootstrap方法里实例化了一个Dotenv类的对象,而Dotenv\Loader正是执行了读取.env文件,执行putenv的操作。

vlucas/phpdotenv Laravel那一套.env文件的玩法就是使用的这个组件,有兴趣的同学可以研究一下

好了,暂时总结一下分析的结果

  • 环境变量的读取函数env是在helpers.php里定义的,执行的是php的getenv
  • 环境变量的存储经过确认是第三方的 vlucas/phpdotenv 来完成的

那么env获取不到值只能说明Dotenv的实例化并没有执行

再仔细看一下DetectEnvironment类,在实例化Dotenv前,先进行了一个 if 判断

if (! $app->configurationIsCached())

而这个方法的作用就是判断 bootstrap/cache/config.php 缓存文件是否存在,如果文件存在则不会执行Dotenv的实例化操作,也就不会往$_ENV里存数据,自然env函数是取不到值的

bootstrap/cache/config.php是执行下面的命令生成的

php artisan config:cache

命令说明如下

Create a cache file for faster configuration loading

这是对config目录下的所有配置文件做的缓存

那么,真相大白了,之前在开发时并没有出现问题,是因为没有执行 config:cache 命令,而项目上线后为了优化访问速度,生成了缓存文件,导致env取值失败

可以疑问还是存在,既然Laravel提供了env函数,为什么还有这个坑呢?是bug吗?如果env不能使用,那该使用什么方式呢?

本着一探究竟的态度,仔细阅读了文档,在 Upgrade Guide 里找到了答案

Caching And Env

If you are using the config:cache command during deployment, you must make sure that you are only calling the env function from within your configuration files, and not from anywhere else in your application.

如果使用了config:cache,env函数只能在config目录下的配置文件的php里使用,不可以在其他地方使用。

一个非常简单的办法就是将

env('APP_ENV')

改为

config('app.env')

config函数会优先读取 bootstrap/cache/config.php 中缓存的配置,如果没有缓存文件,则会直接读取 config 目录下的所有配置文件

想研究这块代码实现的可以看下另一个bootstrapper: LoadConfiguration,它是用来初始化 config service 的,而 config 函数使用的就是这个 service

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • 原文链接 必备品 文档:Documentation API:API Reference 视频:Laracasts ...
    layjoy阅读 8,602评论 0 121
  • 先说几句废话,调和气氛。事情的起由来自客户需求频繁变更,伟大的师傅决定横刀立马的改革使用新的框架(created ...
    wsdadan阅读 3,036评论 0 12
  • 这是一份事后的总结。在经历了调优过程踩的很多坑之后,我们最终完善并实施了初步的性能测试方案,通过真实的测试数据归纳...
    胖福哥阅读 6,989评论 1 48
  • 关键词:linux python脚本 定时执行 通过crontab调度脚本时脚本使用的环境变量与直接在shell中...
    tianmh阅读 331评论 0 0