正文 

当前位置： 首页 > java > java框架

用了自定义banner后，springboot瞬间变的高大上了...

     2022-04-03     124

关键词：

技术图片
这是我的第 51 篇原创文章。
Spring Boot 在启动的时候，我们或许想要把自己公司的 logo，或者是项目的 logo 放上去，我们可以试试本文的这些方法，可以让你快速制作一些 Spring Boot 项目启动时的彩蛋，以提高项目的辨识度，或者是纯碎为了给枯燥的生活平添一些乐趣，那么本文这些内容能很好的帮助到你。
本文知识点，如下图所示：

技术图片

Banner效果展示

Spring Boot 默认的 banner 图展示效果如下：技术图片
我们可以把它变成这样的：
技术图片
或者是这样的：
技术图片
或者是这样的：
技术图片
简直秀的飞起，不但能自定义内容，还能自定义颜色，那接下来我们就来看它是如何实现的吧。
自定义Banner

自定义 banner 的实现方式有两种，一种是通过重写自定义的 Banner 类来实现，另一种通过 txt 文件来实现。
1.重写Banner类

首先，需要自定义类实现 Banner 接口，实现代码如下：

import org.springframework.boot.Banner;
import org.springframework.core.env.Environment;

import java.io.PrintStream;

public class MyBanner implements Banner {
    private static final String BANNER =
            "  ___ ___         .__  .__          
" +
                    " /   |      ____ |  | |  |   ____  
" +
                    "/    ~    \_/ __ |  | |  |  /  _  
" +
                    "    Y    /  ___/|  |_|  |_(  <_> )
" +
                    " \___|_  /  \___  >____/____/\____/ 
" +
                    "       /       /                  ";

    @Override
    public void printBanner(Environment environment, Class<?> sourceClass, PrintStream out) {
        out.println(BANNER);
        out.println();
    }
}

其中 BANNER 变量为自定义 banner 的内容，我这放入了一个 hello，然后在 Spring Boot 启动时设置 Banner 类为自定义类，实现代码如下：

public static void main(String[] args) {
    SpringApplication springApplication = new SpringApplication(DemoApplication.class);
    // 设置自定义 Banner
    springApplication.setBanner(new MyBanner());
    // 启动 Spring Boot
    springApplication.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 源码中得知的，核心源码如下：

class SpringApplicationBannerPrinter {
    static final String BANNER_LOCATION_PROPERTY = "spring.banner.location";
    static final String BANNER_IMAGE_LOCATION_PROPERTY = "spring.banner.image.location";
    static final String DEFAULT_BANNER_LOCATION = "banner.txt";
    static final String[] IMAGE_EXTENSION = new String[]{"gif", "jpg", "png"};
    // 忽略非核心源码
    private Banner getBanner(Environment environment) {
        SpringApplicationBannerPrinter.Banners banners = new SpringApplicationBannerPrinter.Banners();
        // 获取图片形式 banner
        banners.addIfNotNull(this.getImageBanner(environment));
        // 获取文字形式 banner
        banners.addIfNotNull(this.getTextBanner(environment));
        if (banners.hasAtLeastOneBanner()) {
            return banners;
        } else {
            return this.fallbackBanner != null ? this.fallbackBanner : DEFAULT_BANNER;
        }
    }

    private Banner getTextBanner(Environment environment) {
        String location = environment.getProperty("spring.banner.location", "banner.txt");
        Resource resource = this.resourceLoader.getResource(location);
        return resource.exists() ? new ResourceBanner(resource) : null;
    }

    private Banner getImageBanner(Environment environment) {
        String location = environment.getProperty("spring.banner.image.location");
        if (StringUtils.hasLength(location)) {
            Resource resource = this.resourceLoader.getResource(location);
            return resource.exists() ? new ImageBanner(resource) : null;
        } else {
            String[] var3 = IMAGE_EXTENSION;
            int var4 = var3.length;

            for(int var5 = 0; var5 < var4; ++var5) {
                String ext = var3[var5];
                Resource resource = this.resourceLoader.getResource("banner." + ext);
                if (resource.exists()) {
                    return new ImageBanner(resource);
                }
            }
            return null;
        }
    }
}

所以我们才能使用 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} 版本信息。

  • 使用示例如下：

    

  /ˉˉˉˉ     
o-|[][]|-o   
  |_--_|     
/ˉˉˉˉˉˉˉˉˉˉ  
|||  ??  |||  
|||      |||  
(o)|      |(o) 
 |  ||  |    
 |__||__|    
 |__||__|

Spring Boot 版本：${spring-boot.version}

Banner图在线生成

在线生成 banner 的地址：

https://www.bootschool.net/ascii
http://www.network-science.de/ascii/
http://patorjk.com/software/taag/
http://www.degraeve.com/img2txt.php
推荐使用第一种，使用缩略图如下：

![](https://s4.51cto.com/images/blog/202007/30/914c4f7c4d82118c0f4cb7240c97d199.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_100,g_se,x_10,y_10,shadow_90,type_ZmFuZ3poZW5naGVpdGk=)

隐藏Banner

如果我们需要隐藏 banner 信息，可以通过以下三种方法实现。
1.通过代码关闭Banner

我们可以在 Spring Boot 启动（run）之前设置隐藏 banner，实现代码如下：

public class DemoApplication {
public static void main(String[] args) {
SpringApplication springApplication = new SpringApplication(DemoApplication.class);
// 隐藏 banner
springApplication.setBannerMode(Banner.Mode.OFF);
// 启动 Spring Boot
springApplication.run(args);
}
}

2.通过配置文件隐藏Banner

在 Spring Boot 的配置文件 application.properties 通过设置如下配置来隐藏 banner 的显示，配置如下：
`spring.main.banner-mode=off`
3.在Idea中隐藏Banner

我们可以在 Idea 的调试配置中隐藏 banner，如下图所示：
![](https://s4.51cto.com/images/blog/202007/30/c1353d5f5de4abaa44963b8d650f7d57.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_100,g_se,x_10,y_10,shadow_90,type_ZmFuZ3poZW5naGVpdGk=)
附：彩蛋

文章的末尾，附一个七彩佛祖的 banner 内容：

${AnsiColor.BRIGHT_GREEN}$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
${AnsiColor.BRIGHTYELLOW}$$ .ooOoo._ $$
${AnsiColor.BRIGHT_RED}$$ o888888888o $$
${AnsiColor.BRIGHT_CYAN}$$ 88" . "88 $$
${AnsiColor.BRIGHTMAGENTA}$$ (| ^^ |) $$
${AnsiColor.BRIGHT_GREEN}$$ O = /O $$
${AnsiColor.BRIGHT_RED}$$ /`-----‘__ $$
${AnsiColor.BRIGHT_CYAN}$$ .‘ | |$$ `. $$
${AnsiColor.BRIGHT_MAGENTA}$$ / ||| : |||$$ $$
${AnsiColor.BRIGHTGREEN}$$ / ||||| -:- |||||- $$
${AnsiColor.BRIGHT_YELLOW}$$ | | - $$/ | | $$
${AnsiColor.BRIGHTGREEN}$$ | | ‘‘-----/‘‘ | | $$
${AnsiColor.BRIGHTYELLOW}$$ .- - __/-. / $$
${AnsiColor.BRIGHTCYAN}$$ . .‘ /--.--. . _ $$
${AnsiColor.BRIGHT_RED}$$ ."" ‘< `.___<|>_/__.‘ >‘"". $$
${AnsiColor.BRIGHTGREEN}$$ | | : - .;`. /`;./ - : | | $$<br/>${AnsiColor.BRIGHT_YELLOW}$$ -. _ __ / _/ .-/ / $$<br/>${AnsiColor.BRIGHT_CYAN}$$ ========-.`-._/.-____.-‘======== $$<br/>${AnsiColor.BRIGHT_MAGENTA}$$=---=‘ $$
${AnsiColor.BRIGHT_YELLOW}$$ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ $$
${AnsiColor.BRIGHT_GREEN}$$ 佛祖保佑 永无BUG 永不修改 $$
${AnsiColor.BRIGHT_YELLOW}$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
${AnsiColor.BRIGHT_YELLOW}


实现效果如下图所示：
![](https://s4.51cto.com/images/blog/202007/30/4f8a6e315d7868faf17211a9d8287b8f.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_100,g_se,x_10,y_10,shadow_90,type_ZmFuZ3poZW5naGVpdGk=)

总结

本文我们讲了自定义 banner 的两种方法，自定义 banner 类和 banner.txt 的方式，其中以源码分析的方式讲了为什么可以通过 banner.txt 自定义 banner信息。我们还讲了 banner 样式控制（颜色、字体样式等）和全局变量输出的方法，以及 banner 图在线生成的几个地址，最后还讲了 3 种隐藏 banner 的方法。
最后的话

认真写好每一篇原创，只为不辜负你的观看。写作是一件很酷并且能帮助他人的事，我希望能一直坚持下去。如果觉得有用，请随手给我一个赞吧，他将鼓励我产出更好的文章。
参考 & 鸣谢

https://www.jianshu.com/p/c1f7617c99aa
https://www.jianshu.com/p/9a2c20e3766d

END

别再问我 new 字符串创建了几个对象了！我来证明给你看！

史上最全的延迟任务实现方式汇总！附代码（强烈推荐）

![](https://s4.51cto.com/images/blog/202007/30/b7ef1f808c828df7f1dcff92b74b75b9.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_100,g_se,x_10,y_10,shadow_90,type_ZmFuZ3poZW5naGVpdGk=)
关注公众号发送”进群“，老王拉你进读者群。

自定义花里胡哨的banner.txt在springboot编译和运行显示

参考技术A我们注意到springboot项目启动时，控制台会打印自带的banner，如何改成自己秀一把才符合程序员的个性。只需要在springboot项目的resources文件夹下面创建一个banner.txt文件，springboot启动的时候会去加载这个文件，项目结构... 查看详情

springboot开发-如何定制自己的banner？还能用图片？

我们在启动SpringBoot程序时，有SpringBoot的Banner信息，那么如何自定义成自己项目的信息呢？@pdai什么是Banner我们在启动SpringBoot程序时，有如下Banner信息：那么如何自定义成自己项目的名称呢？如何更改Banner更改Banner有如下几种方... 查看详情

springboot有趣的banner

效果图  1.SpringBoot自定义启动Banner在线生成工具地址：https://www.bootschool.net/ascii2.在resources目录底下新建一个banner.txt文件把复制的ASCII文字粘贴进去  注意：看前面的小标志，出现了代表识别成功  查看详情

springboot自定义banner—卡塔尔世界杯吉祥物(代码片段)

自定义banner文件SpringBoot项目在启动的时候，会有一个大大的Spring首先展示出来._________/\\\\/___'_____(_)______\\\\\\\\(()\\___|'_|'_||'_\\/_`|\\\\\\\\\\\\/___)||_)|||||||(_||))))'|____|.__|_||_|_||_\\__,|////=======&... 查看详情

linux登录banner自定义

参考技术A前面一篇文章《SpringBoot启动banner定制》讲到了关于Banner的一些情况。在Linux登录的时候，我们也可以自定义登录系统时候的Banner信息首先，我们还是通过网站http://network-science.de/ascii/来自定义我们的Banner的艺术形式。如... 查看详情

springboot开发

SpringBoot开发-如何定制自己的Banner？还能用图片？我们在启动SpringBoot程序时，有SpringBoot的Banner信息，那么如何自定义成自己项目的信息呢？@pdaiSpringBoot开发-如何定制自己的Banner？还能用图片？什么是Banner如何更更多文章请参考[... 查看详情

springboot管理banner

一、引言在springboot项目启动的时候，会在console控制台中打印出一个SPRING的图案。有时候为了减少日志输出以及控制台的输出，就需要将这些给去除；有时候需要换上个人的标签等标识，就需要将其自定义为个人标识。二、Banner... 查看详情

springboot--banner的定制和关闭

SpringBoot项目启动的时候控制台会打印如下信息：上面红色框框内的“SPRINGBOOT”被称为Banner，意为横幅，默认会开启并在控制台打印，其实我们可以修改它的内容和样式，即定制；并选择是否开启及开启后将其输出到哪里... 查看详情

3.springboot之修改启动时的默认图案banner

一、SpringBoot的默认启动图案在SpringBoot启动的时候，默认的会展示出一个spring的logo,这个图案我们用户是可以自定义的 二、自定义启动图案方法一：Application中控制图案显示@SpringBootApplicationpublicclassHelloSpringBootApplication{publicsta... 查看详情

springboot:启动banner在线生成工具(代码片段)

 我们在启动SpringBoot时，控制台会打印SpringBootLogo以及版本信息；这个操作是可以通过SpringBoot的banner自定义实现  .  ____         _           ____ /\\\\/___'_____(_)___ ___\\\\\\\\(()\\___| '_|'_||'_\\/_ 查看详情

springboot设置自定义启动背景图教程

-------佛祖保佑永无BUG-----------佛祖保佑必发大财--------佛祖保佑毛发旺盛---------项目resources文件下新建banner.txt文件 banner.txt 代码$AnsiColor.BLUE-------------------------------阿弥陀佛------------------------------------------------ 查看详情

springboot中的配置文件详解(ymlproperties全局配置和自定义配置有趣的banner图配置)(代码片段)

...配置文件全局配置文件能够对一些默认配置值进行修改。SpringBoot使用一个application.properties或者application.yaml的文件作为全局配置文件，该文件存放在src/main/resource目录或者类路径的/config，一般会选择resource目录。接下来，将针对... 查看详情

springboot2.0(一）：springboot2.0尝鲜-动态banner

SpringBoot2.0提供了很多新特性，其中就有一个小彩蛋：动态Banner，今天我们就先拿这个来尝尝鲜SpringBoot更换Banner我们先来回顾一下在SpringBoot1.0中如何更换启动Banner，其实都很简单，只需要在src/main/resources路径下新建一个banner.txt... 查看详情

springboot关闭banner

在上一篇博客中，我们使用IDEA新建了一个SpringBoot项目，也启动了项目，知道默认的端口号是8080，其实启动时我们已经看到了SpringBoot的Banner，那么你不禁要问什么是SpringBoot的Banner呢？其实就是下图中红色标记的地方也许有人会... 查看详情

我把springboot的banner换成了美女，老板说工作不饱和，建议安排加班...(代码片段)

👇👇关注后回复 “进群” ，拉你进程序员交流群👇👇来源：https://blog.csdn.net/wojiaohb/article/details/106146821一：banner.txt在SpringBoot项目的resources目录下新建一个banner.txt文本文件， 查看详情

springboot配置启动banner图

1、在resource目录下新建banner.txt文件 2、访问网站http://patorjk.com/software/taag，生成想要的文字图案3、将生成的文字拷贝到banner.txt中重启项目即可 4、关闭启动banner图publicstaticvoidmain(String[]args){SpringApplicationrunner=newSpringApp 查看详情

升级springboot2.6.x版本后，swagger没法用了

参考技术A首先我们来聊聊SpringBoot的版本，目前最新版本是2.6.4版本，2.7.x即将发布，2.4.x及以下版本已经停止维护了，目前的主流版本应该是2.5.x和2.6.x。具体可以看下下面这张表。首先在pom.xml中修改SpringBoot的版本号，注意从2.4.... 查看详情

我把springboot的banner换成了美女；老板：工作不饱和，建议加班

...操作，场主日常惊呆，我们一起康康。。一：banner.txt在SpringBoot项目的resources目录下新建一个banner.txt文本文件，然后将启动Banner粘贴到此文本文件中，启动项目即可。二：在线制作banner很多公司的banner为自己公司的名称或者产品... 查看详情