07--SpringBoot启动之自定义打印Banner

SpringBoot控制台打印Banner可以在properties文件里开启或关闭spring.main.show_banner=false
但是打印Banner功能是如何实现呢?如何自定义打印自己的Banner呢?
继续run方法之前我们先来了解下Banner打印的模式
Banner接口的Mode枚举定义了三种模式:

enum Mode {
    //关闭
    OFF,
    //打印控制台
    CONSOLE,
    //打印到文件
    LOG
}

了解了banner的模式,继续run方法

//打印banner
Banner printedBanner = printBanner(environment);

private Banner printBanner(ConfigurableEnvironment environment) {
    // 如果未开启banner打印直接返回
    if (this.bannerMode == Banner.Mode.OFF) {
        return null;
    }
    // 创建ResourceLoader对象
    ResourceLoader resourceLoader = (this.resourceLoader != null) ? this.resourceLoader : new DefaultResourceLoader(getClassLoader());
    // 创建SpringApplicationBannerPrinter,该对象用来打印banner
    SpringApplicationBannerPrinter bannerPrinter = new SpringApplicationBannerPrinter(resourceLoader, this.banner);
    // 如果bannerMode模式为LOG,则将banner打印到log文件里
    if (this.bannerMode == Mode.LOG) {
        return bannerPrinter.print(environment, this.mainApplicationClass, logger);
    }
    // 打印banner到控制台
    return bannerPrinter.print(environment, this.mainApplicationClass, System.out);
}

分析print方法,分为获取banner和打印banner两部分,逐步分析

// 打印banner
public Banner print(Environment environment, Class<?> sourceClass, PrintStream out) {
    // 获取banner
    Banner banner = getBanner(environment);
    // 打印
    banner.printBanner(environment, sourceClass, out);
    // 返回PrintedBanner对象,PrintedBanner实现了Banner接口
    return new PrintedBanner(banner, sourceClass);
}

1. 获取banner

// 获取banner
private Banner getBanner(Environment environment) {
    // 创建Banners对象,保存获取到的banner
    Banners banners = new Banners();
    // 如果图片banner不为空,则加入到Banners对象的banners集合中
    banners.addIfNotNull(getImageBanner(environment));
    // 如果文字banner不为空,则加入到Banners对象的banners集合中
    banners.addIfNotNull(getTextBanner(environment));
    // 如果至少获取到一个图片banner或文字banner,则返回
    if (banners.hasAtLeastOneBanner()) {
        return banners;
    }
    // 如果fallbackBanner不为null,则返回(下面详解fallbackBanner作用)
    if (this.fallbackBanner != null) {
        return this.fallbackBanner;
    }
    // 上述banner都未获取到,返回默认banner
    return DEFAULT_BANNER;
}

可以看到,获取的banner一共有四个步骤,逐步分析

1.1 获取图片banner

// 获取图片banner
private Banner getImageBanner(Environment environment) {
    // 如果在配置文件中自定义了spring.banner.image.location属性,则优先返回
    // spring.banner.image.location=classpath:myBanner.gif
    String location = environment.getProperty(BANNER_IMAGE_LOCATION_PROPERTY);
    if (StringUtils.hasLength(location)) {
        Resource resource = this.resourceLoader.getResource(location);
        return resource.exists() ? new ImageBanner(resource) : null;
    }
    // 循环{ "gif", "jpg", "png" }扩展名,并从resources目录下依次查找,按扩展名排序返回第一个
    for (String ext : IMAGE_EXTENSION) {
        Resource resource = this.resourceLoader.getResource("banner." + ext);
        if (resource.exists()) {
            return new ImageBanner(resource);
        }
    }
    return null;
}

1.2 获取文字banner

//获取文字banner
private Banner getTextBanner(Environment environment) {
    // getProperty()方法并不是同时返回两个资源,而是
    // 如果用户自定义了spring.banner.location则返回spring.banner.location的资源位置
    // 否则返回banner.txt的资源位置
    String location = environment.getProperty(BANNER_LOCATION_PROPERTY,DEFAULT_BANNER_LOCATION);
    // 从并从resources目录下查找资源并返回
    Resource resource = this.resourceLoader.getResource(location);
    if (resource.exists()) {
        return new ResourceBanner(resource);
    }
    return null;
}

1.3 获取fallbackBanner

// 如果fallbackBanner不为null,则返回(下面详解fallbackBanner作用)
if (this.fallbackBanner != null) {
    return this.fallbackBanner;
}

如果上述两个方法都没有找到对应的banner,那么会判断fallbackBanner是否为null,不为null则返回,那么fallbackBanner怎么使用呢?在SpringApplication.java文件中有如下方法,大家可以猜想到,是手动设置该banner

public void setBanner(Banner banner) {
    this.banner = banner;
}
// 在BannerTest类中,有
@Test
public void testCustomBanner() {
    SpringApplication application = createSpringApplication();
    application.setBanner(new DummyBanner());
    this.context = application.run();
    assertThat(this.out.toString()).contains("My Banner");
}

即手动创建SpringApplication对象后,调动其setBanner方法设置fallbackBanner

1.4 获取默认banner

如果上述三种方式都没获取到banner怎么办呢?返回默认banner
private static final Banner DEFAULT_BANNER = new SpringBootBanner();
打开SpringBanner类,熟悉的banner出现了...

class SpringBootBanner implements Banner {

    private static final String[] BANNER = { "",
            "  .   ____          _            __ _ _",
            " /\\\\ / ___'_ __ _ _(_)_ __  __ _ \\ \\ \\ \\",
            "( ( )\\___ | '_ | '_| | '_ \\/ _` | \\ \\ \\ \\",
            " \\\\/  ___)| |_)| | | | | || (_| |  ) ) ) )",
            "  '  |____| .__|_| |_|_| |_\\__, | / / / /",
            " =========|_|==============|___/=/_/_/_/" };

    private static final String SPRING_BOOT = " :: Spring Boot :: ";

    private static final int STRAP_LINE_SIZE = 42;

    @Override
    public void printBanner(Environment environment, Class<?> sourceClass,
            PrintStream printStream) {
        for (String line : BANNER) {
            printStream.println(line);
        }
        String version = SpringBootVersion.getVersion();
        version = (version != null) ? " (v" + version + ")" : "";
        StringBuilder padding = new StringBuilder();
        while (padding.length() < STRAP_LINE_SIZE
                - (version.length() + SPRING_BOOT.length())) {
            padding.append(" ");
        }

        printStream.println(AnsiOutput.toString(AnsiColor.GREEN, SPRING_BOOT,
                AnsiColor.DEFAULT, padding.toString(), AnsiStyle.FAINT, version));
        printStream.println();
    }

}

上面就分析了SpringBoot是如何打印banner,包括如何自定义banner,大家可以打开spring-boot-sample-simple工程的resources目录,可以看到有banner.jpg和banner.txt两个文件,这个就是自定义的banner文件,大家可以替换成自己的banner,就能实现自定义banner的打印了

2. 打印banner

循环打印所有获取到的banner

public void printBanner(Environment environment, Class<?> sourceClass,PrintStream out) {
    for (Banner banner : this.banners) {
        banner.printBanner(environment, sourceClass, out);
    }
}

打印banner的代码比较简单,就不在粘贴分析了,大家可debug跟踪下,打印图片也有两种方式

图片banner-->ImageBanner类的printBanner方法
文字banner-->ResourceBanner类的printBanner方法
今天就分析到这里了...