前書き
Intellij IDEA
では、Run/Debug Configuration
毎に環境変数を設定することができます。
また、Edit configuration templates
から設定を行うことで、プロジェクト内で追加される新しいRun/Debug Configuration
全てに環境変数を適用することもできます。
これによって、一々システムの環境変数を書き換えて壊してしまうような危険性を減らしつつ、管理を容易にすることができます。
以下、設定方法についてまとめます。
話の本筋には関わりませんが、サンプルプロジェクトにはSpring Initializrで作成したgradle
プロジェクトを利用しています。
基本的な編集方法
まず、Edit Configurations...
を開きます。
左側の一覧から編集対象にしたい内容を選ぶと、中程にEnvironment variables
という項目が有ります。
値を編集すると以下のようになります。
キーと値は=
で、設定は;
で区切ります。
サンプルではFOO_KEY=foo;BAR_ID=bar
という値を設定しています。
また、入力欄右側のアイコンからも編集が可能です。
Environment variablesが表示されていない場合の対処
設定によってはEnvironment variables
が表示されていない場合も有ります。
例えば、Spring Boot
のRun/Debug Configuration
は、初期状態ではEnvironment variables
が表示されないようでした。
この場合、まずModify options
(画像では-cp edit-env-demo.main
の上)を開きます。
この中から、Environment variables
を表示するようチェックを付けることで、編集ができるようになります。
テンプレートを編集して設定する
基本的な編集方法として紹介した内容では、個別のRun/Debug Configuration
にしか設定が行われません。
つまり、プロジェクト内で一意な内容であっても、Run/Debug Configuration
を増やすたびに環境設定変数が必要になってしまうということです。
テンプレートを編集して環境変数を設定することで、この手間を回避することができます。
やり方としては、まずRun/Debug Configurations
ウィンドウ左下のEdit configuration templates...
を開きます。
開いた画面の左から編集したいテンプレートを選び、先ほど同様にEnvironment variables
を設定し、OK
を押すことで反映できます。
ここで、自分の環境では、Apply
でセットしようとすると何故かエラーになることがあったのでご注意ください。
画像では、FOO_KEY=foo;BAR_ID=bar;BAZ_VALUE=bazbaz
という値を設定しています
ここから設定した環境変数は、例えばGradle ツールウィンドウ(gradle
プロジェクトで右側のサイドバーに出てくるもの)等から追加したRun/Debug Configuration
にも適用されます。