Migrar de Spring Boot 2.0 a Spring Boot 3.4

Spring Boot 3 es una mejora significativa, ya que nos introduce grandes mejoras en aspectos como el rendimiento o la seguridad. También trae cambios como el de paquetería entre javax y jakarta. Vamos a analizar las distintas partes del proceso de migración.

Usaremos comandos que nos pueden ahorrar horas de trabajo en cambios, para tratar de hacer la migración lo más sencilla posible. Además de unos pasos sencillos de seguir para poder abordar la migración de la forma más sencilla posible.

Prerrequisitos

Existen ciertos puntos que debemos abordar antes de empezar a migrar nuestra aplicación:

Java 17

Spring Boot 3 tiene como requisito mínimo Java 17, por tanto deberemos comenzar por subir la versión del JDK a esta como mínimo. Aunque es interesante acabar usando Java 21 junto a Spring Boot 3, ya que nos permitirá utilizar una sintaxis más variada además de poder utilizar los conocidos virtual threads.

Spring Boot 2.7

Lo siguiente que debemos hacer es subir a la última versión de Spring Boot 2, en este caso será la versión 2.7. También es aconsejable eliminar todas las dependencias que estén puestas explícitamente y que puedan ser manejadas de forma automática por Spring Boot.

Este paso puede resultar crítico dependiendo de las distintas dependencias de cada proyecto. Es aconsejable consultar las diferentes guías de migración que nos proporcione cada dependencia para poder abordarlo correctamente.

Normalmente se realiza este paso de forma manual, pero podéis utilizar los migradores automáticos. Os proporcionamos a continuación una lista de recetas de migración de algunas versiones:

Migrar a Spring Boot 2.0
Migrar a Spring Boot 2.1
Migrar a Spring Boot 2.2
Migrar a Spring Boot 2.3
Migrar a Spring Boot 2.4
Migrar a Spring Boot 2.5
Migrar a Spring Boot 2.6
Migrar a Spring Boot 2.7

Se utilice o no el migrador, recomendamos que se revise el listado de cambios de cada versión o la ayuda de migración en caso de existir, para poder ir mitigando los problemas de forma escalonada y sencilla.

En caso de que necesitéis otras recetas de interés para cambios en estas versiones, podéis consultar todas las recetas disponibles para Spring Boot 2 aquí.

Spring Security 6

El último prerrequisito necesario será actualizar la versión de Spring Security, en caso de estar utilizándolo en el proyecto. Esto se debe a que Spring Boot 3 no es compatible con la versión 5. Por suerte desde Spring nos proporcionan información sobre cómo prepararnos para la migración y cómo migrar a Spring Security 6. Lo primero que deberemos hacer es migrar a Spring Security 5.8 siguiendo la primera guía, ya que esta versión viene preparada para que la migración a la versión 6 sea más sencilla. Una vez realizado este paso, seguiremos lo especificado en el segundo enlace para finalizar esta migración.

Comprobar que esté todo listo para empezar

Antes de saltar a SpringBoot 3.0, comprueba que todo en tu aplicación funciona igual que funcionaba antes de subir a Spring Boot 2.7. También es importante revisar todos los “deprecated”, ya que esto puede dejar de existir en Spring Boot 3. Guarda también tus cambios con tu sistema de control de versiones, ya que esto te ayudará a poder volver atrás entre las distintas versiones, ya que seguramente vayas afrontando distintas dificultades.

Spring Boot 3.0

Estamos preparados para comenzar a migrar. Aquí utilizaremos el migrador de Open Rewrite. No obstante, existen otras alternativas:

Adicionalmente, si queréis hacer los cambios de esta versión a mano, existen la guía de migración en github y otro artículo de Baeldung que explica como realizarlo. Recomendamos lanzar el migrador automático de OpenRewrite y una vez finalice revisar ambas guías por si necesitamos realizar algún ajuste adicional.

Procederemos a lanzar la siguiente receta de OpenRewrite por terminal:

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-spring:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_0 -Drewrite.exportDatatables=true

Este proceso puede llevar un tiempo, ya que realizará bastantes cambios. Una vez finalice, seguramente nos encontraremos con errores de compilación. Los abordaremos posteriormente, pero primero debemos realizar otras comprobaciones.

Lo primero que debemos comprobar es que los cambios realizados con el migrador, especialmente en las dependencias, sean correctos. A continuación, detallamos algunos problemas que pueden ocurrir en la migración:

CXF: Esta dependencia tiene problemas en las versiones Jakarta 10. Estos problemas han sido solucionados recientemente en la versión 4.1 y posteriores.

Propiedades: Es interesante siempre lanzar el migrador de propiedades, ya que nos permitirá solucionar problemas con estas de forma automática

Spring Batch: Si utilizáis Spring Batch en vuestro proyecto, este ha sufrido bastantes cambios. Recomendamos seguir la guía de migración de Spring Batch para poder solucionar los problemas.

Otros problemas: El migrador soluciona los casos más comunes, pero es posible que cometa errores o que no sepa abordarlos correctamente. Normalmente dependen mucho del proyecto y de las librerías que uséis. La mejor forma de abordar esto es consultar las guías de migración generales o de esas dependencias en concreto. También os recomiendo este artículo de medium con algunos problemas.

Posteriormente seguiremos el siguiente proceso:

Revisar los cambios realizados por el automigrador, especialmente en las dependencias para ver que son correctos.
En caso de que no esté modificado el parent pom, modificarlo a la versión correspondiente de Spring Boot. Lo mismo aplica para el JDK
Solucionar los errores de compilación en el código de producción
Conseguir que la aplicación se pueda ejecutar (que arranque correctamente)
Solucionar los problemas de compilación en test
Comprobar que la aplicación funciona correctamente

Estos pasos son básicos pero imprescindibles. Debemos seguirlos en cada versión que vayamos subiendo.

Spring Boot 3.1

Recomendamos seguir utilizando la receta de migración de openrewrite, aunque como hemos comentado anteriormente existen otras opciones.

Aquí encontraremos otros problemas, algunos relacionados con aspectos que ya estaban deprecated o que no eran recomendables de la versión anterior. Aquí tenemos el listado de cambios de Springboot 3.1 para saber que debemos migrar.

Esta versión será más sencilla de subir que las anteriores, los problemas que puedan ocurrir dependen de las distintas dependencias que podáis tener. Mi recomendación personal es que si no lo habéis hecho en las versiones anteriores, eliminéis todas las versiones fijadas de las dependencias que ya son manejadas automáticamente por spring, para permitir que se vayan actualizando automáticamente a la versión adecuada. También es recomendable subir todas las dependencias que tengamos después de esto a las últimas versiones compatibles con nuestro software.

Spring Boot 3.2

Volveremos a aplicar la receta de migración. A partir de esta versión y las siguientes debería ser más sencillo. Si encontramos problemas serán muy específicos de nuestro caso y deberemos referirnos a las guías de migración correspondientes. Os dejo también la guía con los cambios.

Spring Boot 3.3

Os vuelvo a dejar la receta de migración y los cambios de la versión.

Spring Boot 3.4

De nuevo, os dejo la receta y los cambios.

Reflexion

Como podéis observar, la actualización a las versiones 3.3 y 3.4 debería ser relativamente sencilla para la mayoría de los proyectos. Este mismo enfoque gradual aplica también a las actualizaciones de las dependencias y de Spring en general. Mantener un ciclo de actualizaciones constante no solo simplifica futuras migraciones, sino que también asegura que tu proyecto se beneficie de las últimas mejoras en rendimiento, seguridad y funcionalidades. Ignorar este consejo podría llevarte a enfrentar desafíos similares en el futuro con otra guía de migración.

Conclusión

Migrar a Spring Boot 3.x, como hemos explorado, presenta desafíos iniciales, especialmente al cumplir con prerrequisitos como Java 17 y la actualización a Spring Boot 2.7. Sin embargo, herramientas como OpenRewrite simplifican significativamente el proceso para las actualizaciones incrementales posteriores. Es crucial recordar que cada aplicación es única; por lo tanto, revisa tu configuración específica y consulta las guías de migración de las librerías que utilices.

Haber completado esta migración es un gran paso. Para evitar futuras migraciones complejas, te recomendamos encarecidamente mantener tu aplicación actualizada con las últimas versiones estables. Esto no solo te facilitará futuras actualizaciones, sino que también te permitirá beneficiarte de las últimas mejoras en rendimiento y seguridad.

Si encuentras alguna cosa que podamos añadir para hacer la guía más completa hazmelo saber y lo añadiré al artículo.

Migrar de Spring Boot 2.0 a 3.4