Lib Banner Spring boot

Sobre a lib

Dependência dedicada a exibir um banner personalizado substituindo o banner original de aplicações SpringBoot

A lib oferece visualização de um banner com amostra de sua escolha, assim como também mostra informações básicas sobre o projeto durante sua inicialização.

• PORTA DO PROJETO
• NOME DO PROJETO
• PERFIL ATIVO
• NOME DA ORGANIZAÇÃO
• VERSÃO DO SPRINGBOOT
• VERSÃO DO PROJETO
• DESCRIÇÃO DO PROJETO

As informações acimas podem ser facilmente personalizadas, assim como também é possível contribuir adicionando novas informações.

Dependência

Altere seu arquivo settings.xml adaptando o modelo abaixo.

<settings xmlns="http://maven.apache.org/SETTINGS/1.1.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd">
  <activeProfiles>
    <activeProfile>github</activeProfile>
  </activeProfiles>
  <profiles>
    <profile>
      <id>github</id>
      <repositories>
        <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2</url>
        </repository>
        <repository>
          <id>github-null-cmd</id>
          <name>Github nuLL-cmd Apache Maven Packages</name>
          <url>https://maven.pkg.github.com/nuLL-cmd/banner-spring-custom</url>
          <snapshots>
            <enabled>true</enabled>
          </snapshots>
        </repository>
      </repositories>
    </profile>
  </profiles>
  <servers>
    <server>
      <id>github-null-cmd</id>
      <username>nuLL-cmd</username>
      <password>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</password>
    </server>
  </servers>
</settings>

Baixe o jar ou adicine a dependência em seu arquivo pom.xml

Link: Artifact

<dependency>
  <groupId>br.com.nuLLcmd</groupId>
  <artifactId>banner-spring-custom</artifactId>
  <version>1.0.2</version>
</dependency>

Utilização

Para que a dependência exiba os dados no console, é necessário que algumas informações sobre a aplicação estejam presentes no arquivo properties default do projeto.

Exemplo usando .yaml / .yml:

app:
 contextPath: '@project.artifactId@'
 version: '@project.version@'
 description: '@project.description@'
 organization: '@project.organization.name@'
 name: '@project.name@'

Exemplo usando .properties:

app.version=@project.version@
app.name=@project.name@
app.description=@project.description@
app.organization=@project.organization.name@    
app.context-path=@project.artifactId@

Após realizar tais configurações, basta setar o banner no método main da aplicação que a configuração default será aplicada:

@SpringBootApplication
public class ChickenApplication {

   public static void main(String[] args) {
       SpringApplication application = new SpringApplication(ChickenApplication.lass);
       application.setBanner(new CustomBanner());	
       application.run(args);
   }

}

Você pode também usar seu próprio banner personalizado usando o método setCustomBanner()

@SpringBootApplication
public class ChickenApplication {

   private static final String[] BANNER = {
       ",-----.   ,--." ,                              
       "|  |) /_  |  ,---.  ,--.,--. ,--.,--. ,--.,--.", 
       "|  .-.  | |  .-.  | |  ||  | |  ||  | |  ||  |", 
       "`------'  `--' `--'  `----'   `----'   `----' \n"
   };

   public static void main(String[] args) {
       CustomBanner customBanner = new CustomBanner();
       customBanner.setCustomBanner(BANNER);
       
       SpringApplication application = new SpringApplication(ChickenApplication.class);
       application.setBanner(customBanner);
       application.run(args);
   }


}

O resultado obtido no console do catalina será algo como a saída abaixo.

,-----.   ,--.
|  |) /_  |  ,---.  ,--.,--. ,--.,--. ,--.,--.
|  .-.  | |  .-.  | |  ||  | |  ||  | |  ||  |
`------'  `--' `--'  `----'   `----'   `----' 

:: PORTA PROJETO  :: 8086
:: PROJETO        :: chicken-api
:: PERFIL ATIVO   :: dev
:: ORGANIZAÇÃO    :: AutomatoDev
:: VERSÃO SPRING  :: 2.5.2
:: VERSÃO PROJETO :: 1.0.0-SNAPSHOT
:: DESCRIÇÃO      :: Projeto feito pensando em frangos

Thanks for reading!!