SpringBoot 花式 banner

发表于 更新于 分类于

什么是 springboot 的 banner？

当 SpringBoot 项目最初运行起来时，在控制台看到的类似下面的信息，就是 SpringBoot 的 banner。可以把项目中的 banner 换成自己公司的 LOGO，增强员工对公司的认同感。

1
2
3
4
5
6
7
  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v1.5.14.BUILD-SNAPSHOT)

加载顺序

SpringBoot 默认寻找banner的顺序是：

  • 依次在 classpath 下找文件 banner.gif ，banner.jpg，banner.png，先找到哪个用哪个；
  • 在 classpath 下找 banner.txt ；
  • 以上都没有就使用默认的；

可以直接在项目配置文件中控制 banner 文件的位置以及显示参数，如文件编码、图像宽高等。

  • SpringBoot 1.x 中的 banner 配置项

    配置项 参数类型 注释
    spring.main.banner-mode off 、console 、log banner 输出位置，不输出、控制台、日志，默认值： console
    banner.charset java.nio.charset.Charset banner 字符编码，默认值：UTF-8
    banner.image.height Integer 图像高度
    banner.image.invert Boolean 为黑色控制台主题转换图片，默认值：false
    banner.image.location org.springframework.core.io.Resource banner 图片，默认值： banner.gif
    banner.image.margin Integer banner 图左边距
    banner.image.width Integer 图像宽度
    banner.location org.springframework.core.io.Resource banner 文件，默认值：classpath:banner.txt

  • SpringBoot 2.x 中的 banner 配置项
    配置项的名称增加了前缀 spring. ，改成了 spring.banner.xxx ，如 1.x 中的 banner.charset 改成了 spring.banner.charset ，配置内容和默认值与 1.x 相同，可以参考上表。

更换 banner

在 **resources ** 目录下创建文件 banner.txt ，将想要展示的文字内容写到这个文件中即可。

在使用 SpringBoot 1.5.8 测试图片类型的 banner 时，发现在控制台中打印出来的都是乱码，╮(￣▽￣")╭
测试发现使用 2.x 的 SpringBoot 可以打出来，在使用 GIF 动图 banner.gif 时，会把动图的每个画面打印出来，如果同时还存在 banner.txt，会在最后打出文本中的内容。

编辑 banner 内容

生成漂亮的 banner 文字图

输入想要的文字，生成图形文字，将生成的内容粘贴到 banner.txt 中即可。

这个就厉害了，给定图片链接，将其转换成文字图形。例如将示例中的美女图转成txt文字：

=======>

将文字部分粘贴到 banner.txt 中，运行项目看到：

如果发现图片有点大了，可以退回到上一步，设置图片输出大小，重新获得txt 文本。

我们看现在这个 banner，在控制台中输出时，被压扁了，我们要把它撑开，在每个字符后面添加一个空格。将文本粘贴到一个空白 word 文档中，按 Ctrl + F 键调出查找功能对话框，在 替换 选项卡中，勾选上使用通配符，在上面输入问号 ? ，在下面输入 ^& 加一个空格，点击 全部替换 。将全部文本复制到 banner.txt 中。

最终效果：

给 banner 上色

使用 SpringBoot 提供的颜色枚举类为banner设置颜色，只需要在要上色文字前添加相应颜色代码，即可为后方的所有文字添加字体颜色或背景颜色。如：

Ansi 颜色代码

颜色 字体颜色代码 背景颜色代码 颜色值
红色 ${AnsiColor.RED} ${AnsiBackground.RED} A00
亮红色 ${AnsiColor.BRIGHT_RED} ${AnsiBackground.BRIGHT_RED} F55
绿色 ${AnsiColor.GREEN} ${AnsiBackground.GREEN} 0A0
亮绿色 ${AnsiColor.BRIGHT_GREEN} ${AnsiBackground.BRIGHT_GREEN} 5F0
蓝色 ${AnsiColor.BLUE} ${AnsiBackground.BLUE} 00A
亮蓝色 ${AnsiColor.BRIGHT_BLUE} ${AnsiBackground.BRIGHT_BLUE} 55F
黑色 ${AnsiColor.BLACK} ${AnsiBackground.BLACK} 000
亮黑色 ${AnsiColor.BRIGHT_BLACK} ${AnsiBackground.BRIGHT_BLACK} 555
白色 ${AnsiColor.WHITE} ${AnsiBackground.WHITE} AAA
亮白色 ${AnsiColor.BRIGHT_WHITE} ${AnsiBackground.BRIGHT_WHITE} FFF
黄色 ${AnsiColor.YELLOW} ${AnsiBackground.YELLOW} A50
亮黄色 ${AnsiColor.BRIGHT_YELLOW} ${AnsiBackground.BRIGHT_YELLOW} FF5
青色 ${AnsiColor.CYAN} ${AnsiBackground.CYAN} 0AA
亮青色 ${AnsiColor.BRIGHT_CYAN} ${AnsiBackground.BRIGHT_CYAN} 5FF
洋红色 ${AnsiColor.MAGENTA} ${AnsiBackground.MAGENTA} A0A
亮洋红色 ${AnsiColor.BRIGHT_MAGENTA} ${AnsiBackground.BRIGHT_MAGENTA} F5F
默认色 ${AnsiColor.DEFAULT} ${AnsiBackground.DEFAULT} -

注： 在 banner 结束位置最好使用添加默认颜色和默认背景色，防止后面输出的日志信息颜色混乱影响日志查看。

仔细想想，有了这些颜色，完全可以绘制一幅像素图片了，那会是一件多么炫酷的事情啊！！

修改 banner 字体样式

使用 SpringBoot 提供的字体样式枚举设定 banner 展示的字体样式。

样式 代码
正常 ${AnsiStyle.NORMAL}
加粗 ${AnsiStyle.BOLD}
减细 ${AnsiStyle.FAINT}
倾斜 ${AnsiStyle.ITALIC}
下划线 ${AnsiStyle.UNDERLINE}

显示项目信息

在 banner 文件中可以使用 ${} 表达式取得项目配置文件和 MANIFEST.MF 中的变量值，如：

变量 表达式 注释
版本号 ${application.version} MANIFEST.MF 中的 Implementation-Version 的值
格式化的版本号 ${application.formatted-version} 在上述的版本号前加上前缀 v
SpringBoot 版本 ${spring-boot.version} 当前使用的 SpringBoot 版本
格式化的 SpringBoot 版本号 ${spring-boot.formatted-version} 加上前缀 v 的 SpringBoot 版本号
标题 ${application.title} MANIFEST.MF 中的 Implementation-Title 的值
自定义变量 ${my.name} 项目配置文件中的 my.name 的值

注：如果 ${} 没有取到值，将直接显示表达式，如没有定义 my.name ，在 banner 中用 ${my.name} 取值，将直接显示取值表达式 ${my.name} 。

关于banner里面设置的颜色，我只在IDEA的控制台里看到过，不太清楚在其他哪些环境中也可以显示，如果您知道，麻烦告诉我一下。

剧终

好了，关于SpringBoot 的 banner 设置内容就先写到这里了。