Spring Boot Kotlin プロジェクトプロンプト

• 以下のソフトウェアがシステムにインストールされていることを確認してください:

  • Java 21
  • Docker
  • Docker Compose

• プロジェクト名をカスタマイズする必要がある場合は、Spring Boot プロジェクトテンプレートのダウンロードの artifactId と packageName を変更してください

• Spring Boot のバージョンを更新する必要がある場合は、Spring Boot プロジェクトテンプレートのダウンロードの bootVersion を変更してください

Java のバージョン確認

• ターミナルで以下のコマンドを実行し、Java のバージョンを確認します

java -version

Spring Boot プロジェクトテンプレートのダウンロード

• ターミナルで以下のコマンドを実行して、Spring Boot プロジェクトテンプレートをダウンロードします

curl https://start.spring.io/starter.zip \
  -d artifactId=${input:projectName:demo-kotlin} \
  -d bootVersion=3.4.5 \
  -d dependencies=configuration-processor,webflux,data-r2dbc,postgresql,data-redis-reactive,data-mongodb-reactive,validation,cache,testcontainers \
  -d javaVersion=21 \
  -d language=kotlin \
  -d packageName=com.example \
  -d packaging=jar \
  -d type=gradle-project-kotlin \
  -o starter.zip

ダウンロードしたファイルを解凍

• ターミナルで以下のコマンドを実行して、ダウンロードしたファイルを解凍します

unzip starter.zip -d ./${input:projectName:demo-kotlin}

ダウンロードした zip ファイルを削除

• ターミナルで以下のコマンドを実行して、ダウンロードした zip ファイルを削除します

rm -f starter.zip

ダウンロードしたファイルを解凍

• ターミナルで以下のコマンドを実行して、ダウンロードしたファイルを解凍します

unzip starter.zip -d ./${input:projectName:demo-kotlin}

追加の依存関係を追加

• springdoc-openapi-starter-webmvc-ui と archunit-junit5 依存関係を build.gradle.kts ファイルに追加します

dependencies {
  implementation("org.springdoc:springdoc-openapi-starter-webflux-ui:2.8.6")
  testImplementation("com.tngtech.archunit:archunit-junit5:1.2.1")
}

• SpringDoc の設定を application.properties ファイルに追加します

# SpringDoc configurations
springdoc.swagger-ui.doc-expansion=none
springdoc.swagger-ui.operations-sorter=alpha
springdoc.swagger-ui.tags-sorter=alpha

• Redis の設定を application.properties ファイルに追加します

# Redis configurations
spring.data.redis.host=localhost
spring.data.redis.port=6379
spring.data.redis.password=rootroot

• R2DBC の設定を application.properties ファイルに追加します

# R2DBC configurations
spring.r2dbc.url=r2dbc:postgresql://localhost:5432/postgres
spring.r2dbc.username=postgres
spring.r2dbc.password=rootroot

spring.sql.init.mode=always
spring.sql.init.platform=postgres
spring.sql.init.continue-on-error=true

• MongoDB の設定を application.properties ファイルに追加します

# MongoDB configurations
spring.data.mongodb.host=localhost
spring.data.mongodb.port=27017
spring.data.mongodb.authentication-database=admin
spring.data.mongodb.username=root
spring.data.mongodb.password=rootroot
spring.data.mongodb.database=test

• プロジェクトルートに docker-compose.yaml を作成し、以下のサービスを追加します: redis:6、postgresql:17、mongo:8

  • redis サービスは以下の設定が必要です
    • パスワード rootroot
    • ポート 6379 を 6379 にマッピング
    • ボリューム ./redis_data を /data にマウント
  • postgresql サービスは以下の設定が必要です
    • パスワード rootroot
    • ポート 5432 を 5432 にマッピング
    • ボリューム ./postgres_data を /var/lib/postgresql/data にマウント
  • mongo サービスは以下の設定が必要です
    • initdb ルートユーザー名 root
    • initdb ルートパスワード rootroot
    • ポート 27017 を 27017 にマッピング
    • ボリューム ./mongo_data を /data/db にマウント

• .gitignore ファイルに redis_data、postgres_data、mongo_data ディレクトリを追加します

• gradle clean test コマンドを実行してプロジェクトが動作しているか確認します

./gradlew clean test

• (オプション) docker-compose up -d でサービスを開始し、./gradlew spring-boot:run で Spring Boot プロジェクトを実行し、docker-compose rm -sf でサービスを停止します

それでは、ステップバイステップで進めていきましょう。