Spring Boot 自定义Banner(横幅)

作者 | 2020年4月1日

1、前言

默认情况下,Spring Boot在启动时会立即显示一个由字符组成的Banner(横幅)。

在本文中,我们将学习如何在Spring Boot应用中自定义Banner。

2、创建一个Banner

在正文开始之前,我们需要创建一个自定义的Banner用于在程序启动的时候显示。
我们可以手动地或者借助于其它的工具来创建Banner。

在本例中我们使用字符MyExample来创建一个Banner:

一般来说横幅使用的是易于维护的纯文本格式。上面的例子使用一个在线的TAAG工具创建。

有一点要注意的是,ANSI字符集可以在控制台上显示有颜色的文本,而纯文本则做不到。

3、使用自定义的Banner

目前为止,我们已经创建了一个自定义的Banner,我们需要在src/main/resources目录下创建一个名称为banner.txt的文件用于保存我们的Banner。

有一点需要注意,banner.txt是Banner所在文件的默认名称,Spring Boot默认将读取该文件中的内容作为Banner。
如果我们希望选择其它位置或者其它名称的Banner文件,我们需要在application.properties文件中修改spring.banner.location属性:

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

我们也可以使用一幅图片作为Banner,与banner.txt一样,这时候Spring Boot使用banner.gifbanner.jpgbanner.png作为默认的Banner文件名。

此外,我们还可以在application.properties文件中设置图片的宽度、高度等属性:

spring.banner.image.location=classpath:banner.gif
# 图像 banner 的宽度(字符数)
spring.banner.image.width =  200
# 图像 banner 的高度(字符数)
spring.banner.image.height = 20
# 图像 banner 的左边界(字符数)
spring.banner.image.margin = 2
# 是否将图像转为黑色控制台主题
spring.banner.image.invert = false

但是,建议最好使用文本格式,因为如果使用的图片具有复杂的结构,则应用程序的启动时间也将大大增加。

4、禁用Banner

有时候我们希望禁用Spring Boot的Banner,此时可以在application.properties文件中添加属性:

spring.main.banner-mode = off

5、总结

在这篇文章中,我们展示了如何在Spring Boot应用程序中使用自定义的Banner与禁用Banner。

发表评论

电子邮件地址不会被公开。 必填项已用*标注