導入

SpringBootでProfileを使用するようになると、何かのprofileを指定しないと起動しなくなるような構成になりがちだと思います。たとえば application-local.yml 、 application-dev.yml 、 application-prod.yml など環境ごとのプロファイルを用意する場合です。

開発効率を考えればProfile無しでも動作するようにしておくのが良いこともあるのですが、それだと設定誤りなどで本番環境で動作してしまうリスクが残ります。たとえば無印（not default）ではH2で動作するようにしておいて、prod で実際のデータベースに接続するように上書きしていた場合。設定漏れや誤りで上書きできなくても、一見正常に動作し、実はH2だった……などが考えられます。この問題を検知できる別の仕組みがあれば無印を使用するのも良いかもしれませんが、必ず何かしらのProfileを使用すると言う落とし所が現実かなと思っています。

Profile設定方法

SpringBootでProfileを指定する方法はいくつかありますが、基本的にプロパティと同じ方法が取れます。つまり、次のいずれかを使用すると思います。

SPRING_PROFILES_ACTIVE OS環境変数
-Dspring.profiles.active Java システムプロパティ
--spring.profiles.active コマンドライン引数
@ActiveProfiles アノテーション（テスト限定）

ほかにもありますが、よく使うのはこの辺りかなと思います。

詳しくは公式リファレンスを参照してください。使ったことがある物もありますが、使ったことのない物もたくさんあります。

開発時のProfile指定

開発時のProfile設定方法も上記のいずれかを使用することになりますが、案外厄介です。と言うのも、MavenやGradle自体のJava システムプロパティやコマンドライン引数に渡しても、ビルドツールに設定されます。

ビルドツール自体のプロセスとSpringBootのプロセスが異なるため、Java システムプロパティやコマンドライン引数はそのまま渡りません。渡すためにそれぞれ固有の知識が必要になってきます。たとえば -P で受けたのをテストのプロセスに引き渡すような。知っていれば迷わないですが、知らなければそのための調べたり試行錯誤したりすることになります。

結局私がどうしているか

環境変数一択になっています。コンテナ運用だと環境変数になりますし、本番の設定方法と同じにしたいって理由もありますが、実行方法にとわず設定方法が揺れないのが理由です。

Gradleだと。

SPRING_PROFILES_ACTIVE=hoge gradle bootRun

Mavenだと。

SPRING_PROFILES_ACTIVE=hoge mvn spring-boot:run

これらはシェルですが、WindowsのPowerShellでも $env:SPRING_PROFILES_ACTIVE=hoge でできました。

IDEからの実行でも環境変数に追加でいけます。以下はIDEAの例。Profile複数使い分ける場合とか、それぞれで保存しとくと楽。

f:id:irof:20210215110907p:plain

ここまでは SPRING_PROFILES_ACTIVE と書いてきましたが、画像のように spring.profiles.active でもいけます。もちろんVM OptionやProgram argumentに追加しても構いませんが、環境変数に統一と言う方針なのでこちらを使用。 AWS SDKを使用する場合はここに AWS_PROFILE を並べたりします。

これ別にProfile専用ではなく、全部のプロパティがこれでいけるんですよね。Profile用の専用の仕組みだとこれは使えない。 SPRING_APPLICATION_JSON 環境変数使えば一括での設定もできるのもたまに便利。たまに。

固定のProfileを設定するのであれば、それぞれのツールに設定してもいいと思います。ローカルで動作させるならどうせ local を指定するでしょうし。そう言うのなら「毎回必ず指定する」のは無駄なので、build.gradleだのpom.xmlだのに固定で書いておく方がいいと思う。