Como siguiente evolución del framework FundeWebJS, se ha desarrollado un proyecto que actuará de parent maven para todas nuestras APIs.
Además, se ha desarrollado una librería starter para incluir dependencias y configuraciones comunes.
Está página es una guía para la migración de aplicaciones Spring-Boot al parent FundeWebJS .
Con esto se consigue simplificar la configuración de los proyectos y centralizar el versionado de las librerías de Spring-Boot.
Guía detallada
El parent de FundeWebJS se ha desarrollado con la versión de Spring-Boot 2.7.10.
A continuación se detallan los pasos a realizar para completar la migración:
1. Fichero pom.xml
Sustituir la etiqueta <parent> completa por:
<parent> <groupId>es.um.atica</groupId> <artifactId>fundewebjs-api-parent</artifactId> <version>1.0.2</version> <relativePath>../pom.xml</relativePath> </parent>
En la etiqueta groupId de la aplicación, añadir "fundewebjs" a "<groupId>es.um.atica</groupId>". Por ejemplo, para la aplicación api-base quedaría:
<groupId>es.um.atica.fundewebjs</groupId> <artifactId>api-base</artifactId>
En la etiqueta <properties> dejar las siguientes:
<properties> <java.version>11</java.version> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> </properties>
Si la aplicación tenía otras propiedades configuradas, habrá que valorar si siguen siendo necesarias teniendo en cuenta que la mayoría de las dependencias y versiones están fijadas por la librería fundewebjs-spring-boot-starter .
Se recomienda quitarlas todas e ir añadiendo posteriormente solo las necesarias cuando se traten las dependencias en el apartado e .
NUNCA deben configurarse las propiedades de versiones de spring-boot o spring-cloud . Si existe la etiqueta <dependencyManagement> sustituir por el siguiente código. Si no existe, añadirla:
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>${spring-boot.version}</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
Como se ha mencionado en el apartado anterior, la mayoría de dependencias necesarias vienen ya incluidas con fundewebjs-spring-boot-starter.
Si nuestro pom.xml incluía en dependencyManagement la dependencia bom de spring-cloud (spring-cloud-dependencies), se recomienda eliminarla y terminar la configuración del pom.xml.
Si finalmente fuera necesario, se puede incluir el bom de spring-cloud dentro de dependencyManagement exactamente así:<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>${spring-cloud.version}</version> <type>pom</type> <scope>import</scope> </dependency>En la etiqueta <dependencies> la mayoría de las dependencias ya no van a ser necesarias.
Se recomienda copiar todas las dependencias a un fichero .txt aparte y sustituir toda la etiqueta por:<dependencies> <dependency> <groupId>es.um.atica</groupId> <artifactId>fundewebjs-spring-boot-starter</artifactId> </dependency> </dependencies>
Esta dependencia fundewebjs-spring-boot-starter engloba todas las librerías necesarias para trabajar con una aplicación FundeWebJS estándar.
Con la vista Dependency Hierarchy (o con Effective pom) del fichero pom.xml podemos tener una visión global de todas las librerías importadas por fundewebjs-spring-boot-starter y comparar con las que teníamos configuradas.
Después de este cambio se aconseja realizar un maven update project con force.
Si hay errores en el código, se recomienda revisar el fichero .txt con las dependencias antiguas y añadir la que sea necesaria.Este es el apartado más complicado de la migración, en caso de dudas sobre las librerías poner Jira a DJ-AT-MNCS como se indica al final de esta guía.
En la etiqueta <build> configurar los siguientes plugins:
<build> <plugins> <plugin> <groupId>org.hibernate.orm.tooling</groupId> <artifactId>hibernate-enhance-maven-plugin</artifactId> </plugin> <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> </plugin> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build>
Si el plugin para generar clientes SOAP estaba configurado, <groupId>org.jvnet.jaxb2.maven2</groupId> <artifactId>maven-jaxb2-plugin</artifactId>, hay que mantenerlo configurado tal cuál estaba.
En la etiqueta <repositories> configurar el repositorio de archiva de fundewebjs:
<repositories> <repository> <id>fundewebjs-archiva</id> <name>ATICA - UMU Repository - FundeWebJS</name> <url>https://archiva.um.es/archiva/repository/FundeWebJS/</url> </repository> </repositories>
Una vez realizados estos pasos, realizar un maven update project con la casilla Force Update of Snapshots/Releases marcada.
Ejemplo de pom.xml migrado:
2. Clase Application.
La clase application es la clase principal de nuestro proyecto, contiene el método main que se ejecuta al arrancar la aplicación y tiene la anotación @SpringBootApplication.
Habitualmente se encuentra en el paquete raíz de la aplicación.
De cara la migración hay que realizar la siguiente configuración:
a. En caso de no estar configurado ya, añadir el paquete "es.um.atica.fundewebjs" al parámetro scanBasePackages de la anotación @SpringBootApplication. :
@SpringBootApplication( scanBasePackages = {
"es.um.atica.MIPAQUETE", "es.um.atica.fundewebjs"
} )
public class MIAPLICACIONApiApplication
3. Configuración CORS.
Si tenemos una clase CorsConfig o un método CorsConfigurationSource corsConfigurationSource() en una clase con @Configuration con el siguiente contenido:
CorsConfigurationSource corsConfigurationSource() {
final CorsConfiguration configuration = new CorsConfiguration();
configuration.setAllowedOriginPatterns( Arrays.asList( "*" ) );
configuration.setAllowedMethods( Arrays.asList( "*" ) );
configuration.setAllowedHeaders( Arrays.asList( "*" ) );
configuration.setAllowCredentials( true );
final UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
source.registerCorsConfiguration( "/**", configuration );
return source;
}
a. Hay que eliminar la clase CorsConfig o el método corsConfigurationSource. (lo que exista).
Esta configuración, a partir de ahora, se realizará con la clase FundeWebJSCorsConfig de la librería fundewebjs-spring-boot-starter.
Si se quiere modificar la configuración por defecto, puede mantenerse en el proyecto y poner en el application.properties la propiedad: fdwjs.starter.cors.enable=false.
4. Configuración Security.
Si tenemos una clase SecurityConfig con la siguiente configuración:
################# Para versiones de Spring-Boot anteriores a 2.7
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Value( "${server.scopes}" )
private String[] serverScopes;
@Value( "${app.server.path}" )
private String apiPath;
@Bean
public FundeWebJSLoggingAuthorizationFilter loggingFilterBean() {
return new FundeWebJSLoggingAuthorizationFilter();
}
@Override
protected void configure( HttpSecurity http ) throws Exception {
http.requestMatchers().antMatchers( "/public/**" ).and().requestMatchers().antMatchers( apiPath + "/**" ).and()
.sessionManagement().sessionCreationPolicy( SessionCreationPolicy.STATELESS )
// configuro politica de sesion sin estado
.and().cors() // Aniado configuracion CORS por defecto
.and().csrf().disable().authorizeRequests().mvcMatchers( apiPath + "/public/**" ).permitAll()
.mvcMatchers( apiPath + "/**" ).hasAnyAuthority( serverScopes ).anyRequest().authenticated().and()
.addFilterAfter( loggingFilterBean(), BearerTokenAuthenticationFilter.class )
.oauth2ResourceServer().jwt();
}
}
############### O bien:
############### En versiones de Spring-Boot 2.7.X
public class SecurityConfig {
@Value( "${server.scopes}" )
private String[] serverScopes;
@Value( "${app.server.path}" )
private String apiPath;
@Bean
public FundeWebJSLoggingAuthorizationFilter loggingFilterBean() {
return new FundeWebJSLoggingAuthorizationFilter();
}
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http.requestMatchers().antMatchers( "/public/**" ).and().requestMatchers().antMatchers( apiPath + "/**" ).and()
.sessionManagement().sessionCreationPolicy( SessionCreationPolicy.STATELESS )
// configuro politica de sesion sin estado
.and().cors() // Aniado configuracion CORS por defecto
.and().csrf().disable().authorizeRequests().mvcMatchers( apiPath + "/public/**" ).permitAll()
.mvcMatchers( apiPath + "/**" ).hasAnyAuthority( serverScopes ).anyRequest().authenticated().and()
.addFilterAfter( loggingFilterBean(), BearerTokenAuthenticationFilter.class )
.oauth2ResourceServer().jwt();
return http.build();
}
}
a. Hay que eliminar dicha clase SecurityConfig.
La configuración de seguridad estándar se realizará, a partir de ahora, en la clase FundeWebJSSecurityConfig incluida en la librería fundewebjs-spring-boot-starter.
Si la configuración actual es diferente por que se validan otros paths, otros claims, se ha configurado el loa, se ha modificado el tratamiento de excepciones, etc., se recomienda mantener el archivo SecurityConfig y establecer en el application.properties (de local y del repo de Helm Chart), la property: fdwjs.starter.security.enable=false.
Este es un punto importante. Ante cualquier duda ponga Jira como se indica al final de esta página.
5. application.properties local
En el fichero application.properties local hay que añadir, si no estaban ya incluidas, las propiedades:
fdwjs.api.lagar.enable=true fdwjs.api.lagar.headers=UMU-User-UUID,UMU-Client-APP
6. ForwardedHeaderFilter
Si la aplicación tiene un @Bean ForwardedHeaderFilter declarado, eliminarlo.
7. Pruebas
Una vez realizados todos los cambios, hay que comprobar:
- que la aplicación despliega en local correctamente.
- que los tests se siguen pasando con normalidad.
- probar que los endpoints siguen funcionando, con el foco en la correcta securización con los tokens oauth.
- mergear a desarrollo y comprobar que la imagen nueva ha desplegado y que todo funciona correctamente.
Cambios Spring-Boot 2.7.X
Como se ha mencionado anteriormente, el parent FundeWebJS se ha desarrollado con la versión de Spring-Boot 2.7.10.
Si nuestro proyecto estaba desarrollado con versiones anteriores de Spring-Boot, es posible que haya que realizar modificaciones en nuestro código para adaptarlo a 2.7.10.
En la sección de Referencias se dejan enlaces a las guías de migración de cada versión de Spring-Boot.
Algunos cambios conocidos en aplicaciones existentes:
- SecurityConfig: La clase WebSecurityConfigurerAdapter está deprecada. Hay que eliminarla y crear la configuración con SecurityFilterChain.
Junit: La versión de Junit se ha actualizado de 4 a 5. Algunas clases empleadas en los tests pueden haberse modificado. Se pueden buscar las equivalentes en Junit 5 o seguir manteniendo Junit 4 con:
<dependency>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.hamcrest</groupId>
<artifactId>hamcrest-core</artifactId>
</exclusion>
</exclusions>
</dependency>
@EntityScan ahora soporta el atributo basePackages para especificar el escaneado de entidades en diferentes paquetes.
... esta lista se irá incrementando conforme se vayan descubriendo modificaciones....
Ver la sección de Referencias para ampliar información.
Dudas y soporte
Si se tiene alguna duda o problema siguiendo esta página, poner Jira a:
- Proyecto: DJ-AT-MNCS
- Responsable: Sin asignar.
- Título: Soporte migración a parent FundeWebJS
- Texto: Descripción del problema/duda
Referencias
- https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.3-Release-Notes
- https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.4-Release-Notes
- https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.5-Release-Notes
- https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.6-Release-Notes
- https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.7-Release-Notes
No hay ningún contenido con las etiquetas especificadas
Crear una rama git local nueva para realizar los cambios de la migración.