ローカル開発環境とリモート開発環境の差異について

Question

みなさんはローカル開発環境とリモート開発環境の差異をどのように埋めて対処されていますか？

たとえばローカルの環境で Ajax の投げ先を localhostにしているが、サーバー本番環境ではドメイン名に変えなくてはいけないなど。

ローカルからGitのリモートリポジトリにプッシュする前に、いちいち本番用の設定やファイルに書き換えてからコミット＆プッシュしていると大変ですよね。

URIだけでなくアプリケーションサーバーの設定だとか何かとローカルとリモートの環境差異に苦しめられています。

こういった差異をどう埋めれば工数を少なく出来るか、どういった解決策があるかみなさんのお知恵を拝借したくぜひともお願いいたします。

言語やフレームワークに絞った話ではありませんが、参考までに Java, SpringBoot, Apache, Tomcat（非組込）がリモートの本番環境です。

よろしくお願いいたします。

Answer 1

環境ごとに値が変わる設定項目は、環境変数やプロパティーで切り替えられるようにしておきます。

...

一例として、以下の方法があります。

設定項目を、環境ごとのプロパティーグループにしておきます。
例えば、プロパティーグループ名を、

• ローカル開発環境: development
• リモート開発環境: integration
• 準本番環境: staging
• 本番環境: production

のようにします。
環境の呼び方は様々ありますので、実際にプロジェクトに存在する呼び方に合わせてください。

そして、設定ファイルからホスト名を取得するのに、ローカル開発環境ではdevelopment.hostnameを参照し、リモート開発環境はintegration.hostnameを参照します。
ファイルごと切り替える方法もあります。例えば、設定ファイルをapp-development.properties,app-production.propertiesのように分けます。

サービスを起動する際に、例えばローカル開発環境で実行する場合は、環境変数またはシステムプロパティーにenv=developmentをつけるとdevelopmentグループの設定を使って動作するようにします。
単体テスト用のtestingを設ける場合もあります。

フレームワークでこのような切り替えを支援している機能を持つものもあります。

参考リンク：

FuelPHPの複数環境切り替えとはまった所 - Qiita
http://qiita.com/cs_sonar/items/966203da32c933d65e39

Spring Boot - 設定を環境で切替える - JavaとWeb開発
http://web-develop.hatenablog.jp/entry/2015/06/22/185451

ソフトウェア開発の4つの層 - Miuran Business Systems
http://www.m-bsys.com/devtest/4tiers

Comments

[teramasa]

argiusさま

詳しい回答をいただきありがとうございます！
開発ステージごとに設定を準備しておいて、それを切り替えて実行するという方法なのですね。勉強になりました。

また、ちょうどSpringBootのapplication.propertiesで設定をしていましたので、特に二つにご紹介いただいた記事の内容は有難いものでした。

環境ごとの切り替えという点をもっと勉強して今後に活かしていきたいと思います。
ありがとうございました。

[argius]

たまたま選んだSpring Bootの記事が参考になったみたいで良かったです。
JavaなのでSpringの可能性はあるとは思いましたが...

他の言語のフレームワークでも、例えばRailsなども同様の考えだったと思います。
覚えておくと便利だと思いますのでがんばってください。

Answer 2

設定ファイルを環境毎に

• config.devel.php
• config.stage.php
• config.prod.php

のように分けて .htaccess で切り替えるように制御しています。
.htaccess では

SetEnv ENVIRONMENT devel

のように定義しておき、PHP側では

$env = getenv('ENVIRONMENT');
$file = 'config.' . ($env == null ? 'devel' : $env) . '.php';
$file を読み込む処理

みたいな感じで読み込む設定ファイルを切り分けています。

全環境で共通の設定については config.common.php みたいなものを作っておき、その設定ファイルを読み込んだ後で環境毎の設定ファイルを読み込み array_merge しています。

Comments

[hyper-drums-ko]

遅かったか。。。

[teramasa]

hyper-drums-koさま

回答いただきありがとうございます！なるほど、設定コードを各ステージで分けて.htaccessで切り替えるという方法なんですね。今後の参考にさせていただきます。
時間差でベストアンサーをお付けできないことをお詫びいたします。