CakePHP4の定数定義ファイルを環境変数によって本番と開発を振り分ける方法解説

2022/07/11 2023/12/28

Apacheに環境変数を設定し定数定義ファイルを本番と開発を振り分ける処理

定数定義ファイルを本番環境用と開発環境用とで分ける

　
「CentOS6、7のPHPを5.3から5.6、7.0、7.1にバージョンアップする手順の解説」
上記の記事で、定数を管理する方法の解説をしました。
　
　
定数なので固定の値なのですが、下記のようなサイトの URLやメールアドレスなどを設定する定数は「開発環境」と「本番環境」とでは違うものを設定したい場合もあるかと思います。
　

// 開発環境
define("SITE_URL","http://localhost");
define("E-MAIL",  "jibun@localhost");

// 本番環境
define("SITE_URL","http://example.com");
define("E-MAIL",  "staff@example.com");

// 開発環境

define("SITE_URL","http://localhost");

define("E-MAIL", "jibun@localhost");

// 本番環境

define("SITE_URL","http://example.com");

define("E-MAIL", "staff@example.com");

　
　
この記事では、これらの定数のファイルを開発環境と本番環境とで自動的に切り替える方法を解説します。
　
ちなみに「CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説」では解説をしていますが、CakePHP3 と CakePHP4とでは定数の設定の仕方が少し変更になっていますので、CakePHP3ユーザの方は改めて確認をしてみてください。
　
　
また、「app_local.php」「.env」に定数を定義する方法については「CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法」を参考にしてください。
　
　

環境変数を Apacheの設定ファイル「httpd.conf」or「.htaccess」に設定

　
まず初めに「環境変数」を設定します。
　
「環境変数」は、基本的には「開発環境」にのみ指定します。（「開発環境」に設定する理由は後程説明します。）
　
　
対象ファイルは下記の「httpd.conf」（or「.htaccess」）です。
　
Apacheの設定ファイル「/etc/httpd/conf/httpd.conf」
（「httpd.conf」のパスは CentOSを想定しています。）
　
もしくは、
ドキュメントルートにある「.htaccess」です。
　
※どちらでも問題ありませんが、「httpd.conf」に設定すればそのサーバを利用する開発共通して反映させることができます。
　「.htaccess」は、プロジェクトごとに設定する必要が発生します。
　
　
「httpd.conf」or「.htaccess」ファイルを開いて、ファイルの一番最後などに書きの記述を追加します。記述する内容はどちらも同じです。
　

SetEnv CAKE_ENV "develop"

1	SetEnv CAKE_ENV "develop"

　
「CAKE_ENV」が環境変数の変数名で、「develop」がその値になります。
複数設定することもできます。
また、上記の例では「ダブルクォート（"）」で囲っていますが、囲わなくても動作します。（囲っておく方が無用なトラブルに遭遇する可能性は減るかと思います。）
　
「httpd.conf」に記述した場合は、Apacheを再起動して環境変数を反映させます。
「.htaccess」に記述した場合は記述するだけで反映されます。
　
　

設定した「環境変数」を取得する方法

　
設定した「環境変数」が正しく設定されたかを確認するため、設定した環境変数を取得してみましょう。
環境変数を取得する方法は下記のように複数存在します。
　

print_r( $_SERVER["CAKE_ENV"] );
print_r( getenv("CAKE_ENV")   );
print_r( env("CAKE_ENV")      );
print_r( $_ENV["CAKE_ENV"]    );

print_r( $_SERVER["CAKE_ENV"] );

print_r( getenv("CAKE_ENV") );

print_r( env("CAKE_ENV") );

print_r( $_ENV["CAKE_ENV"] );

　
ただ、「$_ENV["CAKE_ENV"]」は私の環境ではうまく取得できませんでした。
　
　
また、「phpinfo();」を実行すると、リストの中に環境変数の情報も表示されます。
　
　

定数ファイルを作成

　
続いて、定数ファイルを作成します。
「CakePHP4で定数の設定と呼び出し方法の解説（defineとConfigure）」の記事では「/config/const.php」というファイルを作成し、定数を設定しましたが、加えて下記のように「開発用」「本番用」の定数ファイルを作成します。
ファイル名のつけ方の決まりはありませんので、自由に設定してください。
　
開発環境用
/config/const_develop.php
　
本番環境用
/config/const_production.php
　
　
開発環境用の「const_develop.php」には下記を設定します。
　

<?php
// サイトの URL
define("SITE_URL", "http://localhost"),

// サイト名称
define("SITE_NAME", "サンプルサイト・開発"),

<?php

// サイトの URL

define("SITE_URL", "http://localhost"),

// サイト名称

define("SITE_NAME", "サンプルサイト・開発"),

　
　
本番環境用の「const_production.php」には下記を設定します。
　

<?php
// サイトの URL
define("SITE_URL", "http://example.com"),

// サイト名称
define("SITE_NAME", "サンプルサイト・本番"),

<?php

// サイトの URL

define("SITE_URL", "http://example.com"),

// サイト名称

define("SITE_NAME", "サンプルサイト・本番"),

「bootstrap.php」に定数ファイルを取得する分岐処理を記述

try {
    Configure::config('default', new PhpConfig());
    Configure::load('app', 'default', false);

    // 定数ファイルを読み込み
    Configure::load('const');

    // 定数ファイルを読み込み
    if (isset($_SERVER["CAKE_ENV"]) && $_SERVER["CAKE_ENV"] == "develop"){
        Configure::load("const_develop");
    } else {
        Configure::load("const_production");
    }

} catch (\Exception $e) {
    exit($e->getMessage() . "\n");
}

try {

Configure::config('default', new PhpConfig());

Configure::load('app', 'default', false);

// 定数ファイルを読み込み

Configure::load('const');

// 定数ファイルを読み込み

if (isset($_SERVER["CAKE_ENV"]) && $_SERVER["CAKE_ENV"] == "develop"){

Configure::load("const_develop");

} else {

Configure::load("const_production");

}

} catch (\Exception $e) {

exit($e->getMessage() . "\n");

}

　
上記の 9行目で環境変数によって「本番用」「開発用」の振り分けを行っています。
　
　

「環境変数」を「開発環境」に設定する理由

　
私は、
環境変数「CAKE_ENV」が「develop」であれば「開発環境」。
そうでなければ、「本番環境」。
という処理をしています。
　
理由は「httpd.conf」ファイルを変更する手続き（業務上の手続きなども含めて）は、本番環境より開発環境の方が楽だと思うためです。
　
　

Shellを実行する場合はコマンド内に環境変数を指定する

　
CakePHP3の Shellでバッチ処理を作成して、コマンドラインから Shellを起動して実行する場合は、下記のようにコマンド内に環境変数を指定します。
　

// コマンドラインからシェルを実行する場合
$ bin/cake SampleTests getList

// コマンドの前に環境変数を指定する場合
$ CAKE_ENV=develop bin/cake SampleTests getList

// コマンドラインからシェルを実行する場合

$ bin/cake SampleTests getList

// コマンドの前に環境変数を指定する場合

$ CAKE_ENV=develop bin/cake SampleTests getList

　
Shellをコマンドから実行する場合は、Apacheを経由せずにプログラムが実行されるため、Apacheの設定ファイル「/etc/httpd/conf/httpd.conf」に記述してある環境変数は読み込まれません。
　
そのため、実行するコマンドの中に環境変数を直接記述しておく必要があるのです。
　
　

CakePHP4で環境ごとに異なる定数を管理するオススメの方法

　
CakePHP4で環境ごとに異なる定数を管理する方法の中では、この記事で紹介した「環境変数」で定数のファイルを切り替える方法をオススメします。
　
　
この記事で紹介した方法は、環境変数を設定し、その値によって読み込む定数定義ファイルを振り分ける、というものでした。
　
その他では、CakePHP4には、環境ごとに異なる定数を「/config/app_local.php」や「.env」にて環境ごとに異なる定数を定義する方法が用意されています。
ですが、「CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法」の記事内でも触れていますが、「app_local.php」や「.env」は、定数を定義するファイルではあるものの、プログラマーがオリジナルで定義する定数を設定するファイルとしては不適切であろうと考えています。
　
「app_local.php」や「.env」は、データベース接続情報やメールサーバへの接続情報などの機密情報を含むため、Gitなどのソースコードのバージョン管理ツールなどでは管理しないファイルとなります。
そのため、「app_local.php」や「.env」にオリジナルの定数を定義する場合、その定数を変更したり、追加したりする場合の管理はアナログ的なものとなります。
　
それによって、リリース時に
『本番環境の「app_local.php」を更新し忘れていた！』
『本番環境に開発用の「app_local.php」をリリースしちゃった！』
と言うようなミスが発生する可能性があるのです。
　
　
対して、この記事で紹介した「環境変数」を使って使用する定数ファイルを切り替える方法であれば、定数のファイルをすべて Gitで管理することができます。
そのため、本番リリース時もソースファイルをまとめてリリースするだけでよく、「app_local.php」「.env」を使うときのようなミスが発生する可能性はなくなるのです。
　
そのため、このリスクを避けることにメリットを見出せるならば、この記事の方法を検討する価値があるのかと考えています。
　
　
「app_local.php」や「.env」で管理する定数と、この記事で紹介した環境変数で振り分ける定数では、定数の持つ意味が異なるために異なる方法を使って管理する方がいいのではないか、と考えています。
　
　
CakePHP4　オフィシャルサイト　構成設定
https://book.cakephp.org/4/ja/development/configuration.html
　
　

- CakePHP 3.x 4.x CakePHP4

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3でQRコードを作成、表示するライブラリ「cakePHP-QR-Code-Helper」

CakePHPでQRコードを生成するライブラリ「cakePHP-QR-Code-Helper」の紹介。GDライブラリのインストールも必要ないHelperとして提供されているため、ファイルを設置すればすぐに使用可能。

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

: CakePHP3のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP3の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHP 2.3でOn Duplicate Key構文を実装

CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。

: CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説

CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。

: CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法

コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ！

: CakePHP 2.3で確認画面付きのお問い合わせフォームの作り方

CakePHPで確認画面付きのお問い合わせフォーム、メールフォームの作り方をサンプルを提示しながら解説。

: CakePHP3のInsert On Duplicate Key Update（upsert）構文を解説・バルク処理も

CakePHP3で Insert … On Duplicate Key Update構文（upsert）を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。