Crea un Banner Personalizado en Spring Boot

/ Spring, Spring Boot / Por

Introducción

Por defecto, Spring Boot muestra un banner al iniciar la aplicación. Este banner es una representación en arte ASCII de la palabra “Spring”. Sin embargo, es posible reemplazarlo con un banner personalizado en arte ASCII que se adaptará a tus necesidades, ya sea para agregar un toque profesional a tu aplicación o simplemente por diversión. En este artículo, aprenderemos cómo crear y utilizar un banner personalizado utilizando arte ASCII en nuestras aplicaciones Spring Boot.

1. Overview

Spring Boot ofrece la capacidad de personalizar el banner que aparece al iniciar la aplicación. Esto permite a los desarrolladores no solo dar un toque distintivo a sus aplicaciones, sino también incluir información relevante, como el nombre del proyecto, la versión o incluso un mensaje de bienvenida. En este tutorial, exploraremos cómo crear un banner personalizado utilizando arte ASCII y cómo configurarlo para que se muestre en lugar del banner predeterminado.

2. Creando un Banner

Para comenzar, primero debemos crear nuestro arte ASCII. Podemos utilizar una combinación de caracteres como @, #, *, y 8 para desarrollar un logo o mensaje que represente nuestra aplicación. Un ejemplo de un simple arte ASCII que podrías usar es el siguiente:


@@@@@@   @@@@@@  @@@@@@@@@@@    
@@!  @@@ @@!  @@@ @@!  @@@@!    
!@!  !@! !@!  !@! !@!  !@!@!    
!!@!!@!  !!@!@!!  !!@!@!!@!!    
!!@!!!   !!@!!!   !@!!!@!!@

Ahora, guarda este arte en un archivo llamado banner.txt y colócalo en la carpeta raíz de los recursos (src/main/resources) para que Spring Boot pueda detectarlo automáticamente.

Ejemplo de Archivo banner.txt

Crea un archivo llamado banner.txt en la siguiente ubicación:


src/main/resources/banner.txt

Con el siguiente contenido:


@@@@@@   @@@@@@  @@@@@@@@@@@    
@@!  @@@ @@!  @@@ @@!  @@@@!    
!@!  !@! !@!  !@! !@!  !@!@!    
!!@!!@!  !!@!@!!  !!@!@!!@!!    
!!@!!!   !!@!!!   !@!!!@!!@

3. Uso del Banner Personalizado

Una vez que hemos creado y guardado nuestro archivo banner.txt, Spring Boot lo detectará automáticamente al iniciar la aplicación. Si ejecutas tu aplicación, deberías ver tu nuevo banner representado en arte ASCII.

Especificar una Ubicación o Nombre Diferente

Si deseas utilizar un nombre de archivo diferente o una ubicación distinta para el banner, puedes especificar la ubicación del banner en tu archivo application.properties. Aquí tienes un ejemplo de cómo hacerlo:


spring.banner.location=classpath:/path/to/banner/custombanner.txt

Asegúrate de colocar el archivo en la ruta especificada.

Soporte de Imágenes antes de Spring Boot 3.0.0 M2

Antes de la versión 3.0.0 M2 de Spring Boot, era posible utilizar banners en formatos de imagen como .gif, .png, o .jpg. Similar al archivo banner.txt, Spring Boot espera que estos archivos se nombren como banner.gif, banner.png, o banner.jpg. También podrías hacer referencia a una imagen personalizada utilizando la propiedad spring.banner.image.location de la siguiente manera:


spring.banner.image.location=classpath:banner.gif

Sin embargo, dada la complejidad que pueden traer las imágenes, se recomienda utilizar banners de texto, dado que los banners de imágenes pueden aumentar el tiempo de inicio de la aplicación dependiendo de la complejidad de la imagen utilizada.

Es importante destacar que, a partir de la versión 3.0.0 M2 de Spring Boot, los formatos de imagen ya no son soportados, dejando solo el formato de texto banner.txt como el único formato aceptado.

4. Consejos Prácticos

  • Mantén tu Banner Simple: Intenta no utilizar caracteres demasiado complejos o múltiples colores, ya que pueden dificultar la legibilidad del banner en consola.
  • Incluye Información Relevante: Considera incluir el nombre de la aplicación, la versión y un mensaje de bienvenida para que sea más informativo.
  • Prueba la Visibilidad: Asegúrate de que el banner se vea bien en diferentes plataformas y que la comparación visual sea adecuada tanto en entornos de desarrollo como en producción.
  • Actualiza el Banner: Si añades nuevas funcionalidades o actualizas la aplicación, no dudes en modificar el banner para reflejar esos cambios.

Conclusión

En este artículo, hemos aprendido cómo crear y utilizar un banner personalizado en nuestras aplicaciones Spring Boot utilizando arte ASCII. Esta personalización puede darle un toque único a tus aplicaciones y mejorar la experiencia del usuario. A medida que continúes trabajando con Spring Boot, ten en cuenta la importancia de la personalización y la atención al detalle en cada aspecto de tu aplicación, ¡incluso en algo tan simple como un banner!

Explora la documentación de Spring Boot para obtener más información sobre las características que puedes utilizar en tus proyectos. La personalización no solo mejora tu experiencia como desarrollador, sino que también puede mejorar la percepción de los usuarios sobre tu aplicación.