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

• groupId: org.openrewrite.recipe

• artifactId: rewrite-migrate-java

• version: 2.12.0

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.

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-migrate-java:2.12.0 in your build file or by running a shell command (in which case no build changes are needed):

Gradle

1. Add the following to your build.gradle file:

build.gradle

plugins {
    id("org.openrewrite.rewrite") version("6.12.0")
}

rewrite {
    activeRecipe("org.openrewrite.java.migrate.UpgradeToJava17")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.12.0")
}

2. Run gradle rewriteRun to run the recipe.

Gradle init script

1. Create a file named init.gradle in the root of your project.

init.gradle

initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:6.12.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.12.0")
    }
    rewrite {
        activeRecipe("org.openrewrite.java.migrate.UpgradeToJava17")
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

2. Run gradle --init-script init.gradle rewriteRun to run the recipe.

Maven POM

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.java.migrate.UpgradeToJava17</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-migrate-java</artifactId>
            <version>2.12.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Maven Command Line

shell

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

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 UpgradeToJava17

Definition

Recipe List

• Migrate to Java 11

• Change Maven Java version property values to 17

• Prefer String.formatted(Object...)

• Upgrade actions/setup-java java-version

  • minimumJavaMajorVersion: 17

• Changes code to use Java 17's instanceof pattern matching

• Remove methods calls

  • methodPattern: java.lang.Runtime traceInstructions(boolean)

• Remove methods calls

  • methodPattern: java.lang.System traceMethodCalls(boolean)

• Use text blocks

  • convertStringsWithoutNewlines: true

• Use java.security.cert instead of javax.security.cert

• Adopt setLongThreadID in java.util.logging.LogRecord

• Use SunJSSE instead of com.sun.net.ssl.internal.ssl.Provider

• Set visibility of premain and agentmain methods to public

• Upgrade Maven plugin version

  • groupId: org.apache.maven.plugins

  • artifactId: maven-checkstyle-plugin

  • newVersion: 3.x

• Upgrade Maven plugin version

  • groupId: com.sonatype.clm

  • artifactId: clm-maven-plugin

  • newVersion: 2.47.6-01

• Remove Thread.countStackFrames() method

• Replace finalize method in java.util.zip.Zipfile, java.util.zip.Inflater and java.util.zip.Deflater

• Replace SSLSession.getPeerCertificateChain() method

• Replace com.sun.net.ssl package

• Replace RMIConnectorServer.CREDENTIAL_TYPES constant

• Replace finalize method in java.io.FileInputStream and java.io.FileOutputStream

Yaml Recipe List

---
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.JavaVersion17
  - org.openrewrite.java.migrate.lang.StringFormatted
  - org.openrewrite.github.SetupJavaUpgradeJavaVersion:
      minimumJavaMajorVersion: 17
  - org.openrewrite.staticanalysis.InstanceOfPatternMatch
  - org.openrewrite.java.migrate.RemoveMethodInvocation:
      methodPattern: java.lang.Runtime traceInstructions(boolean)
  - org.openrewrite.java.migrate.RemoveMethodInvocation:
      methodPattern: java.lang.System traceMethodCalls(boolean)
  - org.openrewrite.java.migrate.lang.UseTextBlocks:
      convertStringsWithoutNewlines: true
  - org.openrewrite.java.migrate.DeprecatedJavaxSecurityCert
  - org.openrewrite.java.migrate.DeprecatedLogRecordThreadID
  - org.openrewrite.java.migrate.RemovedLegacySunJSSEProviderName
  - org.openrewrite.java.migrate.Jre17AgentMainPreMainPublic
  - org.openrewrite.maven.UpgradePluginVersion:
      groupId: org.apache.maven.plugins
      artifactId: maven-checkstyle-plugin
      newVersion: 3.x
  - org.openrewrite.maven.UpgradePluginVersion:
      groupId: com.sonatype.clm
      artifactId: clm-maven-plugin
      newVersion: 2.47.6-01
  - 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

See how this recipe works across multiple open-source repositories

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.

Contributors

Chuka Obinabo, Satvika Eda, Sam Snyder, Tim te Beek, Jonathan Schneider, traceyyoshima, Knut Wannheden, Tyler Van Gorder, Yifeng Jin, Adam Slaski, Aaron Gershman, Patrick, Daryl Robbins, Anu Ramamoorthy, Aaron Gershman, Tim te Beek, Tim te Beek, Jonathan Schnéider, Kun Li, Michael Keppler, Aakarshit Uppal, Shannon Pamperl, Tracey Yoshima, Josh Soref, Kun Li