Spring Boot 自定义控制台输出banner

今天在工作中发现公司原始项目中控制台输出不是SpringBoot默认的。如下图：

心中不免产生疑惑，那这个图片是哪里来的呢？于是开始了debug ,对，没错就是debug(ps：我以为能找到加载的)，但是Spring Boot逐步debug很难找。虽然后续找到了，但是看的眼花缭乱。

实现方式

在对应项目的resources目录下建一个banner.txt文件，将对应的图标存入里面即可。Spring Boot在加载时会自动载入该文件，并输出替换。

Spring Boot源码

在spring-boot.jar下有个SpringApplicationBannerPrinter，在这个类中实现了对应文件加载方式。源码如下：

package org.springframework.boot;

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.logging.Log;
import org.springframework.core.env.Environment;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.util.StringUtils;

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"};
    // 文件不存在创建默认banner
    private static final Banner DEFAULT_BANNER = new SpringBootBanner();
    private final ResourceLoader resourceLoader;
    private final Banner fallbackBanner;

    SpringApplicationBannerPrinter(ResourceLoader resourceLoader, Banner fallbackBanner) {
        this.resourceLoader = resourceLoader;
        this.fallbackBanner = fallbackBanner;
    }

    public Banner print(Environment environment, Class<?> sourceClass, Log logger) {
        Banner banner = this.getBanner(environment);

        try {
            logger.info(this.createStringFromBanner(banner, environment, sourceClass));
        } catch (UnsupportedEncodingException var6) {
            logger.warn("Failed to create String for banner", var6);
        }

        return new SpringApplicationBannerPrinter.PrintedBanner(banner, sourceClass);
    }

    public Banner print(Environment environment, Class<?> sourceClass, PrintStream out) {
        Banner banner = this.getBanner(environment);
        banner.printBanner(environment, sourceClass, out);
        return new SpringApplicationBannerPrinter.PrintedBanner(banner, sourceClass);
    }

    private Banner getBanner(Environment environment) {
        SpringApplicationBannerPrinter.Banners banners = new SpringApplicationBannerPrinter.Banners();
        banners.addIfNotNull(this.getImageBanner(environment));
        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;
        }
    }

    private String createStringFromBanner(Banner banner, Environment environment, Class<?> mainApplicationClass) throws UnsupportedEncodingException {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        banner.printBanner(environment, mainApplicationClass, new PrintStream(baos));
        String charset = environment.getProperty("spring.banner.charset", "UTF-8");
        return baos.toString(charset);
    }

    private static class PrintedBanner implements Banner {
        private final Banner banner;
        private final Class<?> sourceClass;

        PrintedBanner(Banner banner, Class<?> sourceClass) {
            this.banner = banner;
            this.sourceClass = sourceClass;
        }

        public void printBanner(Environment environment, Class<?> sourceClass, PrintStream out) {
            sourceClass = sourceClass != null ? sourceClass : this.sourceClass;
            this.banner.printBanner(environment, sourceClass, out);
        }
    }

    private static class Banners implements Banner {
        private final List<Banner> banners;

        private Banners() {
            this.banners = new ArrayList();
        }

        public void addIfNotNull(Banner banner) {
            if (banner != null) {
                this.banners.add(banner);
            }

        }

        public boolean hasAtLeastOneBanner() {
            return !this.banners.isEmpty();
        }

        public void printBanner(Environment environment, Class<?> sourceClass, PrintStream out) {
            Iterator var4 = this.banners.iterator();

            while(var4.hasNext()) {
                Banner banner = (Banner)var4.next();
                banner.printBanner(environment, sourceClass, out);
            }

        }
    }
}

源码、算法、问题解决方法，更多请关注：https://totalo.top
btw,点点ads,哈哈哈哈哈哈