Spring Bootの@Profileとspring.profiles.activeの使い方を完全ガイド！初心者向けプロファイル活用術

プロファイル活用：@Profile と spring.profiles.active の基本

先生と生徒の会話形式で理解しよう

生徒

「Spring Bootで環境ごとに設定を切り替える方法ってありますか？」

先生

「Spring Bootでは、プロファイルという仕組みを使って、開発環境や本番環境など、目的に応じた設定の切り替えが可能です。」

生徒

「そのプロファイルって、具体的にどうやって使うんですか？@Profileとかspring.profiles.activeとか見たことあります。」

先生

「とても良い着眼点です！それでは、@Profileアノテーションとspring.profiles.activeの基本的な使い方を詳しく解説していきましょう。」

1. Spring Bootにおけるプロファイルとは？

「1. Spring Bootにおけるプロファイルとは？」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

1. Spring Bootにおけるプロファイルとは？

Spring Bootのプロファイル機能は、アプリケーションの実行環境に応じて、使用するBeanや設定を切り替えるための便利な仕組みです。たとえば、開発環境ではH2データベース、本番環境ではMySQLなど、同じコードベースでも環境によって構成を変更できます。

このように、環境別の構成を柔軟に管理できるのが、Spring Bootにおけるプロファイルの強みです。

2. spring.profiles.activeの基本的な使い方

spring.profiles.activeは、どのプロファイルを有効にするかを指定するための設定キーです。指定されたプロファイルに対応するBeanや設定ファイルがアクティブになります。

指定方法は複数あります。

application.properties で指定
コマンドライン引数で指定
環境変数で指定

たとえば、application.properties内に次のように書きます：


spring.profiles.active=dev

または、起動時にコマンドライン引数で指定する方法もあります。


java -jar myapp.jar --spring.profiles.active=prod

このようにして、任意のプロファイルを指定して起動させることが可能です。

3. application-{profile}.properties の活用

Spring Bootでは、プロファイルごとの設定をファイル分割して管理することができます。ファイル名の末尾にプロファイル名をつけることで、そのプロファイルが有効なときだけ読み込まれるようになります。

例として、次のような設定ファイルを用意します：

application.properties（共通設定）
application-dev.properties（開発環境用設定）
application-prod.properties（本番環境用設定）

そして、spring.profiles.activeでdevを指定すれば、application-dev.propertiesの内容が読み込まれます。

4. @Profileアノテーションの基本

「4. @Profileアノテーションの基本」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

4. @Profileアノテーションの基本

@Profileアノテーションは、Javaクラスやメソッドに付けて、特定のプロファイルがアクティブなときだけBeanとして登録するために使用されます。

次の例では、開発環境専用のBeanを定義しています：


@Configuration
@Profile("dev")
public class DevConfig {

    @Bean
    public DataSource dataSource() {
        return new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.H2)
            .build();
    }
}

このDevConfigクラスは、プロファイルにdevが指定されているときだけ有効になります。

5. プロファイルを使ったBeanの切り替え例

Spring Bootアプリケーションでよく使われるのが、データベースやメール送信機能などの環境依存コンポーネントを、プロファイルごとに切り替える方法です。

以下に、開発と本番で異なる実装を提供する例を紹介します。


public interface MailService {
    void sendMail(String to, String message);
}


@Service
@Profile("dev")
public class DummyMailService implements MailService {
    public void sendMail(String to, String message) {
        System.out.println("開発用ダミーメール：" + to + " " + message);
    }
}


@Service
@Profile("prod")
public class RealMailService implements MailService {
    public void sendMail(String to, String message) {
        // 本番用のメール送信処理
    }
}

このように、開発時はログ出力だけにし、本番では実際にメールを送信する実装を切り替えることができます。

6. プロファイルが設定されていないときの動作

プロファイルが明示的に指定されていない場合、@Profileが付いたクラスは無視され、読み込まれません。そのため、必ずspring.profiles.activeの指定を行うことが重要です。

なお、条件に応じてプロファイルを自動切り替えしたい場合は、デフォルトプロファイルの設定も活用できます。


spring.profiles.default=dev

7. 複数のプロファイルを同時に指定する

「7. 複数のプロファイルを同時に指定する」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

7. 複数のプロファイルを同時に指定する

Spring Bootでは、カンマ区切りで複数のプロファイルを同時にアクティブにすることが可能です。


spring.profiles.active=dev,test

このようにすると、devとtestの両方の設定やBeanが有効になります。複雑な構成を実現したいときに便利です。

8. Spring Bootプロファイル機能の活用シーン

プロファイルの活用は、開発・テスト・本番の各環境に応じた設定を安全に管理するために不可欠です。

開発環境では、H2などのインメモリDBを使用
テスト環境では、モックサービスやStubを有効化
本番環境では、実際のデータベースやメール送信サービスを使う

このように、Spring Bootのプロファイル機能を使えば、コードの修正を最小限に抑えつつ、柔軟な環境構成を実現できます。

9. Spring Bootアプリケーションでプロファイルを確認する方法

現在アクティブになっているプロファイルを確認するには、次のようなコードを使用します。


@RestController
public class ProfileCheckController {

    @Autowired
    private Environment environment;

    @GetMapping("/profile")
    public String getActiveProfile() {
        return String.join(", ", environment.getActiveProfiles());
    }
}

このエンドポイントにアクセスすると、現在有効なプロファイルを確認することができます。

まとめ

「まとめ」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

まとめ

Spring Bootのプロファイル機能を理解すると、開発環境、テスト環境、本番環境など、実行する環境に応じて設定やBeanを安全に切り替えられるようになります。アプリケーション開発では、開発中は簡単に使えるデータベースを利用し、本番では実際のデータベースや外部サービスを利用することがよくあります。このような環境差をコードの書き換えで対応してしまうと、設定ミスや本番事故につながる可能性があります。そこで役立つのが、Spring Bootの@Profileとspring.profiles.activeです。

spring.profiles.activeは、現在どのプロファイルを有効にするかを指定する設定です。たとえばdevを指定すれば開発環境用、prodを指定すれば本番環境用の設定やBeanを有効にできます。application-dev.propertiesやapplication-prod.propertiesのように設定ファイルを分けておけば、データベース接続先、ログレベル、メール送信設定、外部APIのURLなどを環境ごとに管理できます。

@Profileは、特定のプロファイルが有効なときだけBeanを登録するためのアノテーションです。開発環境ではダミーのメール送信サービスを使い、本番環境では実際のメール送信サービスを使う、といった切り替えが可能になります。同じインターフェースを使いながら実装だけを切り替えられるため、サービス層のコードを大きく変更せずに環境別の動作を実現できます。

プロファイル設定の基本をもう一度確認

Spring Bootでプロファイルを有効にする基本は、spring.profiles.activeにプロファイル名を指定することです。開発環境ならdev、本番環境ならprod、テスト環境ならtestのように、分かりやすい名前を付けると管理しやすくなります。


spring.profiles.active=dev

jarファイルを起動するときに切り替えたい場合は、コマンドライン引数で指定できます。本番環境では設定ファイルへ直接書き込むよりも、起動時の引数や環境変数で指定するほうが運用しやすい場合があります。


java -jar myapp.jar --spring.profiles.active=prod

このように指定することで、同じアプリケーションのコードを使いながら、読み込む設定や有効になるBeanを切り替えられます。Spring Bootの環境切り替えでは、プロファイル名を明確にし、どの環境でどの設定が使われるのかを分かるようにしておくことが大切です。

設定ファイルを環境ごとに分ける

Spring Bootでは、application.propertiesに共通設定を書き、application-dev.propertiesやapplication-prod.propertiesに環境別の設定を書くことができます。これにより、共通部分と環境ごとの差分を整理しやすくなります。


# application.properties
spring.application.name=profile-sample
server.port=8080


# application-dev.properties
spring.datasource.url=jdbc:h2:mem:testdb
logging.level.root=DEBUG


# application-prod.properties
spring.datasource.url=jdbc:mysql://localhost:3306/appdb
logging.level.root=INFO

このように設定ファイルを分けると、開発環境ではH2データベースや詳細なログを使い、本番環境ではMySQLや控えめなログ設定を使う、といった切り替えができます。環境ごとの設定を一つのファイルに詰め込むよりも、見通しがよくなり、設定ミスを防ぎやすくなります。

@ProfileでBeanを切り替える

@Profileを使うと、特定のプロファイルが有効なときだけクラスやBeanを登録できます。たとえば、開発中は実際にメールを送らず、コンソールに出力するだけのダミー実装を使うと安全です。本番環境では実際のメール送信処理を持つ実装を使います。


public interface MailService {
    void sendMail(String to, String message);
}


@Service
@Profile("dev")
public class DummyMailService implements MailService {

    @Override
    public void sendMail(String to, String message) {
        System.out.println("開発用メール送信：" + to + " " + message);
    }

}


@Service
@Profile("prod")
public class RealMailService implements MailService {

    @Override
    public void sendMail(String to, String message) {
        // 本番用のメール送信処理
    }

}

このように同じMailServiceインターフェースを使い、プロファイルごとに実装を切り替えることで、呼び出し側のコードは環境を意識せずに済みます。開発環境で誤って本物のメールを送ってしまう事故を防ぐためにも、@Profileは非常に便利です。

複数プロファイルとデフォルトプロファイル

Spring Bootでは、複数のプロファイルを同時に有効にできます。たとえばdevとtestを同時に有効にしたい場合は、カンマ区切りで指定します。共通の開発設定に加えて、テスト用の設定を重ねたい場合に便利です。


spring.profiles.active=dev,test

また、プロファイルが明示されていないときのために、spring.profiles.defaultを指定できます。これにより、何も指定しなかった場合でも開発用の設定を読み込むようにできます。ただし、本番環境で意図せずdevが有効にならないよう、運用ルールを明確にしておくことが大切です。


spring.profiles.default=dev

現在のプロファイルを確認する方法

アプリケーションがどのプロファイルで動いているかを確認したい場合は、Environmentを利用できます。開発中や運用確認用に、現在のアクティブプロファイルを表示する仕組みを作っておくと、設定ミスを見つけやすくなります。


@RestController
public class ProfileCheckController {

    private final Environment environment;

    public ProfileCheckController(Environment environment) {
        this.environment = environment;
    }

    @GetMapping("/profile")
    public String getActiveProfile() {
        return String.join(", ", environment.getActiveProfiles());
    }

}

ただし、本番環境で内部情報を外部に公開しすぎるのは危険です。確認用のエンドポイントを作る場合は、認証をかける、管理者だけが見られるようにする、必要がなくなったら無効化するなど、セキュリティにも配慮しましょう。

プロファイル運用で注意したいポイント

プロファイルは便利ですが、設定を増やしすぎると、どの設定が有効なのか分かりにくくなることがあります。dev、test、staging、prodのように目的が明確な名前にし、設定ファイルの中身も環境ごとの差分に絞ると管理しやすくなります。

また、本番用のパスワード、APIキー、データベース接続情報などの機密情報をソースコード管理に含めないことも重要です。プロファイル設定ファイルで環境を分ける場合でも、秘密情報は環境変数や外部の設定管理を使って渡す設計にすると安全です。

Spring Boot、プロファイル、@Profile、spring.profiles.active、application.properties、application-dev.properties、application-prod.properties、Bean切り替え、環境別設定、開発環境、本番環境、テスト環境、デフォルトプロファイル、Environment、DataSource、MailService、H2、MySQL、設定管理、Javaアプリケーション開発といったキーワードは、Spring Bootの環境切り替えを学ぶうえで重要です。

初心者は、まずdevとprodの二つを作り、設定ファイルの違いを確認するところから始めると理解しやすいです。次に@Profileでダミーサービスと本番サービスを切り替え、最後に複数プロファイルやデフォルトプロファイルを試すと、Spring Bootのプロファイル機能の全体像がつかめます。

Spring Bootの@Profileとspring.profiles.activeは、環境ごとの設定を安全に分けるための基本機能です。設定を手作業で書き換えるのではなく、プロファイルで切り替えることで、開発、本番、テストの運用が安定します。環境ごとの違いを明確にし、Beanや設定ファイルを整理することで、保守しやすく安全なSpring Bootアプリケーションを作っていきましょう。

先生と生徒の振り返り会話

生徒

Spring Bootのプロファイルは、開発環境や本番環境で設定を切り替えるための仕組みだと分かりました。

先生

その通りです。同じコードでも、環境に応じてデータベースやメール送信などの設定を切り替えられます。

生徒

spring.profiles.activeにdevやprodを指定すると、そのプロファイルが有効になるのですね。

先生

はい。application-dev.propertiesやapplication-prod.propertiesのような環境別設定ファイルが読み込まれます。

生徒

@Profileを使うと、特定の環境だけでBeanを有効にできることも分かりました。

先生

はい。開発用のダミー実装と本番用の実装を切り替えるときに便利です。

生徒

開発環境ではダミーメール、本番環境では実際のメール送信を使うような切り替えができるのですね。

先生

その理解で大丈夫です。誤送信を防ぐ意味でも、プロファイルによる切り替えは実務でよく使われます。

生徒

複数のプロファイルを同時に指定したり、デフォルトプロファイルを設定したりすることもできるのですね。

先生

はい。ただし、どの設定が有効なのか分かりにくくならないように、名前や運用ルールを整理しておくことが大切です。

生徒

本番用のパスワードやAPIキーは、設定ファイルに直接書かず、環境変数などで管理したほうが安全ですね。

先生

その通りです。プロファイルは便利ですが、機密情報の扱いには注意が必要です。環境ごとの設定を正しく分けて、安全で保守しやすいSpring Bootアプリケーションを作っていきましょう。

スタースクール：社会人向け実務教育プロジェクト

【職業訓練講師が直接指導】

社会人向けSpring Boot実務セミナー｜職業訓練講師が教えるWebシステム構築の極意

Java入門からSpring Boot実務まで。現場で絶賛される「設計の型」を最短距離で習得。

技術記事の内容を、自分の「スキル」へ変える。

職業訓練講師が最短攻略！社会人向けSpring Bootによる「商用Webシステム構築」の実践。

モダンJava開発の事実上の標準Spring Boot。本セミナーでは、その圧倒的利便性の核にある「DI（依存性の注入）」を完全解剖。「設定より規約」を体現した効率的なアーキテクチャ設計を学び、ThymeleafやSpring Data JPAを組み合わせた、現場で必須となるWebシステムの作り方を60分で濃縮体験します。