SpringBoot自定义个性化的banner

àì夳堔傛蜴生んèń 2022-06-07 04:57 218阅读 0赞

自定义Banner

通过在classpath下添加一个`banner.txt`或设置`banner.location`来指定相应的文件可以改变启动过程中打印的banner。如果这个文件有特殊的编码，你可以使用`banner.encoding`设置它（默认为UTF-8）。除了文本文件，你也可以添加一个`banner.gif`，`banner.jpg`或`banner.png`图片，或设置`banner.image.location`属性。图片会转换为字符画（ASCII art）形式，并在所有文本banner上方显示。

在banner.txt中可以使用如下占位符：

<table> 
 <thead> 
 <tr> 
 <th>变量</th> 
 <th align="left">描述</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>${application.version}</td> 
 <td align="left">MANIFEST.MF中声明的应用版本号，例如<code>Implementation-Version: 1.0</code>会打印<code>1.0</code></td> 
 </tr> 
 <tr> 
 <td>${application.formatted-version}</td> 
 <td align="left">MANIFEST.MF中声明的被格式化后的应用版本号（被括号包裹且以v作为前缀），用于显示，例如(<code>v1.0</code>)</td> 
 </tr> 
 <tr> 
 <td>${spring-boot.version}</td> 
 <td align="left">当前Spring Boot的版本号，例如<code>1.4.1.RELEASE</code></td> 
 </tr> 
 <tr> 
 <td>${spring-boot.formatted-version}</td> 
 <td align="left">当前Spring Boot被格式化后的版本号（被括号包裹且以v作为前缀）, 用于显示，例如(<code>v1.4.1.RELEASE</code>)</td> 
 </tr> 
 <tr> 
 <td> Ansi.NAME（或 {AnsiColor.NAME}， AnsiBackground.NAME, {AnsiStyle.NAME}）</td> 
 <td align="left">NAME代表一种ANSI编码，具体详情查看<a href="https://github.com/spring-projects/spring-boot/tree/v1.4.1.RELEASE/spring-boot/src/main/java/org/springframework/boot/ansi/AnsiPropertySource.java" rel="nofollow">AnsiPropertySource</a></td> 
 </tr> 
 <tr> 
 <td>${application.title}</td> 
 <td align="left"><code>MANIFEST.MF</code>中声明的应用title，例如<code>Implementation-Title: MyApp</code>会打印<code>MyApp</code></td> 
 </tr> 
 </tbody> 
</table>

**注** 如果想以编程的方式产生一个banner，可以使用`SpringBootApplication.setBanner(…)`方法，并实现`org.springframework.boot.Banner`接口的`printBanner()`方法。

你也可以使用`spring.main.banner-mode`属性决定将banner打印到何处，`System.out`（`console`），配置的logger（`log`）或都不输出（`off`)。

打印的banner将注册成一个名为`springBootBanner`的单例bean。

**注** YAML会将`off`映射为`false`，如果想在应用中禁用banner，你需要确保`off`添加了括号：

spring:
        main:
            banner-mode: "off"