Spring Boot Banner là gì? Tùy chỉnh file banner.txt

Spring Boot Banner là gì? Tùy chỉnh file banner.txt

1. Spring Boot Banner là gì

Spring Boot banner là banner được in khi ứng dụng được start. Mặc định banner sẽ là:

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::            (v2.0.0.RC1)

– Chúng ta có thể thay đổi banner được in ra bằng cách thêm file banner.txt với thông tin cần in ra vào classpath (src/main/resource) hoặc chỉ rõ đường dẫn file banner bằng tham số spring.banner.location trong file application.properties.

– Ngoài sử dụng file text, chúng ta cũng có thể thêm file image như banner.gif, banner.jpg hoặc banner.png vào classpath hoặc chỉ rõ bằng tham số spring.banner.image.location trong file applicaton.properties. Image sẽ được chuyển thành mã ASCII và được in ra giống text.

– Các biến trong file banner (banner variable)

${application.version}: Số của version ứng dụng được khai báo trong MANIFEST.MF, ví dụ version Snap 1.0 sẽ được in ra là 1.0

${application.formatted-version}: Số của version ứng dụng được khai báo trong MANIFEST.MF và định đạng cho hiển thị.

${spring-boot.version}: Hiển thị Spring Boot version, ví dụ 2.0.0.RC1

${spring-boot.formatted-version}: Hiển thị Spring Boot version với định dạng cho hiển thị (ví dụ được bao quanh bởi dấu ngoặc và bắt đầu bằng chữ v: (v2.0.0.RC1 ))

${application.title}: Tilte của ứng dụng được khai báo trong MANIFEST.MF

– Để tắt không in ra banner ta làm như sau:

Cấu hình trong file YAML:

spring:
  main:
    banner-mode: "off"

Hoặc trong file code:

public static void main(String[] args) {
  SpringApplication app = new SpringApplication(MySpringConfiguration.class);
  app.setBannerMode(Banner.Mode.OFF);
  app.run(args);
}

2. Ví dụ tùy chỉnh Spring Boot banner

ví dụ mình sẽ sử dụng file my_banner.txt

                   +++                                                
                +++++++++                                             
            +++++++++++++++++                                         
         +++++++++++++++++++++++        +++++++++++           ++++    
      ++++++++++++++++++++++++++++++  +++         ++          ++++    
        +++++++++++++++++++++++++    ++++                     ++++    
       +   +++++++++++++++++++   +   ++++                     ++++    
      ++++++   +++++++++++    +++++    ++++++                 ++++    
          +++++   +++++   ++++++           +++++++            ++++    
      ++++   ++++++    +++++   ++++             +++++         ++++    
        +++++    ++++++++   ++++++                ++++        ++++    
       ++  ++++++   ++   +++++   ++               +++         ++++    
      ++++++   +++++ ++++++   +++++ +++++      +++++    +    ++++     
          +++++   +++++   ++++++        ++++++++         ++++++       
             ++++++    +++++                                          
                 ++++++++                                             
                    +                                                 

Demo Spring Boot Banner. Spring Boot${spring-boot.formatted-version} :: ${Ansi.DEFAULT}

Cấu hình trong file application.properties

spring.banner.location=my_banner.txt

Kết quả:

 

Spring Boot Banner là gì? Tùy chỉnh file banner.txt

Okay, Done!
Download code ví dụ trên tại đây.

 

References:

https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-banner