Migrate to Java 17
org.openrewrite.java.migrate.UpgradeToJava17
This recipe will apply changes commonly needed when migrating to Java 17. Specifically, for those applications that are built on Java 8, this recipe will update and add dependencies on J2EE libraries that are no longer directly bundled with the JDK. This recipe will also replace deprecated API with equivalents when there is a clear migration strategy. Build files will also be updated to use Java 17 as the target/source and plugins will be also be upgraded to versions that are compatible with Java 17.
Tags
- java17
Recipe source
GitHub, Issue Tracker, Maven Central
This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.
License
This recipe is available under the Moderne Source Available License.
Definition
- Recipe List
- Yaml Recipe List
- Migrate to Java 11
- Upgrade build to Java 17
- Changes code to use Java 17's
instanceof
pattern matching - Add
@Serial
annotation toserialVersionUID
- Remove
Runtime.traceInstructions(boolean)
andRuntime.traceMethodCalls
methods - Change
javax.tools.ToolProvider
methods calls to static - Change
java.lang.reflect.Modifier
andjava.lang.invoke.ConstantBootstraps
method calls to static - Add explicit import for
Record
classes - Use text blocks
- convertStringsWithoutNewlines:
false
- convertStringsWithoutNewlines:
- Prefer
String.formatted(Object...)
- addParentheses:
false
- addParentheses:
- Use
java.security.cert
instead ofjavax.security.cert
- Adopt
setLongThreadID
injava.util.logging.LogRecord
- Use
SunJSSE
instead ofcom.sun.net.ssl.internal.ssl.Provider
- Set visibility of
premain
andagentmain
methods topublic
- Remove
Thread.countStackFrames()
method - Replace
finalize
method injava.util.zip.ZipFile
,java.util.zip.Inflater
andjava.util.zip.Deflater
- Replace
SSLSession.getPeerCertificateChain()
method - Replace
com.sun.net.ssl
package - Replace
RMIConnectorServer.CREDENTIAL_TYPES
constant - Replace
finalize
method injava.io.FileInputStream
andjava.io.FileOutputStream
- Upgrade plugins to Java 17 compatible versions
- Upgrade Gradle or Maven dependency versions
- groupId:
com.google.inject
- artifactId:
guice
- newVersion:
5.x
- groupId:
- Upgrade Gradle or Maven dependency versions
- groupId:
commons-codec
- artifactId:
commons-codec
- newVersion:
1.17.x
- groupId:
- Add
lombok-mapstruct-binding
when both MapStruct and Lombok are used
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpgradeToJava17
displayName: Migrate to Java 17
description: This recipe will apply changes commonly needed when migrating to Java 17. Specifically, for those applications that are built on Java 8, this recipe will update and add dependencies on J2EE libraries that are no longer directly bundled with the JDK. This recipe will also replace deprecated API with equivalents when there is a clear migration strategy. Build files will also be updated to use Java 17 as the target/source and plugins will be also be upgraded to versions that are compatible with Java 17.
tags:
- java17
recipeList:
- org.openrewrite.java.migrate.Java8toJava11
- org.openrewrite.java.migrate.UpgradeBuildToJava17
- org.openrewrite.staticanalysis.InstanceOfPatternMatch
- org.openrewrite.staticanalysis.AddSerialAnnotationToSerialVersionUID
- org.openrewrite.java.migrate.RemovedRuntimeTraceMethods
- org.openrewrite.java.migrate.RemovedToolProviderConstructor
- org.openrewrite.java.migrate.RemovedModifierAndConstantBootstrapsConstructors
- org.openrewrite.java.migrate.lang.ExplicitRecordImport
- org.openrewrite.java.migrate.lang.UseTextBlocks:
convertStringsWithoutNewlines: false
- org.openrewrite.java.migrate.lang.StringFormatted:
addParentheses: false
- org.openrewrite.java.migrate.DeprecatedJavaxSecurityCert
- org.openrewrite.java.migrate.DeprecatedLogRecordThreadID
- org.openrewrite.java.migrate.RemovedLegacySunJSSEProviderName
- org.openrewrite.java.migrate.Jre17AgentMainPreMainPublic
- org.openrewrite.java.migrate.DeprecatedCountStackFramesMethod
- org.openrewrite.java.migrate.RemovedZipFinalizeMethods
- org.openrewrite.java.migrate.RemovedSSLSessionGetPeerCertificateChainMethodImpl
- org.openrewrite.java.migrate.SunNetSslPackageUnavailable
- org.openrewrite.java.migrate.RemovedRMIConnectorServerCredentialTypesConstant
- org.openrewrite.java.migrate.RemovedFileIOFinalizeMethods
- org.openrewrite.java.migrate.UpgradePluginsForJava17
- org.openrewrite.java.dependencies.UpgradeDependencyVersion:
groupId: com.google.inject
artifactId: guice
newVersion: 5.x
- org.openrewrite.java.dependencies.UpgradeDependencyVersion:
groupId: commons-codec
artifactId: commons-codec
newVersion: 1.17.x
- org.openrewrite.java.migrate.AddLombokMapstructBinding
Usage
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-migrate-java
in your build file or by running a shell command (in which case no build changes are needed):
- Gradle
- Gradle init script
- Maven POM
- Maven Command Line
- Moderne CLI
- Add the following to your
build.gradle
file:
plugins {
id("org.openrewrite.rewrite") version("6.29.0")
}
rewrite {
activeRecipe("org.openrewrite.java.migrate.UpgradeToJava17")
setExportDatatables(true)
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.31.0")
}
- Run
gradle rewriteRun
to run the recipe.
- Create a file named
init.gradle
in the root of your project.
initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath("org.openrewrite:plugin:6.29.0") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.31.0")
}
rewrite {
activeRecipe("org.openrewrite.java.migrate.UpgradeToJava17")
setExportDatatables(true)
}
afterEvaluate {
if (repositories.isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
- Run the recipe.
gradle --init-script init.gradle rewriteRun
- Add the following to your
pom.xml
file:
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.47.0</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>org.openrewrite.java.migrate.UpgradeToJava17</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-migrate-java</artifactId>
<version>2.31.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- Run
mvn rewrite:run
to run the recipe.
You will need to have Maven installed on your machine before you can run the following command.
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-migrate-java:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.migrate.UpgradeToJava17 -Drewrite.exportDatatables=true
You will need to have configured the Moderne CLI on your machine before you can run the following command.
mod run . --recipe UpgradeToJava17
If the recipe is not available locally, then you can install it using:
mod config recipes jar install org.openrewrite.recipe:rewrite-migrate-java:2.31.0
See how this recipe works across multiple open-source repositories
Run this recipe on OSS repos at scale with the Moderne SaaS.
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Data Tables
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | 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 errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | 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 Name | 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 | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |
Contributors
Chuka Obinabo, Anu Ramamoorthy, Sam Snyder, BhavanaPidapa, Jonathan Schneider, Tim te Beek, traceyyoshima, Tim te Beek, Knut Wannheden, Jonathan Schnéider, Tyler Van Gorder, Yifeng Jin, Adam Slaski, Aaron Gershman, Daryl Robbins, Patrick, Tim te Beek, Aaron Gershman, Michael Keppler, Kun Li, Aakarshit Uppal, BramliAK, eocantu, Shannon Pamperl, Laurens Westerlaken, Tracey Yoshima, Kun Li, Josh Soref