Spring Boot 在启动的时候,我们或许想要把自己公司的 logo,或者是项目的 logo 放上去,我们可以试试本文的这些方法,可以让你快速制作一些 Spring Boot 项目启动时的彩蛋,以提高项目的辨识度,或者是纯粹为了给枯燥的生活平添一些乐趣,那么本文这些内容能很好的帮助到你。
本文知识点,如下图所示:
Banner效果展示
Spring Boot 默认的 banner 图展示效果如下:
我们可以把它变成这样的:
或者是这样的:
或者是这样的:
简直秀的飞起,不但能自定义内容,还能自定义颜色,那接下来我们就来看它是如何实现的吧。
自定义Banner
自定义 banner 的实现方式有两种,一种是通过重写自定义的 Banner 类来实现,另一种通过 txt 文件来实现。
1.重写Banner类
首先,需要自定义类实现 Banner 接口,实现代码如下:
importorg.springframework.boot.Banner;importorg.springframework.core.env.Environment;importjava.io.PrintStream;publicclassMyBannerimplementsBanner{privatestaticfinalStringBANNER="______.__.__"+"/|____||||____"+"/~_/__||||/_"+"Y/___/||_||_(<_>)"+"___|_/___>____/____/____/"+"//";@OverridepublicvoidprintBanner(Environmentenvironment,Class>sourceClass,PrintStreamout){out.println(BANNER);out.println();}}
其中 BANNER 变量为自定义 banner 的内容,我这放入了一个 hello,然后在 Spring Boot 启动时设置 Banner 类为自定义类,实现代码如下:
publicstaticvoidmain(String[]args){SpringApplicationspringApplication=newSpringApplication(DemoApplication.class);//设置自定义BannerspringApplication.setBanner(newMyBanner());//启动SpringBootspringApplication.run(args);}
最终的执行效果如下图所示:
2.通过txt文件实现
我们可以在 Spring Boot 工程的 /src/main/resources 目录下创建一个 banner.txt 文件,然后将 ASCII 字符画复制进去,就能替换默认的 banner 了,如下图所示:
之所以可以使用 banner.txt 文件的方式实现自定义 banner 是因为 Spring Boot 框架在启动时会按照以下顺序,查找 banner 信息:
先在 Classpath 下找 文件 banner.gif 或 banner.jpg 或 banner.png , 先找到谁就用谁;以上都没有就在 Classpath 下找 banner.txt;如果都没找到才会使用默认的 SpringBootBanner。
以上知识点是在 SpringApplicationBannerPrinter 源码中得知的,核心源码如下:
classSpringApplicationBannerPrinter{staticfinalStringBANNER_LOCATION_PROPERTY="spring.banner.location";staticfinalStringBANNER_IMAGE_LOCATION_PROPERTY="spring.banner.image.location";staticfinalStringDEFAULT_BANNER_LOCATION="banner.txt";staticfinalString[]IMAGE_EXTENSION=newString[]{"gif","jpg","png"};//忽略非核心源码privateBannergetBanner(Environmentenvironment){SpringApplicationBannerPrinter.Bannersbanners=newSpringApplicationBannerPrinter.Banners();//获取图片形式bannerbanners.addIfNotNull(this.getImageBanner(environment));//获取文字形式bannerbanners.addIfNotNull(this.getTextBanner(environment));if(banners.hasAtLeastOneBanner()){returnbanners;}else{returnthis.fallbackBanner!=null?this.fallbackBanner:DEFAULT_BANNER;}}privateBannergetTextBanner(Environmentenvironment){Stringlocation=environment.getProperty("spring.banner.location","banner.txt");Resourceresource=this.resourceLoader.getResource(location);returnresource.exists()?newResourceBanner(resource):null;}privateBannergetImageBanner(Environmentenvironment){Stringlocation=environment.getProperty("spring.banner.image.location");if(StringUtils.hasLength(location)){Resourceresource=this.resourceLoader.getResource(location);returnresource.exists()?newImageBanner(resource):null;}else{String[]var3=IMAGE_EXTENSION;intvar4=var3.length;for(intvar5=0;var5
所以我们才能使用 banner.txt 自定义 banner 信息,当然你也可以使用图片的方式来自定义 banner。
小技巧:我们可以使用 banner.gif 来实现动态 banner 的效果,动手试试吧。
此种方式实现起来比较简单,且是无代码侵入式的,推荐使用这种方式。
Banner样式控制
上面讲了 banner 文字部分的修改,我们还可以修改 banner 的演示以及其他属性,例如字体的样式,粗体、斜体等,Spring Boot 为提供了三个枚举类来设定这些样式,他们分别是:
AnsiColor:用来设定字符的前景色;AnsiBackground:用来设定字符的背景色。AnsiStyle:用来控制加粗、斜体、下划线等等。
例如,我们可以使用 AnsiColor 来设置颜色,banner.txt 中的信息如下:
${AnsiColor.BRIGHT_RED}____${AnsiColor.BRIGHT_RED}||||___||||___${AnsiColor.BRIGHT_YELLOW}|__|/-_)||||/_${AnsiColor.BRIGHT_YELLOW}|_||_|___|_|_|__|_|____/${AnsiColor.BRIGHT_RED}_|"""""|_|"""""|_|"""""|_|"""""|_|"""""|${AnsiColor.BRIGHT_RED}"`-0-0-'"`-0-0-'"`-0-0-'"`-0-0-'"`-0-0-'
最终的展示效果如下图所示:
Banner使用输出变量
在 banner.txt 中我们还可以输出一些全局变量,例如:
${application.version}:用来获取 MANIFEST.MF 文件中的版本号;${application.formatted-version}:格式化后的 ${application.version} 版本信息;${spring-boot.version}:Spring Boot 版本号;${spring-boot.formatted-version}:格式化后的 ${spring-boot.version} 版本信息。
使用示例如下:
Banner图在线生成
在线生成 banner 的地址:
由于头条的限制原因发链接会有影响,可以关注@JAVA发量告急后私信【Banner】我会回复你在线生成 banner 的地址,觉得不错的朋友可以转发一下
推荐使用第一种,使用缩略图如下:
隐藏Banner
如果我们需要隐藏 banner 信息,可以通过以下三种方法实现。
1.通过代码关闭Banner
我们可以在 Spring Boot 启动(run)之前设置隐藏 banner,实现代码如下:
publicclassDemoApplication{publicstaticvoidmain(String[]args){SpringApplicationspringApplication=newSpringApplication(DemoApplication.class);//隐藏bannerspringApplication.setBannerMode(Banner.Mode.OFF);//启动SpringBootspringApplication.run(args);}}
2.通过配置文件隐藏Banner
在 Spring Boot 的配置文件 application.properties 通过设置如下配置来隐藏 banner 的显示,配置如下:
spring.main.banner-mode=off
3.在Idea中隐藏Banner
我们可以在 Idea 的调试配置中隐藏 banner,如下图所示:
附:彩蛋
文章的末尾,附一个七彩佛祖的 banner 内容:
${AnsiColor.BRIGHT_GREEN}$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$${AnsiColor.BRIGHT_YELLOW}$$ _.ooOoo._ $$${AnsiColor.BRIGHT_RED}$$ o888888888o$$${AnsiColor.BRIGHT_CYAN}$$ 88" . "88$$${AnsiColor.BRIGHT_MAGENTA}$$ (| ^_^ |)$$${AnsiColor.BRIGHT_GREEN}$$ O = /O$$${AnsiColor.BRIGHT_RED}$$ ____/`-----'____ $$${AnsiColor.BRIGHT_CYAN}$$.' | |$$ `.$$${AnsiColor.BRIGHT_MAGENTA}$$/ ||| : |||$$$$${AnsiColor.BRIGHT_GREEN}$$ / _||||| -:- |||||-$$${AnsiColor.BRIGHT_YELLOW}$$ | | - $$/ | | $$${AnsiColor.BRIGHT_GREEN}$$ | _| ''-----/'' | | $$${AnsiColor.BRIGHT_YELLOW}$$.-___ `-` ____/-. / $$${AnsiColor.BRIGHT_CYAN}$$ ___`. .' /--.-- `. . ___ $$${AnsiColor.BRIGHT_RED}$$."" '< `.______/____.' >'"". $$${AnsiColor.BRIGHT_GREEN}$$ | | : `- `.;`. _ /``;.`/ - ` : | | $$${AnsiColor.BRIGHT_YELLOW}$$ `-. _ ___ /___ _/ .-` / / $$${AnsiColor.BRIGHT_CYAN}$$ ========`-.____`-._________/____.-`____.-'======== $$${AnsiColor.BRIGHT_MAGENTA}$$ `=---=' $$${AnsiColor.BRIGHT_YELLOW}$$ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ $$${AnsiColor.BRIGHT_GREEN}$$ 佛祖保佑永无BUG 永不修改 $$${AnsiColor.BRIGHT_YELLOW}$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$${AnsiColor.BRIGHT_YELLOW}
实现效果如下图所示:
总结
本文我们讲了自定义 banner 的两种方法,自定义 banner 类和 banner.txt 的方式,其中以源码分析的方式讲了为什么可以通过banner.txt自定义 banner信息。我们还讲了 banner 样式控制(颜色、字体样式等)和全局变量输出的方法,以及 banner 图在线生成的几个地址,最后还讲了 3 种隐藏 banner 的方法。