create-spring-boot-java-project

Spring Boot Java プロジェクト作成プロンプト

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

  • Java 21
  • Docker
  • Docker Compose

• プロジェクト名をカスタマイズする必要がある場合は、download-spring-boot-project-template の artifactId と packageName を変更してください

• Spring Boot のバージョンを更新する必要がある場合は、download-spring-boot-project-template の bootVersion を変更してください

Java バージョンを確認する

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

java -version

Spring Boot プロジェクトテンプレートをダウンロードする

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

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

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

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

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

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

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

rm -f starter.zip

プロジェクトルートにディレクトリを移動する

• ターミナルで以下のコマンドを実行し、プロジェクトルートにディレクトリを移動します

cd ${input:projectName:demo-java}

追加の依存関係を追加する

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

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.8.6</version>
</dependency>
<dependency>
  <groupId>com.tngtech.archunit</groupId>
  <artifactId>archunit-junit5</artifactId>
  <version>1.2.1</version>
  <scope>test</scope>
</dependency>

SpringDoc、Redis、JPA、MongoDB の設定を追加する

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

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

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

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

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

# JPA configurations
spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.url=jdbc:postgresql://localhost:5432/postgres
spring.datasource.username=postgres
spring.datasource.password=rootroot
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true

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

# 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

Redis、PostgreSQL、MongoDB サービスを含む docker-compose.yaml を追加する

• プロジェクトルートに 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 ユーザー名 root
    • initdb root パスワード rootroot
    • ポート 27017 を 27017 にマッピング
    • ボリューム ./mongo_data を /data/db にマウント

.gitignore ファイルを追加する

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

Maven test コマンドを実行する

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

./mvnw clean test

Maven run コマンドを実行する (任意)

• (任意) docker-compose up -d でサービスを起動し、./mvnw spring-boot:run で Spring Boot プロジェクトを実行し、docker-compose rm -sf でサービスを停止します。

これをステップバイステップで進めましょう