Migrate to Spring Boot 3 from Spring Boot 2
In this tutorial, we'll use OpenRewrite to perform an automated migration from Spring Boot 2.x to Spring Boot 3.
The Spring 3 migration recipe can be applied by adding OpenRewrite's plugin to your project and adding a dependency on rewrite-spring:
Maven
Gradle
Maven Command Line
pom.xml
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.46.0</version>
<configuration>
<activeRecipes>
<recipe>org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_0</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-spring</artifactId>
<version>4.36.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
build.gradle
plugins {
id("java")
id("org.openrewrite.rewrite") version("5.40.0")
}
rewrite {
activeRecipe("org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_0")
}
repositories {
mavenCentral() // rewrite-spring is published to Maven Central
}
dependencies {
rewrite(platform("org.openrewrite.recipe:rewrite-recipe-bom:1.19.0"))
rewrite("org.openrewrite.recipe:rewrite-migrate-java")
// Other project dependencies
}
shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
-Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-spring:LATEST \
-Drewrite.activeRecipes=org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_0
At this point, you're ready to execute the migration by running
mvn rewrite:run or gradlew rewriteRun. After running the migration, you can inspect the results by running git diff. As with all recipes, please take some time to look over the results and fix anything that wasn't able to be migrated automatically. Once you're confident in the changes, you can then commit the results.package org.openrewrite.example;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.MappedSuperclass;
import org.springframework.beans.factory.annotation.Autowired;
public class OwnerController {
...
@Autowired
public OwnerController(OwnerRepository clinicService) {
this.owners = clinicService;
}
@RequestMapping(value = "/owners/what")
public String getWhat() {
return "multipe method types omg";
}
@ModelAttribute("owner")
public Owner findOwner(@PathVariable("ownerId") int ownerId) {
return this.owners.findById(ownerId);
}
@RequestMapping(value = "/owners/{ownerId}/edit", method = POST)
public String processUpdateOwnerForm(@Valid Owner owner, BindingResult result, @PathVariable("ownerId") int ownerId) {
if (result.hasErrors()) {
return VIEWS_OWNER_CREATE_OR_UPDATE_FORM;
} else {
owner.setId(ownerId);
this.owners.save(owner);
return "redirect:/owners/{ownerId}";
}
}
}
package org.openrewrite.example;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.MappedSuperclass
public class OwnerController {
...
public OwnerController(OwnerRepository clinicService) {
this.owners = clinicService;
}
@GetMapping("/owners/what")
public String getWhat() {
return "multipe method types omg";
}
@ModelAttribute("owner")
public Owner findOwner(@PathVariable int ownerId) {
return this.owners.findById(ownerId);
}
@PostMapping("/owners/{ownerId}/edit")
public String processUpdateOwnerForm(@Valid Owner owner, BindingResult result, @PathVariable int ownerId) {
if (result.hasErrors()) {
return VIEWS_OWNER_CREATE_OR_UPDATE_FORM;
} else {
owner.setId(ownerId);
this.owners.save(owner);
return "redirect:/owners/{ownerId}";
}
}
}
package org.openrewrite.example;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.test.context.junit4.SpringRunner;
...
@RunWith(SpringRunner.class)
@WebMvcTest(OwnerController.class)
public class OwnerControllerTests {
@Before
public void setup() {
...
}
@Test
public void testInitCreationForm() throws Exception {
...
}
}
package org.openrewrite.example;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
...
@WebMvcTest(OwnerController.class)
class OwnerControllerTests {
@BeforeEach
void setup() {
...
}
@Test
void testInitCreationForm() throws Exception {
...
}
}
spring.datasource.schema=classpath*:db/${database}/schema.sql
spring.datasource.data=classpath*:db/${database}/data.sql
management.contextPath=/manage
spring.sql.init.schema-locations=classpath*:db/${database}/schema.sql
spring.sql.init.data-locations=classpath*:db/${database}/data.sql
management.server.base-path=/manage
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.18.RELEASE</version>
</parent>
<properties>
<java.version>11</java.version>
<wro4j.version>1.9.0</wro4j.version>
<thymeleaf.version>3.0.15.RELEASE</thymeleaf.version>
</properties>
<dependencies>
<dependency>
<groupId>jakarta.inject</groupId>
<artifactId>jakarta.inject-api</artifactId>
<version>1.0.3</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
</dependencies>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.0.7</version>
</parent>
<properties>
<java.version>17</java.version>
<wro4j.version>1.10.1</wro4j.version>
</properties>
<dependencies>
<dependency>
<groupId>jakarta.inject</groupId>
<artifactId>jakarta.inject-api</artifactId>
<version>2.0.1.MR</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
<version>3.0.7</version>
</dependency>
</dependencies>