Laravel 프레임워크에서 ENV 로드 및 읽기 소개

이 글은 Laravel 프레임워크에서 ENV를 로드하고 읽는 방법을 소개합니다. 도움이 필요한 친구들이 참고할 수 있기를 바랍니다.

Laravel은 시작 시 프로젝트에 .env 파일을 로드합니다. 애플리케이션이 실행되는 다양한 환경에 대해 서로 다른 구성을 갖는 것이 유용한 경우가 많습니다. 예를 들어, 테스트용 MySQL 데이터베이스를 로컬에서 사용하고 온라인 상태가 된 후 프로젝트가 자동으로 프로덕션 MySQL 데이터베이스로 전환되기를 원할 수 있습니다. 이번 글에서는 env 파일의 활용과 소스코드 분석에 대해 자세히 소개하겠습니다.

Env 파일 사용

다중 환경 환경 설정

프로젝트의 env 파일 수는 프로젝트 환경의 수와 동일한 경우가 많습니다. 프로젝트에 개발, 테스트 및 프로덕션 환경 세트가 3개 있는 경우 프로젝트에는 세 개가 있어야 합니다. 세 개의 환경 구성 파일인 .env.dev, .env.test 및 .env.prod는 해당 환경에 해당합니다. 세 파일의 구성 항목은 정확히 동일해야 하며, 구체적인 구성 값은 각 환경의 필요에 따라 설정되어야 합니다.

다음 단계는 프로젝트가 환경에 따라 다양한 env 파일을 로드할 수 있도록 하는 것입니다. 사용 습관에 따라 선택할 수 있는 세 가지 구체적인 방법이 있습니다.

환경의 nginx 구성 파일에 APP_ENV 환경 변수 fastcgi_param APP_ENV dev를 설정합니다.

서버에서 PHP를 실행하는 사용자의 환경 변수를 설정합니다. www 사용자의 /home으로 /www/.bashrc

배포 프로젝트의 지속적인 통합 작업 또는 배포 스크립트에서 cp .env.dev .env를 실행합니다.

처음 두 가지 방법의 경우 Laravel은 로드됩니다. env('APP_ENV') 변수 값에 따라 해당 파일 .env.dev, .env.test 등을 로드합니다. 구체적으로, 나중에 소스 코드에서 설명하겠지만, 세 번째로 이해하기 쉬운 방법은 프로젝트 배포 시 환경 구성 파일을 .env 파일에 덮어써서 환경 구성 파일에 추가 설정을 할 필요가 없도록 하는 것입니다. 시스템과 nginx.

env 파일의 경로와 파일 이름을 사용자 정의하세요

env 파일은 기본적으로 프로젝트의 루트 디렉터리에 위치합니다. Laravel은 사용자에게 ENV 파일의 경로나 파일 이름을 사용자 정의하는 기능을 제공합니다. 예를 들어, env 경로를 정의하려면 bootstrap 폴더에 있는 app.php에 있는 Application 인스턴스의 useEnvironmentPath 메소드를 사용하면 됩니다:

$app = new Illuminate\Foundation\Application(
    realpath(__DIR__.'/../')
);

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

env 파일 이름을 사용자 정의하려면 다음을 사용할 수 있습니다. bootstrap 폴더에 있는 app.php에 있는 Application 인스턴스의 loadEnvironmentFrom 메소드. :

$app = new Illuminate\Foundation\Application(
    realpath(__DIR__.'/../')
);

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

Laravel 로딩 ENV 구성

Laravel 로딩 ENV는 프레임워크가 요청을 처리하기 전에 부트스트랩 프로세스의 LoadEnvironmentVariables 단계에서 완료됩니다.

Laravel이 env에서 구성을 로드하는 방법을 분석하기 위해 IlluminateFoundationBootstrapLoadEnvironmentVariables의 소스 코드를 살펴보겠습니다.

<?php
namespace Illuminate\Foundation\Bootstrap;
use Dotenv\Dotenv;
use Dotenv\Exception\InvalidPathException;
use Symfony\Component\Console\Input\ArgvInput;
use Illuminate\Contracts\Foundation\Application;
class LoadEnvironmentVariables
{
    /**
     * Bootstrap the given application.
     *
     * @param  \Illuminate\Contracts\Foundation\Application  $app
     * @return void
     */
    public function bootstrap(Application $app)
    {
        if ($app->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  \Illuminate\Contracts\Foundation\Application  $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  \Illuminate\Contracts\Foundation\Application  $app
     * @param  string  $file
     * @return bool
     */
    protected function setEnvironmentFilePath($app, $file)
    {
        if (file_exists($app->environmentPath().'/'.$file)) {
            $app->loadEnvironmentFrom($file);

            return true;
        }

        return false;
    }
}

시작 방법 부트스트랩에서 Laravel은 구성이 캐시되었는지 확인하고 위에서 언급한 환경을 기반으로 구성 파일을 로드하는 세 가지 방법 중 처음 두 가지에 대해 시스템 또는 nginx 환경 APP_ENV가 변수에 설정되어 있으므로 Laravel은 .env.dev 또는 .env.test와 같은 checkForSpecificEnvironmentFile 메소드의 APP_ENV 값에 따라 구성 파일의 올바른 특정 경로를 설정합니다. 기본 .env가 사용됩니다. 자세한 내용은 아래 checkForSpecificEnvironmentFile의 소스 코드와 관련 애플리케이션의 두 가지 방법을 참조하세요.

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 Illuminate\Foundation;
class Application ....
{

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

읽을 구성 파일의 경로를 결정한 후 다음 단계는 구성을 로드하는 것입니다. 환경에서.

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

Laravel은 PHP 버전의 Dotenv 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를 사용하여 데이터를 로드합니다.

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 함수는 file 함수를 사용하여 다음과 같이 구성 행을 읽습니다. 파일의 줄을 배열로 가져온 다음 #으로 시작하는 주석을 제외하고 콘텐츠에 =가 포함된 줄에 대해 setEnvironmentVariable 메서드를 호출하여 파일 줄의 환경 변수를 프로젝트에 구성합니다.

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
        }
    }
}

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

<span style="font-family: 微软雅黑, Microsoft YaHei;">Dotenv实例化Loader的时候把Loader对象的$immutable属性设置成了false，Loader设置变量的时候如果通过getEnvironmentVariable方法读取到了变量值，那么就会跳过该环境变量的设置。所以Dotenv默认情况下不会覆盖已经存在的环境变量，这个很关键，比如说在docker的容器编排文件里，我们会给PHP应用容器设置关于Mysql容器的两个环境变量</span><br>컨테이너에서 이렇게 환경변수를 설정한 후, env 파일의 DB_HOST가 homestead이고 env 함수를 이용해 읽어와도 이전에 컨테이너 데이터베이스에 설정한 DB_HOST 환경변수의 값(컨테이너 링크) docker에서는 기본적으로 서비스 이름을 사용합니다. 오케스트레이션 파일에는 mysql 컨테이너의 서비스 이름이 데이터베이스로 설정되어 있으므로 php 컨테이너는 데이터베이스 호스트를 통해 mysql 컨테이너에 연결해야 합니다. 왜냐하면 지속적 통합에서 자동화된 테스트를 할 때 일반적으로 컨테이너에서 테스트하기 때문에 Dotenv가 기존 환경 변수를 덮어쓰지 않는 것이 매우 중요하기 때문입니다. 이렇게 하면 컨테이너에 환경 변수의 값만 설정하여 테스트를 완료할 수 있습니다. . 프로젝트에서 env 파일을 변경할 필요가 없으며, 테스트가 완료된 후 바로 프로젝트를 환경에 배포하면 됩니다.

환경 변수가 존재하지 않는 것을 확인하면 Dotenv는 PHP 내장 함수 putenv를 통해 환경 변수를 환경으로 설정하고 이를 두 개의 전역 변수 $_ENV 및 $_SERVER에 저장합니다.

프로젝트의 env 구성 읽기

Laravel 애플리케이션에서는 env() 함수를 사용하여 데이터베이스의 HOST 가져오기와 같은 환경 변수 값을 읽을 수 있습니다.

env('DB_HOST`, 'localhost');

두 번째 값 env 함수에 전달되는 것이 "기본값"입니다. 해당 키에 대한 환경 변수가 없으면 이 값이 사용됩니다.

env 함수의 소스 코드를 살펴보겠습니다.

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 내장 함수 getenv를 통해 직접 환경 변수를 읽습니다.

구성을 로드하고 구성을 읽을 때 putenv와 getenv 두 가지 함수가 사용되는 것을 확인했습니다. putenv가 설정한 환경 변수는 요청 중에만 유지되며, 요청이 종료된 후에는 이전 환경 설정이 복원됩니다. 왜냐하면 php.ini의 Variables_order 구성 항목이 GPCS가 되고 E가 포함되어 있지 않으면 PHP 프로그램에서 $_ENV를 통해 환경 변수를 읽을 수 없기 때문에 개발자가 직접 환경 변수를 설정할 필요가 없도록 putenv를 사용하여 환경 변수를 동적으로 설정합니다. 서버 구성에 주의하세요. 또한 서버에서 실행 중인 사용자를 위해 구성된 환경 변수는 사용자가 시작한 모든 프로세스와 공유되므로 DB_PASSWORD 및 API_KEY와 같은 개인 환경 변수를 잘 보호할 수 없으므로 이 구성은 putenv 설정으로 더 잘 보호될 수 있습니다. 이러한 구성 정보를 통해 getenv 메소드는 시스템의 환경 변수와 putenv에 의해 동적으로 설정된 환경 변수를 얻을 수 있습니다.

위 내용은 Laravel 프레임워크에서 ENV 로드 및 읽기 소개의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!