[Spring Boot] Custom Banners

spring boot 기본 배너를 바꾸고 싶다면 어떻게 해야할까요?

1. Customizing the Banner file
2. Customizing the Banner image file
3. Banner Variables
4. ASNI Color

---

1. 배너파일 커스터마이징

Spring Boot의 default Banner는 우리에게 친숙한 Spring이라고 쓰여진 배너죠.

이 배너문구를 우리가 새로 지정해주고 싶다면, banner.txt 에 배너 문구를 작성해주면 됩니다.

resources 폴더 바로 아래가 default 경로입니다. (별도의 설정없이 읽을 수 있는 path)

만일, 배너파일 위치를 바꾸고 싶다면 프로퍼티의 spring.banner.location에 설정하면 됩니다.

banner.txt에 그려놓은 ASCII Art가 적용된 모습입니다.
text를 이용하여 ASCII Art로 변환해주는 사이트가 있으니,애플리케이션 명으로 배너를 꾸며봐요! [ 참고 ]

---

2. 이미지로 배너 커스터마이징

resources 폴더 바로 아래에 banner.jpg 또는 banner.png를 넣으면 자동으로 해당 이미지를 이용하여 배너를 만들어줍니다.

그런데, 배너 크기를 직접 정의할 수 없기 때문에 프로퍼티 파일에 가로 세로 길이를 정의해주는게 좋을것 같습니다.

spring:
  profiles:
    active: local   
  output:
    ansi:
      enabled: detect       
  banner:
    image:
      location: classpath:banner.jpg
      width: 30
      height: 14

저는 banner.jpg 이미지를 STS4 아이콘을 이용했습니다.

ㅎㅎㅎ 이렇게 banner.jpg 파일이 배너로 변환되었네요!

---

3. 배너 변수

배너에 Spring Boot 버전이나, 프로젝트명, 프로젝트 버전을 출력하고 싶다면 배너 변수를 이용하자!

일반 배너 변수

• ${spring-boot.version} : 애플리케이션의 Spring Boot 버전
• ${spring-boot.formatted-version} : (v애플리케이션의 )Spring Boot 버전)
• ${Ansi.RED}, ${AnsiColor.RED} : 다음부터 빨간글씨

MANIFEST.MF 와 관련된 배너 변수

• ${application.title} : Implementation-Title, 앱 제목
• ${application.version} : Implementation-Version, 앱 버전
• ${application.formatted-version} : (v앱 버전)

Manifest-Version: 1.0
Implementation-Title: jiniworld
Implementation-Version: 0.0.2-SNAPSHOT
Built-By: jini
Implementation-Vendor-Id: me.jiniworld
Created-By: Apache Maven 3.5.2
Build-Jdk: 1.8.0_151
Implementation-URL: https://projects.spring.io/spring-boot/#/spring-bo
 ot-starter-parent/jiniworld

배너 변수	출력 예
${application.title}	jiniworld
${application.version}	0.0.2-SNAPSHOT
${application.formatted-version}	(v0.0.2-SNAPSHOT)
${spring-boot.version}	2.1.3.RELEASE
${spring-boot.formatted-version}	(v2.1.3.RELEASE)

※ Spring Boot Reference Guide를 참고해주세요. [ 여기 ]

---

4. ANSI Color

배너에 ANSI color를 적용할 수 있다.
배너 텍스트에 색상을 설정해보자.

${Ansi.색상} 을 이용하면 글자 색상을 변경할 수 있다.
글자 색상에는 BLUE, RED, YELLOW 등 여러 색상이 있으며, 배너 설정을 마친 후에는 ${Ansi.NORMAL} 을 써주세요.

지원되는 색상 정보는 Spring Boot Docs 를 참고해주세요. [ 여기 ]

위의 파일은 ANSI Color를 적용한 배너파일 예시입니다.

이렇게 예쁜 체리모양이 출력되었네요 ㅎㅎ

만일, Windows 10 OS의 cmd에서 ANSI color가 지원이 되지 않아 아래와 같이 출력이 된다면
Windows 10 OS의 cmd에 ANSI color 적용하기 를 읽어보세요.

---

++ 키워드

1. Custom Banners in Spring Boot 2
2. Spring Boot 배너 설정
3. Spring Boot 이미지 배너 설정
4. ANSI Color 사용하기
5. Spring Boot 배너 경로 property에 설정