【Spring Boot】自定义 Banner

- 日理万妓 2024-03-24 16:02 23阅读 0赞

#### 文章目录 ####

*  1. 什么是 Banner
 *  2. 如何修改 Banner
 *  3. IDEA 中演示
 *  4. 快速生成 Banner
 *  5. 指定 banner.txt 的位置
 *  6. 在 Spring Boot 2 中的说明
 *   *  6.1 图片生成 Banner
     *  6.1 增强显示效果
     *  6.3 更多配置项
 *  7. 补充

Spring Boot Version: 3.0.x

## 1. 什么是 Banner ##

启动 Spring Boot 时，几乎总是能在控制台上方看到如下横幅，这个也叫字符画、英文ASCII艺术字

![在这里插入图片描述][10fde0ace104417f930de4ff58dd1d3f.png]

## 2. 如何修改 Banner ##

默认情况下，只需在 resources 根目录（准确说是 classpath）下新建一个 banner.txt 文件，内容即为 Banner

![在这里插入图片描述][6d5449775ed54a42a5fbc10392ce199d.png]

在 banner.txt 文件中，可以使用可用的任何键 Environment 以及以下任何占位符

<table> 
 <thead> 
  <tr> 
   <th align="left">Variable</th> 
   <th align="left">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">${application.version}</td> 
   <td align="left">应用程序的版本号，例如1.0</td> 
  </tr> 
  <tr> 
   <td align="left">${application.formatted-version}</td> 
   <td align="left">用括号括起来并以 v 为前缀，例如(v1.0)</td> 
  </tr> 
  <tr> 
   <td align="left">${spring-boot.version}</td> 
   <td align="left">正在使用的 Spring Boot 版本。例如3.0.5</td> 
  </tr> 
  <tr> 
   <td align="left">${spring-boot.formatted-version}</td> 
   <td align="left">同理，(v3.0.5)</td> 
  </tr> 
 </tbody> 
</table>

## 3. IDEA 中演示 ##

banner.txt 内容如下，使用一个经典的佛祖保佑 Banner，并演示占位符的使用

${spring-boot.formatted-version}
    ————————————————————————————————————————————————————————————————————
    //                          _ooOoo_                               //
    //                         o8888888o                              //
    //                         88" . "88                              //
    //                         (| ^_^ |)                              //
    //                         O\  =  /O                              //
    //                      ____/`---'\____                           //
    //                    .'  \\|     |//  `.                         //
    //                   /  \\|||  :  |||//  \                        //
    //                  /  _||||| -:- |||||-  \                       //
    //                  |   | \\\  -  /// |   |                       //
    //                  | \_|  ''\---/''  |   |                       //
    //                  \  .-\__  `-`  ___/-. /                       //
    //                ___`. .'  /--.--\  `. . ___                     //
    //              ."" '<  `.___\_<|>_/___.'  >'"".                  //
    //            | | :  `- \`.;`\ _ /`;.`/ - ` : | |                 //
    //            \  \ `-.   \_ __\ /__ _/   .-` /  /                 //
    //      ========`-.____`-.___\_____/___.-`____.-'========         //
    //                           `=---='                              //
    //      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^        //
    //            佛祖保佑       永不宕机     永无BUG                    //
    ————————————————————————————————————————————————————————————————————

运行如下，符合预期

![在这里插入图片描述][3050161ee64a4c6ca4385d1e78e4b80c.png]

## 4. 快速生成 Banner ##

对于复杂的 Banner（譬如上面的佛祖），手打显然是很浪费时间精力的，通常会借助一些 Banner 生成工具快速生成，推荐一个 Banner 在线生成工具：[https://www.bootschool.net/ascii][https_www.bootschool.net_ascii]，可以将输入的文本转换为 Banner，并且有多种字体可选

## 5. 指定 banner.txt 的位置 ##

上面提到默认情况下，banner.txt 必须放在 classpath（resources 根目录 ）下方可生效，假设现在需要放在 resources/static 目录下，在 application.yml 添加如下配置项即可

spring:
      banner:
      	# 或者 static/banner.txt
        location: classpath:static/banner.txt

需要说明的是，在没有显式设置上述配置项时，Banner 文件只能为 banner.txt；显式设置后，Banner 文件名就可以为 xxx.txt

## 6. 在 Spring Boot 2 中的说明 ##

### 6.1 图片生成 Banner ###

在 3.0.x 的版本中，Banner 仅能通过文本文件（banner.txt）的方式设置，但在 2 的版本中，除了文本文件，还可以通过图片的方式设置，查看 spring.banner 下的配置项就可以发现

![!\[在这里插入图片描述\](https://img-blog.csdnimg.cn/96342edf82fa440aaae959be2bd768ee.png][https_img-blog.csdnimg.cn_96342edf82fa440aaae959be2bd768ee.png]

通过配置项 spring.banner.image.location 的默认值可以看出，只需在 classpath 下放入一个 banner.gif 图片即可，经过测试，除了 gif 格式的图片，jpg、png 也能被识别，实际效果就是将图片转换为字符画

以下图为例（盒马.png）  
![盒马.png][.png]

spring:
      banner:
        image:
          location: static/盒马.png
          width: 38

由于默认宽度（76）下在控制台中生成的Banner过大，不便截图，故此处指定了 width 属性

生成效果：

![在这里插入图片描述][e1801ad6bfc2401191420b5859cd1a80.png]

可以看出，生成的 Banner 和原图十分相似，甚至连颜色都还原了（用了某种算法）

### 6.1 增强显示效果 ###

还可以进一步增强显示效果，通过设置 spring.banner.image.pixelmode，将渲染图像时使用的像素模式由默认的 text 模式改为 block 模式

spring:
      banner:
        image:
          location: static/盒马.png
          width: 38
          pixelmode: block

生成效果：

![在这里插入图片描述][1257891b52b84c29a79ffa2a06392ee7.png]

### 6.3 更多配置项 ###

至于 spring.banner.image 的其他属性不再逐一演示，因为十分简单，参照文档一试便知，附上

![在这里插入图片描述][4814770b47a641d9b4b21f89c475f010.png]

遗憾的是，在 Spring Boot 3 中有关 spring.banner.image.\* 的配置项均已弃用，该功能已被剔除，仅支持文本文件的方式生成 Banner

![在这里插入图片描述][2c6e8b30183048f8ad1d0c2e6223149d.png]

## 7. 补充 ##

在 2 版本中，可以同时指定文本文件和图片生成 Banner。  
若同时指定，控制台 Banner 打印顺序为：文本文件、图片

本文链接：[https://blog.csdn.net/weixin\_43553153/article/details/130013697][https_blog.csdn.net_weixin_43553153_article_details_130013697]

[10fde0ace104417f930de4ff58dd1d3f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/f0b7826d8a7e4cf2910b18c993d372c5.png
[6d5449775ed54a42a5fbc10392ce199d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/85e16e79efd54cb4a77c71842376424a.png
[3050161ee64a4c6ca4385d1e78e4b80c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/584d2291d8f6420295bb7fd290bde6bf.png
[https_www.bootschool.net_ascii]: https://www.bootschool.net/ascii
[https_img-blog.csdnimg.cn_96342edf82fa440aaae959be2bd768ee.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/1ebda6047e1f44a19032453b6251f515.png
[.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/9b2c7a3373b947da9d8fd97c7a877ee5.png
[e1801ad6bfc2401191420b5859cd1a80.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/ec68ac631cca46d38d54301ee2986523.png
[1257891b52b84c29a79ffa2a06392ee7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/be9f349fbd2443fcb788dcc2ad03f091.png
[4814770b47a641d9b4b21f89c475f010.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/0628e2efa30a4826a4ed56f8e46c7e7e.png
[2c6e8b30183048f8ad1d0c2e6223149d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/143604d46b9e4c858ba5163d5b29c75c.png
[https_blog.csdn.net_weixin_43553153_article_details_130013697]: https://blog.csdn.net/weixin_43553153/article/details/130013697