Springboot启动画面「banner」显示设置与源码解析

àì夳堔傛蜴生んèń 2023-06-26 12:20 37阅读 0赞

基于springboot版本：2.2.2.RELEASE

Springboot启动图案的修改，网上教程很多，这里不再多说

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70][]

修改这个图案的方法如下：

在resources/目录下创建名为banner.txt的文件，banner.txt里写入需要显示的内容即可

内容可从 [http://patorjk.com/software/taag/  制作][http_patorjk.com_software_taag_]

这里主要是想记录一下**如何关闭**这个的显示：

**方法一：**删除banner.txt 内容

**方法二：**启动时设置

SpringApplication app = new SpringApplication(DemoApplication.class);
    		app.setBannerMode(Banner.Mode.OFF);
    		app.run(args);

**方法三：**配置文件修改：

spring:
      main:
        banner-mode: off

扩展一下：

Banner.Mode可选值

@FunctionalInterface
    public interface Banner {
    	void printBanner(Environment environment, Class<?> sourceClass, PrintStream out);
    	enum Mode {
    
    		/**
    		 * Disable printing of the banner.
    		 */
    		OFF,
    
    		/**
    		 * Print the banner to System.out.
    		 */
    		CONSOLE,
    
    		/**
    		 * Print the banner to the log file.
    		 */
    		LOG
    
    	}
    
    }

spring.main.banner-mode可选值： {off | console | log}

**研究一下：**

Springboot自动生成时默认的启动入口：SpringApplication.run(DemoApplication.class, args);

download源码看一下SpringApplication.java 可以看到

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 1][]

从入口看banner打印过程：

1. 启动

![20200101181529424.png][]

![20200101181622232.png][]

2. 配置初始化

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 2][]

3. 影响因素：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 3][]

分析：

只有banner.mode=off的情况下才不会生效（对应方法二、三）

在哪打印的呢？研究一下bannerPrinter.print () 这个方法

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 4][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 5][]

这里有个注意事项，当banner.txt 文件编码不为utf-8时这里有解决方案

关于banner.txt，可以参考\{bannerPrinter.print () 中\}：

Banner banner = getBanner(environment);

banner.txt路径定义在：

org.springframework.boot.SpringApplicationBannerPrinter.DEFAULT_BANNER_LOCATION

参考资料（未经本人验证）

[亲手实现banner图案：https://www.cnblogs.com/niumoo/p/10434746.html][banner_https_www.cnblogs.com_niumoo_p_10434746.html]

[banner制作（图片及文字）：https://www.jianshu.com/p/e75c73e6b286][banner_https_www.jianshu.com_p_e75c73e6b286]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200101173424330.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[http_patorjk.com_software_taag_]: http://patorjk.com/software/taag/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200101181111143.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[20200101181529424.png]: https://img-blog.csdnimg.cn/20200101181529424.png
[20200101181622232.png]: https://img-blog.csdnimg.cn/20200101181622232.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200101181448398.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200101181741950.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200101182035978.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200101182106396.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[banner_https_www.cnblogs.com_niumoo_p_10434746.html]: https://www.cnblogs.com/niumoo/p/10434746.html
[banner_https_www.jianshu.com_p_e75c73e6b286]: https://www.jianshu.com/p/e75c73e6b286