Saltar al contenido principal

Usando OpenRewrite

Abrir en ChatGPT

OpenRewrite es un proyecto de código abierto diseñado para la refactorización automatizada de código fuente, permitiéndote migrar de manera eficiente y automática entre versiones de webforJ para proyectos que utilizan APIs obsoletas o eliminadas.

¿Cuándo usar OpenRewrite?​

Puedes usar OpenRewrite al actualizar para alejarte de APIs obsoletas, no solo en lanzamientos importantes. Esto te ayuda a desacoplarte de métodos recién obsoletos, antes de que sean eliminados en una versión posterior.

Configuración​

Para actualizar tu proyecto con OpenRewrite, agrega el complemento Maven de OpenRewrite a tu pom.xml, con webforj-rewrite como una dependencia:

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

Reemplaza TARGET_VERSION con la versión de webforJ a la que estás actualizando y RECIPE_NAME con una de las recetas de la sección Recetas disponibles de este artículo.

Previsualización de cambios (opcional)​

Si prefieres previsualizar qué cambios realizará OpenRewrite con una receta de webforJ, ejecutar el siguiente comando genera un diff en target/rewrite/rewrite.patch sin modificar ningún archivo. Revisa el parche para ver exactamente qué cambiará la receta.

mvn rewrite:dryRun

Ejecutando OpenRewrite​

Cuando estés listo para aplicar los cambios con OpenRewrite, ejecuta el siguiente comando:

mvn rewrite:run

La receta maneja la mayoría de la actualización automáticamente actualizando dependencias, renombrando métodos, cambiando tipos y ajustando tipos de retorno. Para los pocos casos donde no existe un reemplazo 1:1, agrega comentarios TODO en tu código con instrucciones específicas. Busca en tu proyecto estos TODOs para encontrar lo que queda por hacer.

Limpieza​

Después de ejecutar OpenRewrite con una receta de webforJ y resolver cualquier comentario TODO, elimina el complemento de tu pom.xml.

Recetas disponibles​

VersiónProyectos estándar de webforJProyectos de Spring Boot
v26.01com.webforj.rewrite.v26.UpgradeWebforj_26_01com.webforj.rewrite.v26.UpgradeWebforjSpring_26_01
v26com.webforj.rewrite.v26.UpgradeWebforjcom.webforj.rewrite.v26.UpgradeWebforjSpring