如何定制 Spring Boot 的 Banner?
相信用过 Spring Boot 的朋友们一定在启动日志中见过类似如下的内容,比如在启动 Spring Boot 时,控制台默认会打印 Spring Boot Logo 以及版本信息,这是 Spring Boot 固定的还是可自定义的呢?
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v1.5.7.RELEASE)
答案是,Spring Boot 支持自定义 Banner,接下来本文将详细讨论如何定制 Banner 内容,首先来了解下 Banner 是如何出现的。
Banner 是如何出现的?
初始 Banner 的代码是 SpringApplicationBannerPrinter 类,Spring Boot 默认寻找 Banner 的顺序是:
- 首先依次在 Classpath 下找文件 banner.gif,banner.jpg 和 banner.png,使用优先找到的
- 若没找到上面文件的话,继续 Classpath 下找 banner.txt
- 若上面都没有找到的话, 用默认的 SpringBootBanner,也就是上面输出的 Spring Boot Logo
一般是把 banner.* 文件放在 src/main/resources/ 目录下。
我们可以用属性 banner.location 设定 Spring Boot 在不同于 Classpath 下找以上 banner.txt 文件,banner.charset 设定 banner.txt 的字符集,默认为 UTF-8。属性 banner.image.location 用于指定寻找 banner.(gif|jpg|png) 文件的位置。
如果同时存在图片(如 banner.jpg) 和 banner.txt , 则它们会同时显示出来,先图片后文字,但同时存在多个图片 banner.(gif|jpg|png),则只会显示第一张图片。
- 对于文本文件,Spring Boot 会将其直接输出。
- 对于图像文件(
banner.gif、banner.jpg或banner.png),Spring Boot 会将图像转为 ASCII 字符,然后输出。
变量
banner.txt 文件中还可以使用变量来设置字体、颜色、版本号。
| 变量 | 描述 |
|---|---|
${application.version} |
MANIFEST.MF 中定义的版本。如:1.0 |
${application.formatted-version} |
MANIFEST.MF 中定义的版本,并添加一个 v 前缀。如:v1.0 |
${spring-boot.version} |
Spring Boot 版本。如:1.5.7.RELEASE |
${spring-boot.formatted-version} |
Spring Boot 版本,并添加一个 v 前缀。如:v1.5.7.RELEASE |
${Ansi.NAME} (or ${AnsiColor.NAME}, ${AnsiBackground.NAME}, ${AnsiStyle.NAME}) |
ANSI 颜色、字体 |
${application.title} |
MANIFEST.MF 中定义的应用名 |
配置
application.properties 中与 Banner 相关的配置:
# banner 模式。有三种模式:console/log/off
# console 打印到控制台(通过 System.out)
# log - 打印到日志中
# off - 关闭打印
spring.main.banner-mode = off
# banner 文件编码
spring.banner.charset = UTF-8
# banner 文本文件路径
spring.banner.location = classpath:banner.txt
# banner 图像文件路径(可以选择 png,jpg,gif 文件)
spring.banner.image.location = classpath:banner.gif
used).
# 图像 banner 的宽度(字符数)
spring.banner.image.width = 76
# 图像 banner 的高度(字符数)
spring.banner.image.height =
# 图像 banner 的左边界(字符数)
spring.banner.image.margin = 2
# 是否将图像转为黑色控制台主题
spring.banner.image.invert = false
当然,也可以在 YAML 文件中配置,例如:
spring:
banner:
charset: UTF-8
location: classpath:banner.txt
示例
新建 Spring Boot 项目(基于 Spring Boot 1.5.7)
package com.wupx.springboot;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class BannerApplication {
public static void main(String[] args) {
SpringApplication.run(BannerApplication.class, args);
}
}
在 Spring Boot 项目中的 resources 目录下添加 banner.txt 文件,内容如下:
${AnsiColor.BRIGHT_YELLOW}${AnsiStyle.BOLD}
__ _ ___________ ___
\ \/ \/ /\____ \ \/ /
\ / | |_> > <
\/\_/ | __/__/\_ \
|__| \/
${AnsiColor.CYAN}${AnsiStyle.BOLD}
:: Java :: (v${java.version})
:: Spring Boot :: (v${spring-boot.version})
${AnsiStyle.NORMAL}
启动 Spring Boot 应用后,控制台输出的 Banner 如下:

推荐几个生成字符画的网站,可以将生成的字符画放入这个 banner.txt 文件:
- http://www.network-science.de/ascii/
- http://patorjk.com/software/taag
- http://www.degraeve.com/img2txt.php
总结
默认 Spring Boot 会注册一个 SpringBootBanner 的单例 Bean,用来负责打印 Banner。
如果想完全个人定制 Banner,可以先实现 org.springframework.boot.Banner#printBanner 接口来自己定制 Banner。在将这个 Banner 通过 SpringApplication.setBanner() 方法注入 Spring Boot。
一般自定义 Spring Boot Banner 是企业/团队/项目的 Slogan。
参考
https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-banner

如何定制 Spring Boot 的 Banner?的更多相关文章
- Spring Boot - 自定义 Banner 图案
我是陈皮,一个在互联网 Coding 的 ITer,微信搜索「陈皮的JavaLib」第一时间阅读最新文章,回复[资料],即可获得我精心整理的技术资料,电子书籍,一线大厂面试资料和优秀简历模板. 前言 ...
- Spring Boot自定义Banner
在2016年的最后一天,借用Spring Boot的Banner向各位程序猿同仁们问候一声:Happy New Year. 接下来我们就来介绍一下这个轻松愉快的自定义banner功能.实现的方式非常简 ...
- Spring Boot 更换 Banner
Spring 启动时,会有一个Banner图案,这个图案是可以更换的 . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ ...
- Spring Boot . 4 -- 定制 Spring Boot 配置
覆写 Auto-Configuration 的类 利用外部属性进行动态配置 [本文] 定制 Error 页面 [第二篇] Spring Boot的自动配置可以节省很多无趣的配置工作,但是并不是所有的自 ...
- Spring Boot 自定义 Banner 教程
我们在启动 SpringBoot 时,控制台会打印 SpringBoot Logo 以及版本信息.有的时候我们需要自己弄个有个性的文本图片.Spring Boot 为我们提供了自定义接口. . ___ ...
- Spring boot 自定义banner的在线制作
目前工作不是很忙,利用闲暇的时间,在给自己不断地充电,提升自己的技术实力. 目前在做一个基于Spring Boot2.x+webmagic+quartz的爬虫项目[hotDog]https://git ...
- spring boot 修改banner
在resources目录下新建一个banner.txt,里面添加要显示的内容,如: ////////////////////////////////////////////////////////// ...
- Spring boot 自定义banner
Spring Boot启动的时候会在命令行生成一个banner,其实这个banner是可以自己修改的,本文将会将会讲解如何修改这个banner. 首先我们需要将banner保存到一个文件中,网上有很多 ...
- Spring Boot . 4 -- 定制 Spring Boot 配置 【2】
除了第一篇中使用 覆写的方式进行 自动配置的更改外,还可以通过 Spring Boot 中提供的 application.properties 文件改变应用的运行时配置.这种配置的方式粒度是非常精细的 ...
随机推荐
- Alibaba Cloud Toolkit 一键部署插件使用入门
一.前言 Cloud Toolkit官方介绍文档:https://www.aliyun.com/product/cloudtoolkit Cloud Toolkit 是针对 IDE 平台为开发者提供的 ...
- 线上CPU飙升100%问题排查,一篇足矣
一.引子 对于互联网公司,线上CPU飙升的问题很常见(例如某个活动开始,流量突然飙升时),按照本文的步骤排查,基本1分钟即可搞定!特此整理排查方法一篇,供大家参考讨论提高. 二.问题复现 线上系统突然 ...
- angularjs1学习笔记--持续更新
angularJS使用的MVC为何不属于二十三种设计模式之一? MVC被GoF (Gang of Four,四人组, <Design Patterns: Elements of Reusable ...
- Jmeter not found in class'org.json.JSONObject 问题
前景:公司有银行的项目要进行压测,但是接口有近视RSA加密,需发送签名,只能使用java编写原生接口脚本打包成jar使用BeanShell Sampler去调用发送请求.在使用的过程中遇到了如下问题. ...
- MySQL 分页查询优化
有时在处理偏移量非常大的分页时候查询时,例如LIMIT 1000,10这样的查询,这时MySQL需要查询1010条记录然后只返回最后10条,前面1000条记录都被抛弃,这样的代价非常高.要优化这种查询 ...
- Flask基础(10)-->http的无状态协议解决办法一(客户端cookie)
http的无状态协议 http是一种无状态协议,浏览器请求服务器时无状态的 什么是无状态? 无状态:指的是一次用户请求时,浏览器.服务器无法知道之前这个用户做过什么,每次请求都是一次新的请求. 无状态 ...
- java基础之缓存:session、cookie和cache的区别
以前实现数据的缓存有很多种方法,有客户端的Cookie,有服务器端的Session和Application. 其中Cookie是保存在客户端的一组数据,主要用来保存用户名等个人信息. Session则 ...
- .Net Core 商城微服务项目系列(二):使用Ocelot + Consul构建具备服务注册和发现功能的网关
1.服务注册 在上一篇的鉴权和登录服务中分别通过NuGet引用Consul这个包,同时新增AppBuilderExtensions类: public static class AppBuilderEx ...
- ELK系列(二):.net core中使用ELK
ELK安装好后,我们现在.net Core中使用一下,大体思路就是结合NLog日志组件将数据写入ELK中,其它语言同理. ELK的安装还是有些复杂的,我们也可以在Docker中安装ELK:docker ...
- 解决Git报错:error: You have not concluded your merge (MERGE_HEAD exists).
Git fetch和git pull的区别, 解决Git报错:error: You have not concluded your merge (MERGE_HEAD exists). 2017年02 ...