Upgrade to Java 21 and OpenAPI Swagger UI works

yasuflatland-lf · yasuflatland-lf · commit 14c82fa55c39 · 2025-02-01T16:07:16.000+09:00
diff --git a/.cursorrules b/.cursorrules
@@ -6,7 +6,7 @@ You are an experienced Senior Java Developer, You always adhere to SOLID princip
 
 Technology stack：
 
-Framework: Java Spring Boot 3 Maven with Java 21 Dependencies: Spring WebFlux, Spring Data JPA, Lombok, MySQL driver, Spring Data R2DBC
+Framework: Java Spring Boot 3 Gradle with Java 21 Dependencies: Spring WebFlux, Spring Data JPA, Lombok, Postgres driver, Spring Data R2DBC
 
 Application Logic Design：
 
diff --git a/.gitignore b/.gitignore
@@ -34,6 +34,6 @@ out/
 
 ### VS Code ###
 .vscode/
-db/mysql_data
 spring-boot-logger.log
 logs
+db/postgres_data/
diff --git a/Makefile b/Makefile
@@ -13,10 +13,6 @@ MAKEFILE_DIR:=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 help: ## Display this help screen
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
 
-.PHONY: clean
-clean: ## Cleanup database environment
-	rm -fR ./db/mysql_data
-
 .PHONY: down
 down: ## Docker compose down
 	docker-compose down;
@@ -31,6 +27,10 @@ devBoot: ## Run development environment
 
 .PHONY: run
 run: ## Run production environment
+	docker-compose up;
+
+.PHONY: run_init
+run_init: ## Run production environment with initialization
 	docker-compose up --build;
 
 .PHONY: genapi
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ A sample of Spring boot WebFlux and Kotlin Coroutine with Handler and Router. In
 
 # Reqirements
 - Java 21
-- Docker 4.37.1 >=
+- Docker 4.37.2 >=
 - gradle 8.12 >=
 
 # Getting Started
@@ -18,7 +18,7 @@ $ make run
 ```
 `application.yml` will be referred for the configuration. This command does
 - Build Docker image with the implementation
-- Spin up MySQL and Springboot application (this application) by `docker-compose`
+- Spin up Database and Springboot application (this application) by `docker-compose`
 
 ## Development
 ```bash
@@ -27,7 +27,7 @@ $ make devBoot
 ```
 `application-local.yml` will be referred for the configuration.
 
-`make devDB` only spins up MySQL, and `make devBoot` run this application by development mode via `gradle`.
+`make devDB` only spins up Database, and `make devBoot` run this application by development mode via `gradle`.
 
 ### How to run test
 ```bash
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -21,7 +21,7 @@ repositories {
 }
 
 extra["kotestVersion"] = "5.9.1"
-extra["openAPIVersion"] = "1.8.0"
+extra["openAPIVersion"] = "2.8.4"
 extra["testcontainersVersion"] = "1.20.4"
 extra["coroutinesCoreVersion"] = "1.10.1"
 
@@ -44,15 +44,15 @@ dependencies {
     annotationProcessor("org.projectlombok:lombok")
     
     // OpenAPI
-    implementation("org.springdoc:springdoc-openapi-kotlin:${property("openAPIVersion")}")
-    implementation("org.springdoc:springdoc-openapi-webflux-ui:${property("openAPIVersion")}")
+    implementation("org.springframework.cloud:spring-cloud-function-web:4.2.1")
+    implementation("org.springdoc:springdoc-openapi-starter-webflux-ui:${property("openAPIVersion")}")
+    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
 
     // Database
-    implementation("io.asyncer:r2dbc-mysql:1.3.1")
     implementation("io.r2dbc:r2dbc-pool:1.0.2.RELEASE")
-    runtimeOnly("com.mysql:mysql-connector-j:8.4.+")
     implementation("org.springframework.data:spring-data-commons")
     implementation("org.springframework.data:spring-data-relational")
+    implementation("org.postgresql:r2dbc-postgresql:1.0.7.RELEASE")
 
     // Test
     testImplementation("io.kotest:kotest-runner-junit5:${property("kotestVersion")}")
@@ -64,9 +64,9 @@ dependencies {
     testImplementation("org.springframework.boot:spring-boot-starter-test")
     testImplementation("org.springframework.boot:spring-boot-testcontainers")
     testImplementation("io.projectreactor:reactor-test")
-    testImplementation("org.testcontainers:junit-jupiter:1.17.3")
-    testImplementation("org.testcontainers:mysql:1.17.3")
-    testImplementation("org.testcontainers:r2dbc")
+    testImplementation("org.testcontainers:junit-jupiter:${property("testcontainersVersion")}")
+    testImplementation("org.testcontainers:postgresql:${property("testcontainersVersion")}")
+    testImplementation("org.testcontainers:r2dbc:${property("testcontainersVersion")}")
 
     // Faker
     implementation("net.datafaker:datafaker:1.8.1")
diff --git a/db/my.cnf b/db/my.cnf
diff --git a/db/mysql_init/01-databases.sql b/db/mysql_init/01-databases.sql
diff --git a/db/postgres_init/01-databases.sql b/db/postgres_init/01-databases.sql
@@ -0,0 +1,3 @@
+-- データベースを作成
+CREATE DATABASE test
+WITH ENCODING 'UTF8';
diff --git a/docker-compose-local.yml b/docker-compose-local.yml
@@ -1,18 +1,17 @@
 services:
-  mysql:
-    image: mysql:8.0
-    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
+  postgres:
+    image: postgres:15
+    environment:
+      POSTGRES_USER: test
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: test
     ports:
-      - "3306:3306"
-      - "33060:33060"
+      - "5432:5432"
     volumes:
-      # Data initialize script trigger directory. place initialize file under the mysql_init directory.
-      - ./db/mysql_init:/docker-entrypoint-initdb.d
-      # persistent data directory
-      - ./db/mysql_data:/var/lib/mysql
-      # configuration file
-      - ./db/my.cnf:/etc/mysql/conf.d/my.cnf
-    environment:
-      MYSQL_ROOT_PASSWORD: password
-      MYSQL_USER: test
-      MYSQL_PASSWORD: password
+      - ./db/postgres_data:/var/lib/postgresql/data
+      - ./db/postgres_init:/docker-entrypoint-initdb.d
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U test"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,24 +1,20 @@
 services:
-  mysql:
-    image: mysql:8.0
-    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
-    healthcheck:
-      test: "exit 0"
-
+  postgres:
+    image: postgres:15
+    environment:
+      POSTGRES_USER: test
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: test
     ports:
-      - "3306:3306"
-      - "33060:33060"
+      - "5432:5432"
     volumes:
-      # Data initialize script trigger directory. place initialize file under the mysql_init directory.
-      - ./db/mysql_init:/docker-entrypoint-initdb.d
-      # persistent data directory
-      - ./db/mysql_data:/var/lib/mysql
-      # configuration file
-      - ./db/my.cnf:/etc/mysql/conf.d/my.cnf
-    environment:
-      MYSQL_ROOT_PASSWORD: password
-      MYSQL_USER: test
-      MYSQL_PASSWORD: password
+      - ./db/postgres_data:/var/lib/postgresql/data
+      - ./db/postgres_init:/docker-entrypoint-initdb.d
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U test"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
 
   app:
     build:
@@ -28,5 +24,5 @@ services:
       - "8080:8080"
       - "9090:9090"
     depends_on:
-      mysql:
+      postgres:
         condition: service_healthy
diff --git a/run.sh b/run.sh
@@ -1,4 +1,3 @@
 #!/bin/sh
 
-java -Dspring.devtools.restart.enabled=false \
--noverify $JAVA_OPTS -jar spring-boot-webflux-kotlin-coroutine.jar
+java -Dspring.devtools.restart.enabled=false $JAVA_OPTS -jar spring-boot-webflux-kotlin-coroutine.jar
diff --git a/src/main/resources/application-local.yml b/src/main/resources/application-local.yml
@@ -7,8 +7,8 @@ spring:
       enabled: true
       initial-size: 10
       max-size: 50
-    url: r2dbc:mysql://127.0.0.1:3306/test?characterEncoding=utf-8
-    username: root
+    url: r2dbc:postgresql://127.0.0.1:5432/test
+    username: test
     password: password
 
   main:
@@ -17,4 +17,4 @@ spring:
 springdoc:
   version: '@springdoc.version@'
   swagger-ui:
-    use-root-path: true
+    enabled: true
diff --git a/src/main/resources/application-test.yml b/src/main/resources/application-test.yml
@@ -11,4 +11,4 @@ server:
 springdoc:
   version: '@springdoc.version@'
   swagger-ui:
-    use-root-path: true
+    enabled: true
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
@@ -7,14 +7,15 @@ spring:
       enabled: true
       initial-size: 10
       max-size: 50
-    url: r2dbc:mysql://mysql:3306/test?characterEncoding=utf-8
+    url: r2dbc:postgresql://postgres:5432/test
+    username: test
     password: password
-    username: root
 
   main:
     allow-bean-definition-overriding: true
 
 springdoc:
   version: '@springdoc.version@'
   swagger-ui:
-    use-root-path: true
+    enabled: true
+
diff --git a/src/main/resources/db/tables.sql b/src/main/resources/db/tables.sql
@@ -1,10 +1,8 @@
-create table if not exists todos
-(
-    id         bigint unsigned auto_increment,
-    task       MEDIUMTEXT not null comment 'Task',
-    status     boolean  default false comment 'Task status',
-    created_at datetime default current_timestamp,
-    updated_at datetime default current_timestamp,
-    constraint todo_pk
-        primary key (id)
-) comment 'Todos' ENGINE = InnoDB DEFAULT CHARSET = utf8mb4;
+CREATE TABLE IF NOT EXISTS todos (
+    id SERIAL PRIMARY KEY,
+    task TEXT NOT NULL,
+    status BOOLEAN DEFAULT FALSE,
+    created_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP,
+    updated_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP
+);
+
diff --git a/src/test/kotlin/com/sennproject/springbootwebfluxkotlincoroutine/AbstractContainerBaseTest.kt b/src/test/kotlin/com/sennproject/springbootwebfluxkotlincoroutine/AbstractContainerBaseTest.kt
@@ -3,38 +3,30 @@ package com.sennproject.springbootwebfluxkotlincoroutine
 import org.springframework.boot.test.util.TestPropertyValues
 import org.springframework.context.ApplicationContextInitializer
 import org.springframework.context.ConfigurableApplicationContext
-import org.testcontainers.containers.MySQLContainer
+import org.testcontainers.containers.PostgreSQLContainer
 import org.testcontainers.junit.jupiter.Testcontainers
 import org.testcontainers.utility.DockerImageName
 
 @Testcontainers
 abstract class AbstractContainerBaseTest {
     companion object {
-        val mysql: MySQLContainer<*> = MySQLContainer<Nothing>(DockerImageName.parse("mysql:8.0"))
-            .apply {
-                withUsername("root")
+        val postgres: PostgreSQLContainer<*> =
+            PostgreSQLContainer<Nothing>(DockerImageName.parse("postgres:15")).apply {
+                withUsername("test")
                 withPassword("password")
                 withDatabaseName("test")
-                withConfigurationOverride("db/mysql_conf_override")
-                withUrlParam("useSsl", "false")
+                withExposedPorts(5432)
                 start()
             }
     }
 
     class Initializer : ApplicationContextInitializer<ConfigurableApplicationContext> {
         override fun initialize(applicationContext: ConfigurableApplicationContext) {
             TestPropertyValues.of(
-                "spring.r2dbc.url=${
-                    mysql.jdbcUrl.replace(
-                        "jdbc",
-                        "r2dbc"
-                    )
-                }&characterEncoding=utf-8&useSSL=false&&sslMode=DISABLED",
-                "spring.r2dbc.username=${mysql.username}",
-                "spring.r2dbc.password=${mysql.password}"
+                "spring.r2dbc.url=${postgres.jdbcUrl.replace("jdbc", "r2dbc")}",
+                "spring.r2dbc.username=${postgres.username}",
+                "spring.r2dbc.password=${postgres.password}"
             ).applyTo(applicationContext.environment)
         }
     }
-
-
-}
+}
diff --git a/src/test/kotlin/com/sennproject/springbootwebfluxkotlincoroutine/routers/TodoRoutesTest.kt b/src/test/kotlin/com/sennproject/springbootwebfluxkotlincoroutine/routers/TodoRoutesTest.kt
@@ -215,6 +215,19 @@ class TodoRoutesTest : FunSpec() {
                 .returnResult()
 
         }
+
+        test("Access OpenAPI UI") {
+            WebTestClient
+                .bindToServer()
+                .baseUrl("http://localhost:$port")
+                .build()
+                .get()
+                .uri("/swagger-ui/index.html")
+                .accept(MediaType.TEXT_HTML)
+                .exchange()
+                .expectStatus()
+                .isOk
+        }
     }
 
 }
diff --git a/src/test/resources/db/mysql_conf_override/my.cnf b/src/test/resources/db/mysql_conf_override/my.cnf

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+-- データベースを作成`
	`2`	`+CREATE DATABASE test`
	`3`	`+WITH ENCODING 'UTF8';`