SpringBoot 教程之 banner 定制
SpringBoot教程 定制 Banner
2023-09-27 14:24:24 时间
简介
Spring Boot 启动时默认会显示以下 LOGO:
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.1.1.RELEASE)
实际上,Spring Boot 支持自定义 logo 的功能。
让我们来看看如何实现的。
只要你在 resources
目录下放置名为 banner.txt
、banner.gif
、banner.jpg
或 banner.png
的文件,Spring Boot 会自动加载,将其作为启动时打印的 logo。
- 对于文本文件,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 版本。如:2.1.1.RELEASE . |
${spring-boot.formatted-version} |
Spring Boot 版本,并添加一个 v 前缀。如:v2.1.1.RELEASE |
${Ansi.NAME} (or ${AnsiColor.NAME} , ${AnsiBackground.NAME} , ${AnsiStyle.NAME} ) |
ANSI 颜色、字体。更多细节,参考:AnsiPropertySource 。 |
${application.title} |
MANIFEST.MF 中定义的应用名。 |
示例:
在 Spring Boot 项目中的 resources
目录下添加一个名为 banner.txt 的文件,内容如下:
${AnsiColor.BRIGHT_YELLOW}${AnsiStyle.BOLD}
________ ___ ___ ________ ___ __ ___ ___
|\ ___ \|\ \|\ \|\ ___ \|\ \ |\ \|\ \|\ \
\ \ \_|\ \ \ \\\ \ \ \\ \ \ \ \ \ \ \ \ \\\ \
\ \ \ \\ \ \ \\\ \ \ \\ \ \ \ \ __\ \ \ \ \\\ \
\ \ \_\\ \ \ \\\ \ \ \\ \ \ \ \|\__\_\ \ \ \\\ \
\ \_______\ \_______\ \__\\ \__\ \____________\ \_______\
\|_______|\|_______|\|__| \|__|\|____________|\|_______|
${AnsiBackground.WHITE}${AnsiColor.RED}${AnsiStyle.UNDERLINE}
:: Spring Boot :: (v${spring-boot.version})
:: Spring Boot Tutorial :: (v1.0.0)
注:
${}
设置字体颜色的变量之间不能换行或空格分隔,否则会导致除最后一个变量外,都不生效。
启动应用后,控制台将打印如下 logo:
![](http://dunwu.test.upcdn.net/snap/20181221231330.png!zp)
配置
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:
main:
banner-mode: off
编程
默认,Spring Boot 会注册一个 SpringBootBanner
的单例 Bean,用来负责打印 Banner。
如果想完全个人定制 Banner,可以这么做:先实现 org.springframework.boot.Banner#printBanner
接口来自己定制 Banner。在将这个 Banner 通过 SpringApplication.setBanner(…)
方法注入 Spring Boot。
示例
示例源码:spring-boot-banner
参考资料
相关文章
- Springboot项目如何统一返回格式
- 微服务技术系列教程(46)-SpringBoot整合MongoDB(文章评论案例)
- 微服务技术系列教程(39)- SpringBoot -RBAC权限模型
- 微服务技术系列教程(37)- SpringBoot -SpringSecurity简介
- 微服务技术系列教程(08) - SpringBoot - 热部署(IDEA版)
- 微服务技术系列教程(01) - SpringBoot - 入门
- 分布式系列教程(03) -分布式Redis缓存(SpringBoot整合Redis)
- SpringBoot上传文件 MultipartFile.getBytes 导致内存溢出
- 使用docker部署springboot项目小白教程
- SpringBoot常用注解
- SpringBoot开启配置全局异常
- SpringBoot配置https
- 在SpringBoot集成下,Mybatis的mapper代理对象究竟是如何生成的
- SpringBoot整合MybatisPlus3.X之分页插件(四)
- 《SpringBoot篇》18.SpringBoot整合Memcached缓存超详细教程
- springboot实战:我们的第一款开源软件
- 基于springboot项目加载配置文件优先级
- SpringBoot Logback配置,SpringBoot日志配置
- SpringBoot @ConfigurationProperties详解
- 【SpringBoot2】01-如何创建一个SpringBoot项目 (2022年保姆级教程)
- 基于springboot的毕业生信息招聘平台设计实现【毕业论文、源码】
- springboot配置静态文件及获取静态资源路径【详细教程】
- SpringBoot后台管理系统脚手架项目 附带运行指导文档
- Docker+Nginx部署前后端分离项目(SpringBoot+Vue)的详细教程