PHPでdotenvローダを作成する

12266 ワード
symfony php backend phpunit テキストリンク
PHP Frameworkプロジェクトで多用されている最も一般的なライブラリのリストからdotenvがあります.読み込むパッケージ.ENV変数からプログラムに.envファイル.これらのENV値は、通常、各環境についてパッチを貼られた秘密であり、プロセスに微妙なセキュリティ問題があります.
とにかく、今日のこのブログでは、私たちはゼロからdotenvクラスを構築するつもりです.

始める


サンプルを作りましょう.Envファイルを読み込み、すべてのコーナーズケースで変数を含める.
env . env
# A PostgreSQL connection string
DATABASE_URL=postgres://localhost:5432/noah_arc

# The lowest level of logs to output
LOG_LEVEL=debug

# The environment to run the application in
NODE_ENV=development

# The HTTP port to run the application on
PORT=8080

# The secret to encrypt session IDs with
SESSION_SECRET=development

API_KEY="hwhhwhshs6585gahwhgwuwjwusuhs"

APP_KEY=VGhpcyBpcyBhbiBlbmNvZGVkIHN0cmluZw==
APP_DESCRIPTION="This is a long sentence with whitespace and characters "

最終コード


ドtenフ.PHP
<?php
namespace PHPizer\DotEnv;

use Exception;

class DotEnv
{
    protected $path;
    public $variables;

    public function __construct(string $path)
    {
        if (!file_exists($path)) {
            throw new Exception("File not found: {$path}");
        }
        $this->path = $path;
    }

    public function load(): void
    {
        if (!is_readable($this->path)) {
            throw new Exception("File not readable: {$this->path}");
        }

        $lines = file($this->path, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
        foreach ($lines as $line) {
            if (strpos(trim($line), '#') === 0) {
                continue;
            }

            list($name, $value) = explode('=', $line, 2);
            $name = trim($name);
            $value = trim($value,"\x00..\x1F\"");
            $this->variables[$name] = $value;

            if (!array_key_exists($name, $_SERVER) && !array_key_exists($name, $_ENV)) {
                putenv(sprintf('%s=%s', $name, $value));
                $_ENV[$name] = $value;
                $_SERVER[$name] = $value;
            }
        }
    }
}
Dotenvクラスはパスを持つオブジェクトを作成し、ファイルが存在しない場合は例外をスローします.オブジェクトはload () fnで呼ばれる必要があります.これはファイルが読み込み可能であるかどうかをチェックし、空白のスペースやコメントでない場合はそれぞれキー値ペアにトークン化し、env変数として設定します.

テスト


<?php

declare(strict_types=1);

namespace Tests;

use PHPizer\DotEnv\DotEnv;
use PHPUnit\Framework\TestCase;

final class DotEnvTest extends TestCase
{
    protected $path;
    protected DotEnv $dotEnv;


    public function testLoadEnv(): void
    {
        $this->path = "./tests/test.env";
        $this->dotEnv = new DotEnv($this->path);
        $this->assertNull($this->dotEnv->variables);
        $this->dotEnv->load();
        $envArray = [
            "DATABASE_URL" => "postgres://localhost:5432/noah_arc",
            "LOG_LEVEL" => "debug",
            "NODE_ENV" => "development",
            "PORT" => 8080,
            "SESSION_SECRET" => "development",
            "API_KEY" => "hwhhwhshs6585gahwhgwuwjwusuhs",
            "APP_KEY" => "VGhpcyBpcyBhbiBlbmNvZGVkIHN0cmluZw==",
            "APP_DESCRIPTION" => "This is a long sentence with whitespace and characters "
        ];
        foreach ($this->dotEnv->variables as $key => $value) {
            $this->assertEquals($value, $_ENV[$key]);
            $this->assertEquals($value, $_SERVER[$key]);
            $this->assertEquals($value, $envArray[$key]);
        }
        $this->assertTrue(true);
    }
}
すべての変数が適切にenvファイルから解析されるなら、dotenvtestは値をテストします.

参考文献

  • symfony/dotenv
    • VimプラグインVundle
    WebViewネットワークビュー