2. Spring Boot 2.x 最佳实践之自定义Banner

在Java帝国中，存在着很多码农修真者，某些天赋杰出的修真者，崇信自由，开源，免费的极客理念，分享创造了各种各样的功法。但是功法的学习有难度，需要花费大量时间学习。 为了简化功法的学习门槛，Spring Boot 被创造了出来。
Spring Boot 功法海纳百川，可以在此基础上学习任何其他优秀的功法。

• 创建独立的Spring应用程序
• 直接嵌入Tomcat，Jetty或Undertow（无需部署WAR文件）
• 提供自以为是的“入门”依赖项以简化构建配置
• 尽可能自动配置Spring和第三方库
• 提供生产就绪功能，例如指标，运行状况检查和外部化配置
• 绝对没有代码生成，也不需要XML配置

言归正传，我们这节课来学习下如何自定义Banner

0x01. 什么是Banner?

Banner 指的到底是什么呢？我试了下终于知道了答案。
所谓的Banner ，中文意思是横幅的意思，其实就是程序启动时候这个地方

0x02. 如何修改Banner?

如何修改呢，方法很简单
1.在application.properties 配置文件中添加如下配置

# 基础配置
# 配置当前应用程序的名称,选填 可不配置
spring.application.name=spring-boot-with-customize-banner

# 内嵌容器参数配置
# 配置应用程序的访问端口 选填 不配置默认是8080
server.port=8080
# 配置应用程序的IP,选填
server.address=127.0.0.1
# 配置应用程序的上下文
server.servlet.context-path=/

# spring banner config
# 指定字符集，如果不指定，默认是UTF-8
spring.banner.charset=UTF-8
# 指定Banner 配置文件的位置
spring.banner.location=/banner_config/banner_fo_zhu.txt
#是否显示Banner
#可选值有三个,一般不需要修改
#console:显示在控制台 默认值
#log:显示在文件
#off:不显示 
spring.main.banner-mode=console
#spring-boot.version=2.1.2.RELEASE
#spring-boot.formatted-version=v2.1.2.RELEASE
#application.title=My App

2.在resources 文件夹下创建一个banner_config 文件夹，然后放进去配置文件即可。

我这里添加了很多banner选项可供选择，我们只看一个好了。
banner_fo_zhu.txt 内容如下：

////////////////////////////////////////////////////////////////////
//                          _ooOoo_                               //
//                         o8888888o                              //
//                         88" . "88                              //
//                         (| ^_^ |)                              //
//                         O\  =  /O                              //
//                      ____/`---'\____                           //
//                    .'  \\|     |//  `.                         //
//                   /  \\|||  :  |||//  \                        //
//                  /  _||||| -:- |||||-  \                       //
//                  |   | \\\  -  /// |   |                       //
//                  | \_|  ''\---/''  |   |                       //
//                  \  .-\__  `-`  ___/-. /                       //
//                ___`. .'  /--.--\  `. . ___                     //
//              ."" '<  `.___\_<|>_/___.'  >'"".                  //
//            | | :  `- \`.;`\ _ /`;.`/ - ` : | |                 //
//            \  \ `-.   \_ __\ /__ _/   .-` /  /                 //
//      ========`-.____`-.___\_____/___.-`____.-'========         //
//                           `=---='                              //
//      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^        //
//         佛祖保佑       永无BUG     永不修改                       //
////////////////////////////////////////////////////////////////////

3.运行程序
我们可以看到运行程序后这个地方已经被替换了

0x03. 多学几招

怎么样拉风不？让我们再换一个文艺点如何？

3.1 切换Banner

application.properties 修改如下：

# spring banner config
# 指定字符集，如果不指定，默认是UTF-8
spring.banner.charset=UTF-8
# 指定Banner 配置文件的位置
spring.banner.location=/banner_config/banner_fo_zhu_poet.txt
#是否显示Banner
#可选值有三个,一般不需要修改
#console:显示在控制台
#log:显示在文件
#off:不显示
#spring.main.banner-mode=console

效果如下：

3.2 引入变量

除此之外我们还可以在Banner 文件中引入变量，比如版本号

1. 修改配置文件

# spring banner config
# 指定字符集，如果不指定，默认是UTF-8
spring.banner.charset=UTF-8
# 指定Banner 配置文件的位置
spring.banner.location=/banner_config/banner_default_spring.txt
#是否显示Banner
#可选值有三个,一般不需要修改
#console:显示在控制台
#log:显示在文件
#off:不显示
#spring.main.banner-mode=console
spring-boot.version=2.1.2.RELEASE
spring-boot.formatted-version=v2.1.2.RELEASE
application.title=My App

2. 修改banner_default_spring.txt模板配置如下

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: ${application.title} ::        (${spring-boot.formatted-version})

我们可以看到这里已经改了

3.3 是否显示Banner

除此之外还可以配置这个信息输出到控制台还是文件或者不输出

如果想关闭这个banner 打印，修改application.properties文件如下：

spring.main.banner-mode=off

最佳实践推荐最好不配置这个属性

0x04 源码下载

查看本文在线源码

本篇完~