开发者社区> 磊哥聊Java> 正文

用了自定义Banner后,SpringBoot瞬间变的高大上了...(上)

简介: 用了自定义Banner后,SpringBoot瞬间变的高大上了...
+关注继续查看

Spring Boot 在启动的时候,我们或许想要把自己公司的 logo,或者是项目的 logo 放上去,我们可以试试本文的这些方法,可以让你快速制作一些 Spring Boot 项目启动时的彩蛋,以提高项目的辨识度,或者是纯碎为了给枯燥的生活平添一些乐趣,那么本文这些内容能很好的帮助到你。


本文知识点,如下图所示:


image.png


Banner效果展示


Spring Boot 默认的 banner 图展示效果如下:


image.png


我们可以把它变成这样的:


image.png


者是这样的:


image.png


或者是这样的:


image.png


简直秀的飞起,不但能自定义内容,还能自定义颜色,那接下来我们就来看它是如何实现的吧。


自定义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 =
            "  ___ ___         .__  .__          \n" +
                    " /   |   \\   ____ |  | |  |   ____  \n" +
                    "/    ~    \\_/ __ \\|  | |  |  /  _ \\ \n" +
                    "\\    Y    /\\  ___/|  |_|  |_(  <_> )\n" +
                    " \\___|_  /  \\___  >____/____/\\____/ \n" +
                    "       \\/       \\/                  ";

    @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);
}


最终的执行效果如下图所示:


image.png


2.通过txt文件实现


我们可以在 Spring Boot 工程的 /src/main/resources 目录下创建一个 banner.txt 文件,然后将 ASCII 字符画复制进去,就能替换默认的 banner 了,如下图所示:


image.png


之所以可以使用 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 的效果,动手试试吧。


此种方式实现起来比较简单,且是无代码侵入式的,推荐使用这种方式。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
阿里云体验与感受
记录第一次成功运行自己的项目以及使用感受
5 0
Java 8 新特性:泛型目标类型推断
Java 8 新特性:泛型目标类型推断
6 0
第八章 自定义Android Gradle工程
Android Gradle为我们提供了大量的DSL,我们使用这些DSL定义配置我们的工程以满足我们项目中不同的需求。这些DSL有很多,在上一章演示Android Gradle工程示例的时候,我们已经大概介绍了compileSdkVersion、buildToolsVersion以及defaultConfig等,这一章我们再详细介绍一些常用的DSL配置,这些配有有签名信息、构建类型、代码混淆、zipAlign对齐压缩等。
7 0
Java 8 新特性:Java 类库的新特性之 Optional类
Java 8 新特性:Java 类库的新特性之 Optional类
5 0
ECS使用体验
在了解到相关文章“飞天加速计划·高校学生在家实践”活动,本人积极参与该活动,为此特撰写了一篇ECS使用体验。
11 0
Linux/JavaWeb - JDK环境搭建 & Web运行环境配置 & Java项目部署发布(附:解决Linux防火墙限制问题)
Linux/JavaWeb - JDK环境搭建 & Web运行环境配置 & Java项目部署发布(附:解决Linux防火墙限制问题)
5 0
第七章 Android Gradle插件
从这章开始我们就开始介绍Android Gradle插件了,会通过几章由浅入深的详细的介绍Android Gradle,本章会简单的介绍下Android Gradle插件,然后通过一个例子对其有大概的了解,最后讲下如果从原来基于Eclipse进行Android开发的方式,转到基于Android Studio,使用Android Gradle插件开发的新方式 7.1 Android Gradle插件简介
4 0
Java 8 新特性:Java 类库的新特性之日期时间API (Date/Time API )
Java 8 新特性:Java 类库的新特性之日期时间API (Date/Time API )
4 0
2020前端该如何脱颖而出(一)
2020前端该如何脱颖而出(一)
6 0
+关注
磊哥聊Java
是非审之于己,毁誉听之于人,得失安之于数。欢迎关注我的公众号「Java中文社群」
760
文章
1
问答
文章排行榜
最热
最新
相关电子书
更多
OceanBase 入门到实战教程
立即下载
阿里云图数据库GDB,加速开启“图智”未来.ppt
立即下载
实时数仓Hologres技术实战一本通2.0版(下)
立即下载