Micronautで外部設定ファイルを読み込む方法！環境別設定の書き分けを徹底解説

1. 基本の外部設定ファイルの作成

1. 基本の外部設定ファイルの作成

Micronautでは、アプリの設定を「外部設定ファイル」として管理できます。外部設定ファイルとは、データベース接続先やログ出力レベルなど、環境ごとに変わりやすい情報をまとめて書いておくファイルのことです。

設定ファイルは src/main/resources ディレクトリに配置します。まず共通設定として application.yml を用意し、開発環境・本番環境などで内容を切り替えたい場合は、application-dev.yml や application-prod.yml のようにファイルを分けるのが基本的な使い方です。

たとえば、開発環境では手軽に使えるインメモリデータベースを利用し、本番環境ではMySQLを使う、といったケースがよくあります。以下は開発環境用の設定例です。

micronaut:
  application:
    name: myapp
datasource:
  url: jdbc:h2:mem:devdb
  username: sa
  password: ""
logging:
  level:
    root: INFO

この設定では、アプリ名を myapp とし、H2という軽量なデータベースを使用しています。開発中はログを確認しやすいよう、ログレベルをINFOに設定しています。

一方、本番環境用の設定は次のようになります。

micronaut:
  application:
    name: myapp
datasource:
  url: jdbc:mysql://prod-db:3306/myapp
  username: produser
  password: secret
logging:
  level:
    root: WARN

本番環境では実際のMySQLサーバーに接続し、不要なログを減らすためログレベルをWARNにしています。このように設定ファイルを分けるだけで、コードを変更せずに環境ごとの挙動を切り替えられるのがMicronautの大きなメリットです。

2. プロファイルの指定方法

2. プロファイルの指定方法

Micronautアプリケーションの起動時にプロファイルを指定することで、対応する設定ファイルが読み込まれます。例えばdevプロファイルで起動する場合、Gradleでは以下のように指定します。

./gradlew run -Dmicronaut.environments=dev

また、IntelliJ IDEAなどのIDEで実行する場合はVMオプションに-Dmicronaut.environments=devを追加するだけです。これによりapplication-dev.ymlが読み込まれ、環境ごとの設定が自動的に反映されます。

3. 設定値の読み込み

3. 設定値の読み込み

外部設定は@Valueアノテーションや@Propertyアノテーションで簡単に取得できます。例えば、データベースURLをBeanに注入する場合は次のように書きます。

import io.micronaut.context.annotation.Value;
import jakarta.inject.Singleton;

@Singleton
public class DatabaseConfig {

    @Value("${datasource.url}")
    private String url;

    public void printUrl() {
        System.out.println("Datasource URL: " + url);
    }
}

プロファイルがdevならapplication-dev.yml、prodならapplication-prod.ymlの値が注入されます。SEOキーワード：Micronaut @Value、設定値注入、環境別設定、Java DI、Micronaut Bean設定

4. 設定値の型安全な取得

4. 設定値の型安全な取得

@ConfigurationPropertiesを使うと、YAMLの階層構造をJavaクラスとして受け取ることができ、型安全に設定値を扱えます。例えば以下の例です。

import io.micronaut.context.annotation.ConfigurationProperties;
import jakarta.inject.Singleton;

@ConfigurationProperties("datasource")
@Singleton
public class DataSourceConfig {
    private String url;
    private String username;
    private String password;

    // getter, setter
    public String getUrl() { return url; }
    public void setUrl(String url) { this.url = url; }
    public String getUsername() { return username; }
    public void setUsername(String username) { this.username = username; }
    public String getPassword() { return password; }
    public void setPassword(String password) { this.password = password; }
}

これにより、設定値を直接クラスとして利用でき、タイプミスや値の不整合を防ぐことができます。

5. 実務での活用ポイント

5. 実務での活用ポイント

• 環境ごとにapplication-{profile}.ymlを作成し、dev/test/prodで設定を切り替える
• @Valueや@ConfigurationPropertiesでBeanに設定値を注入する
• 起動時に- Dmicronaut.environmentsで環境を指定して切り替え可能
• 型安全な設定クラスを作ることでコード品質を向上
• 外部設定ファイルを使うことで設定変更がコードに影響せず、運用が簡単になる

SEOキーワード：Micronaut 外部設定ファイル、環境別設定、application-dev.yml、@ConfigurationProperties、Java Micronaut 設定管理、プロファイル切替

まとめ

まとめ

ここまで、Micronautにおける外部設定ファイルの管理と、環境ごとの切り替え手法について詳しく解説してきました。モダンなJavaアプリケーション開発において、ソースコードと設定値を分離することは、保守性やセキュリティの観点から非常に重要です。特にMicronautは、起動の速さやメモリ消費の少なさが特徴ですが、その設定管理の仕組みも非常に洗練されており、Spring Bootなどの経験がある方にとっても親しみやすい設計になっています。

設定管理の重要性とプロファイルの役割

開発の現場では、ローカル開発環境、テスト環境、ステージング環境、そして本番環境と、複数のフェーズが存在します。それぞれの環境でデータベースの接続先やAPIの接続エンドポイント、ログの出力レベルなどが異なるのは当然のことです。これらを一つのファイルに書き込んでコメントアウトで切り替えるような運用は、ミスを誘発するだけでなく、デプロイ自動化の妨げにもなります。Micronautのプロファイル機能（environments）を活用すれば、application-{env}.ymlという命名規則に従うだけで、実行時に適切な値を自動でマッピングしてくれます。

型安全な設定値の取得（ConfigurationProperties）

小規模なプロジェクトであれば@Valueアノテーションで個別に値をインジェクトする手法でも十分ですが、大規模なシステムや設定項目が多岐にわたる場合は、@ConfigurationPropertiesを用いたクラスベースの管理を強く推奨します。これにより、IDEの補完機能が効くようになり、コンパイル時に型の整合性をチェックできるため、実行時に初めて型変換エラーに気づくといったトラブルを未然に防ぐことができます。

実戦的なサンプルプログラム：カスタム設定の統合

最後に、これまでの内容を統合した、より実戦に近いサンプルコードを確認しましょう。外部の天気予報APIの情報を環境ごとに管理する想定のクラス構成です。

1. 設定ファイルの記述（application-dev.yml）

external-api:
  weather:
    url: "https://dev-api.weather.com"
    api-key: "dev-key-12345"
    timeout-seconds: 5

2. 設定保持クラスの定義

package com.example.config;

import io.micronaut.context.annotation.ConfigurationProperties;
import io.micronaut.core.annotation.Introspected;

@ConfigurationProperties("external-api.weather")
@Introspected
public class WeatherApiConfig {
    private String url;
    private String apiKey;
    private int timeoutSeconds;

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getApiKey() {
        return apiKey;
    }

    public void setApiKey(String apiKey) {
        this.apiKey = apiKey;
    }

    public int getTimeoutSeconds() {
        return timeoutSeconds;
    }

    public void setTimeoutSeconds(int timeoutSeconds) {
        this.timeoutSeconds = timeoutSeconds;
    }
}

3. サービスでの利用例

package com.example.service;

import com.example.config.WeatherApiConfig;
import jakarta.inject.Singleton;

@Singleton
public class WeatherService {
    private final WeatherApiConfig config;

    public WeatherService(WeatherApiConfig config) {
        this.config = config;
    }

    public void connect() {
        System.out.println("Connecting to: " + config.getUrl());
        System.out.println("With Key: " + config.getApiKey());
        System.out.println("Timeout: " + config.getTimeoutSeconds() + "s");
    }
}

4. 実行結果の確認

上記のコードを -Dmicronaut.environments=dev オプションを付けて実行した際の標準出力の結果です。

Connecting to: https://dev-api.weather.com
With Key: dev-key-12345
Timeout: 5s

このように、設定値が階層構造のままオブジェクトとして扱えることがわかります。Micronautの外部設定機能をマスターすることで、柔軟で堅牢なマイクロサービス、あるいはWebアプリケーションの構築が可能になります。設定の外部出し、プロファイルの活用、そして型安全なプロパティ読み込み。この3点をセットで覚えて、ぜひ日々のJava開発に役立ててください。