Utilisation d'OpenRewrite

Ouvrir dans ChatGPT

OpenRewrite est un projet open source conçu pour le refactoring automatisé de code source, permettant de migrer efficacement et automatiquement entre les versions de webforJ pour les projets utilisant des API obsolètes ou supprimées.

Quand utiliser OpenRewrite ?

Vous pouvez utiliser OpenRewrite lors de la mise à niveau pour vous éloigner des API obsolètes, pas seulement lors des versions majeures. Cela vous aide à vous éloigner des nouvelles méthodes obsolètes, avant qu'elles ne soient supprimées dans une version ultérieure.

Configuration

Pour mettre à niveau votre projet avec OpenRewrite, ajoutez le plugin Maven OpenRewrite à votre pom.xml, avec webforj-rewrite comme dépendance :

<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>

Remplacez TARGET_VERSION par la version de webforJ vers laquelle vous mettez à niveau et RECIPE_NAME par l'une des recettes de la section Recettes disponibles de cet article.

Prévisualisation des changements (optionnelle)

Si vous préférez prévisualiser les changements que OpenRewrite appliquera avec une recette webforJ, l'exécution de la commande suivante génère un diff dans target/rewrite/rewrite.patch sans modifier aucun fichier. Examinez le patch pour voir exactement ce que la recette changera.

mvn rewrite:dryRun

Exécution d'OpenRewrite

Lorsque vous êtes prêt à appliquer les changements avec OpenRewrite, exécutez la commande suivante :

mvn rewrite:run

La recette gère la majorité de la mise à niveau automatiquement en mettant à jour les dépendances, en renommant les méthodes, en changeant les types et en ajustant les types de retour. Pour les quelques cas où un remplacement 1:1 n'existe pas, elle ajoute des commentaires TODO dans votre code avec des instructions spécifiques. Recherchez ces TODO dans votre projet pour trouver ce qui reste à faire.

Nettoyage

Après avoir exécuté OpenRewrite avec une recette webforJ et résolu tous les commentaires TODO, retirez le plugin de votre pom.xml.

Recettes disponibles

Version	Projets standard webforJ	Projets Spring Boot
v26	com.webforj.rewrite.v26.UpgradeWebforj	com.webforj.rewrite.v26.UpgradeWebforjSpring