Open source

Migrate to Spring Boot 2.3

Recipe IDorg.openrewrite.java.spring.boot2.UpgradeSpringBoot_2_3

Artifactorg.openrewrite.recipe:rewrite-spring

Migrate applications to the latest Spring Boot 2.3 release. This recipe will modify an application's build files, make changes to deprecated/preferred APIs, and migrate configuration settings that have changes between versions. This recipe will also chain additional framework migrations (Spring Framework, Spring Data, etc) that are required as part of the migration to Spring Boot 2.3.

Composite recipeJavaspringbootModerne Source Available License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Definition

Preconditions1

• Singleton

Recipes15

• Migrate to Spring Boot 2.2
• Migrate to Spring Data 2.3
• Upgrade Gradle or Maven dependency versions
• Upgrade Gradle or Maven dependency versions
• Upgrade Maven plugin version
• Upgrade Maven parent project version
• Update a Gradle plugin by id
• Update Gradle wrapper
• Add spring-boot-starter-validation if needed
• Upgrade Gradle or Maven dependency versions
• Use RestClientBuilderCustomizer
• Use ErrorProperties#IncludeStacktrace.ON_PARAM
• Use ErrorAttributes#getErrorAttributes(WebRequest, ErrorAttributeOptions)
• Migrate Spring Boot properties to 2.3
• Upgrade MyBatis to Spring Boot 2.3

Examples

java, xml

Unchanged

project

java

Before

package org.springframework.samples.petclinic.vet;

import org.hibernate.validator.constraints.NotEmpty;

public class Vet {
    @NotEmpty
    private String lastName;
}

After

package org.springframework.samples.petclinic.vet;

import javax.validation.constraints.NotEmpty;

public class Vet {
    @NotEmpty
    private String lastName;
}

Diff

@@ -3,1 +3,1 @@
package org.springframework.samples.petclinic.vet;

-import org.hibernate.validator.constraints.NotEmpty;
+import javax.validation.constraints.NotEmpty;

xml

Before

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.springframework.samples</groupId>
  <artifactId>spring-petclinic</artifactId>
  <version>2.2.13.RELEASE</version>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.13.RELEASE</version>
  </parent>
  <name>petclinic</name>

  <properties>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
  </dependencies>
</project>

After

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.springframework.samples</groupId>
  <artifactId>spring-petclinic</artifactId>
  <version>2.2.13.RELEASE</version>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.12.RELEASE</version>
  </parent>
  <name>petclinic</name>

  <properties>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>javax.validation</groupId>
      <artifactId>validation-api</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
  </dependencies>
</project>

Diff

--- pom.xml
+++ pom.xml
@@ -10,1 +10,1 @@
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
-   <version>2.2.13.RELEASE</version>
+   <version>2.3.12.RELEASE</version>
  </parent>
@@ -20,0 +20,4 @@
  <dependencies>
    <dependency>
+     <groupId>javax.validation</groupId>
+     <artifactId>validation-api</artifactId>
+   </dependency>
+   <dependency>
      <groupId>org.springframework.boot</groupId>

java, xml

Unchanged

project

java

Before

package org.springframework.samples.petclinic.vet;

import org.hibernate.validator.constraints.NotEmpty;

public class Vet {
    @NotEmpty
    private String lastName;
}

After

package org.springframework.samples.petclinic.vet;

import javax.validation.constraints.NotEmpty;

public class Vet {
    @NotEmpty
    private String lastName;
}

Diff

@@ -3,1 +3,1 @@
package org.springframework.samples.petclinic.vet;

-import org.hibernate.validator.constraints.NotEmpty;
+import javax.validation.constraints.NotEmpty;

xml

Before

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.springframework.samples</groupId>
  <artifactId>spring-petclinic</artifactId>
  <version>2.2.13.RELEASE</version>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.13.RELEASE</version>
  </parent>
  <name>petclinic</name>

  <properties>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
  </dependencies>
</project>

After

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.springframework.samples</groupId>
  <artifactId>spring-petclinic</artifactId>
  <version>2.2.13.RELEASE</version>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.12.RELEASE</version>
  </parent>
  <name>petclinic</name>

  <properties>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>javax.validation</groupId>
      <artifactId>validation-api</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
  </dependencies>
</project>

Diff

--- pom.xml
+++ pom.xml
@@ -10,1 +10,1 @@
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
-   <version>2.2.13.RELEASE</version>
+   <version>2.3.12.RELEASE</version>
  </parent>
@@ -20,0 +20,4 @@
  <dependencies>
    <dependency>
+     <groupId>javax.validation</groupId>
+     <artifactId>validation-api</artifactId>
+   </dependency>
+   <dependency>
      <groupId>org.springframework.boot</groupId>

Usage

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe UpgradeSpringBoot_2_3

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-spring:6.33.0

Data tables

Maven metadata failures

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column	Description
Group id	The groupId of the artifact for which the metadata download failed.
Artifact id	The artifactId of the artifact for which the metadata download failed.
Version	The version of the artifact for which the metadata download failed.
Maven repository	The URL of the Maven repository that the metadata download failed on.
Snapshots	Does the repository support snapshots.
Releases	Does the repository support releases.
Failure	The reason the metadata download failed.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.