在Sprin Boot中使用自定义Banner

2023/05/11

1. 概述

默认情况下,Spring Boot带有一个横幅,它会在应用程序启动时立即显示。

在本文中,我们学习如何创建自定义banner并在Spring Boot应用程序中使用它。

2. 创建Banner

在我们开始之前,我们需要创建将在应用程序启动时显示的自定义横幅。我们可以从头开始创建自定义横幅或使用各种工具来为我们做这件事。

在这个例子中,我们使用英文字母“TAKE-TODAY”:

${AnsiColor.CYAN}
████████╗ █████╗ ██╗  ██╗███████╗      ████████╗ ██████╗ ██████╗  █████╗ ██╗   ██╗
╚══██╔══╝██╔══██╗██║ ██╔╝██╔════╝      ╚══██╔══╝██╔═══██╗██╔══██╗██╔══██╗╚██╗ ██╔╝
   ██║   ███████║█████╔╝ █████╗  █████╗   ██║   ██║   ██║██║  ██║███████║ ╚████╔╝ 
   ██║   ██╔══██║██╔═██╗ ██╔══╝  ╚════╝   ██║   ██║   ██║██║  ██║██╔══██║  ╚██╔╝  
   ██║   ██║  ██║██║  ██╗███████╗         ██║   ╚██████╔╝██████╔╝██║  ██║   ██║   
   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚══════╝         ╚═╝    ╚═════╝ ╚═════╝ ╚═╝  ╚═╝   ╚═╝   
                                                                                  
Spring Boot Version: ${spring-boot.version} -- 代码是我心中的一首诗

但是,在某些情况下,我们可能希望使用纯文本格式的banner,因为它相对更容易维护。

这里要注意的是,ANSI charset具有在控制台中显示彩色文本的能力。这不能用简单的纯文本格式来完成。

3. 使用自定义Banner

我们需要在src/main/resources目录中创建一个名为banner.txt的文件并将banner内容粘贴到其中。

这里需要注意的是,banner.txt是Spring Boot使用的默认预期banner文件名。但是,如果我们想为banner选择任何其他位置或其他名称,我们需要在application.properties文件中设置spring.banner.location属性:

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

我们也可以使用图像作为banner,与banner.txt相同,Spring Boot期望banner图像的名称为banner.gif。另外,我们可以在application.properties中设置不同的图片属性,如高度、宽度等:

spring.banner.image.location=classpath:banner.gif
spring.banner.image.width=//TODO
spring.banner.image.height=//TODO
spring.banner.image.margin=//TODO
spring.banner.image.invert=//TODO

但是,使用文本格式总是更好,因为如果使用一些复杂的图像结构,应用程序启动时间将大大增加。

4. 总结

在这篇快速文章中,我们展示了如何在Spring Boot应用程序中使用自定义banner。

与往常一样,本教程的完整源代码可在GitHub上获得。

Show Disqus Comments

Post Directory

扫码关注公众号:Taketoday
发送 290992
即可立即永久解锁本站全部文章