Gebruik van OpenRewrite

Openen in ChatGPT

OpenRewrite is een open source project ontworpen voor geautomatiseerde broncode-refactoring, waarmee je efficiënt en automatisch kunt migreren tussen webforJ-versies voor projecten die verouderde of verwijderde API's gebruiken.

Wanneer OpenRewrite gebruiken?

Je kunt OpenRewrite gebruiken bij het upgraden om afstand te nemen van verouderde API's, niet alleen bij belangrijke releases. Dit helpt je om afstand te nemen van nieuw verouderde methoden, voordat ze in een latere versie worden verwijderd.

Setup

Om je project te upgraden met OpenRewrite, voeg je de OpenRewrite Maven-plugin toe aan je pom.xml, met webforj-rewrite als afhankelijkheid:

<plugin>
  <groupId>org.openrewrite.maven</groupId>
  <artifactId>rewrite-maven-plugin</artifactId>
  <version>6.36.0</version>
  <configuration>
    <activeRecipes>
      <recipe>RECIPE_NAME</recipe>
    </activeRecipes>
  </configuration>
  <dependencies>
    <dependency>
      <groupId>com.webforj</groupId>
      <artifactId>webforj-rewrite</artifactId>
      <version>TARGET_VERSION</version>
    </dependency>
  </dependencies>
</plugin>

Vervang TARGET_VERSION door de webforJ-versie waarnaar je upgrade en RECIPE_NAME door een van de recepten uit de Beschikbare recepten sectie van dit artikel.

Wijzigingen previewen (optioneel)

Als je liever wilt zien welke wijzigingen OpenRewrite zal doorvoeren met een webforJ-recept, genereert het uitvoeren van de volgende opdracht een diff in target/rewrite/rewrite.patch zonder enige bestanden te wijzigen. Bekijk de patch om precies te zien wat het recept zal wijzigen.

mvn rewrite:dryRun

OpenRewrite uitvoeren

Wanneer je klaar bent om wijzigingen toe te passen met OpenRewrite, voer je de volgende opdracht uit:

mvn rewrite:run

Het recept behandelt de meeste upgrades automatisch door afhankelijkheden bij te werken, methoden te hernoemen, types te wijzigen en returntypes aan te passen. Voor de weinige gevallen waarin een 1:1 vervanging niet bestaat, voegt het TODO-commentaar toe in je code met specifieke instructies. Zoek in je project naar deze TODOs om te zien wat er nog overblijft.

Opruimen

Verwijder na het uitvoeren van OpenRewrite met een webforJ-recept en het oplossen van eventuele TODO-commentaren de plugin uit je pom.xml.

Beschikbare recepten

Versie	Standaard webforJ-projecten	Spring Boot-projecten
v26.01	com.webforj.rewrite.v26.UpgradeWebforj_26_01	com.webforj.rewrite.v26.UpgradeWebforjSpring_26_01
v26	com.webforj.rewrite.v26.UpgradeWebforj	com.webforj.rewrite.v26.UpgradeWebforjSpring