https://github.com/irof/spring-boot-dev-services-sample
Spring Bootの開発時サービスサポートのサンプル実装
https://github.com/irof/spring-boot-dev-services-sample
blog docker-compose sample-code spring-boot testcontainers
Last synced: about 2 months ago
JSON representation
Spring Bootの開発時サービスサポートのサンプル実装
- Host: GitHub
- URL: https://github.com/irof/spring-boot-dev-services-sample
- Owner: irof
- Created: 2025-04-05T18:56:11.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-08T02:20:52.000Z (about 2 months ago)
- Last Synced: 2025-04-08T03:25:48.197Z (about 2 months ago)
- Topics: blog, docker-compose, sample-code, spring-boot, testcontainers
- Language: Java
- Homepage: https://irof.hateblo.jp/entry/2025/04/06/141247
- Size: 70.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spring Bootの開発時サービスサポートのサンプル実装
- [Spring Boot / リファレンス / コア機能 / 開発時のサービス](https://spring.pleiades.io/spring-boot/reference/features/dev-services.html)
Spring Boot 3.4.4でのサンプル実装です。
それぞれの `README.md` とコードを参照ください。
## 背景
Spring Boot 3.1でTestcontainersとDocker Composeのサポートが導入されました。
導入時はそれぞれ独立した項目でしたが、現在（Spring Boot 3.4.4）では [開発時のサービス](https://spring.pleiades.io/spring-boot/reference/features/dev-services.html) （[Development-time Services](https://docs.spring.io/spring-boot/reference/features/dev-services.html)）としてまとめられています。
TestcontainersやDocker ComposeはそれぞれSpring Bootのサポートがなくても使われてきましたが、
サポートが導入されたことで非常に使いやすくなりました。
Spring Bootがサポートしてくれることを簡単に言うと「テストやローカル実行時に勝手にOCIコンテナを立ち上げて接続設定も面倒見てくれる」という機能です。
これがなければ自身（もしくは外部の仕組み）でコンテナを立ち上げて、その設定に従ってSpring Boot側に接続設定を行う必要がありました。
ちょっと楽になります。このちょっとさがとても大事。（だからと言って「テストでもどんどんコンテナ使いましょう！！」とはならない点には注意が必要ですが、それは別の話。）
それぞれが独立したツールであり、実際に併用されてきため、動かす方法は幾通りもあります。
それだけに情報も錯綜するため、何をどう使ったら動くか（また動かないか）がわかりづらくもあります。
なので極力シンプルかつ実プロダクトで使う場合のイメージで動くものを書いておこうと思いました。
## 実装とコメント
マルチプロジェクト構成にしていますが、関連も共通部分もなしにしています。独立して動きます。
- [Testcontainers](./testcontainers)
- [Docker Compose](./docker-compose)
それぞれのREADMEを参照ください。
## 所感
各READMEに書いた「ざっくり導入手順」を見て分かるように、簡単に使えるのはDocker Composeの方です。
一方でTestcontainersの方が柔軟で痒いところにも手が届きそうな感じです。
Docker Composeサポートはシンプルケースでは `org.springframework.boot:spring-boot-docker-compose` を依存に入れるだけで済み、 `ServiceConnection` などは表に出てきません。
すでにDocker Composeを使っている場合、依存を追加するだけで動作しかねません。
楽なのはいいですが、設定が必要な状況になると急に難度が上がるように感じるかもしれません。
TestcontainersサポートはTestcontainersの `Container` を使って `@ServiceConnection` も書くので、うまくいかなくてもこの延長線上でなんとかなる感はあります。
[スライスをテストする](https://spring.pleiades.io/spring-boot/reference/testing/spring-boot-applications.html#testing.spring-boot-applications.autoconfigured-tests)場合などは
必要なコンテナのみを使用するのも簡単です。
Testcontainers単体で使う場合でも複数通りの使い方があり、さらにSpring Bootのドキュメントでもいくつかの使い方が示されているため、
どうやったら動くのかわかりづらいかもしれませんし、効果のない組み合わせで使ったりとかも散見されます。
ローカル実行はサポート機能は使わなくていいかなぁというのが正直なところですが、使うならDocker Composeかなと思います。
ただテストで使っていない場合にローカル実行のために依存を追加するかというと正直微妙なところ。
TestcontainersはJDBC URLなら使いたいですが、JDBC以外には使えませんし、名前に冠している通りテスト向きで、ローカル実行ではどうしてもぎこちない感じが拭えません。
とはいえ併用も微妙なので、テストでTestcontainersを使っているなら使ってもいいかなぁ、くらい。忌避するほどのものではない感覚です。
## メモ
- Testcontainersのバージョンも[Spring BootでManagement](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.1-Release-Notes#dependency-management-for-testcontainers)されています。Testcontainersに限らず、Spring BootがManagementしているバージョンはよほどの事情がない限り自分で指定しない方がいいです。
- Gradleの `testAndDevelopmentOnly` は[Spring Boot 3.2で追加](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.2-Release-Notes#testanddevelopmentonly-gradle-configuration)されました。Testcontainersのためだそうですが、他でも使えるかもですね。