SpringBoot源码-Spring Boot启动时控制台为何会打印logo以及自定义banner.txt文件控制台打印
1.当我们启动一个SpringBoot项目的时候，入口程序就是main方法，而在main方法中就执行了一个run方法。
@SpringBootApplication
public class StartApp {
public static void main(String[] args) {
// test
SpringApplication.run(StartApp.class);
}
}
public static ConfigurableApplicationContext run(Class<?>[] primarySources, String[] args) {
// 创建了一个SpringApplication对象，并调用其run方法
// 1.先看下构造方法中的逻辑
// 2.然后再看run方法的逻辑
return new SpringApplication(primarySources).run(args);
}
2.SpringApplication.run方法
public static ConfigurableApplicationContext run(Class<?> primarySource, String... args) {
// 调用重载的run方法，将传递的Class对象封装为了一个数组
return run(new Class<?>[] { primarySource }, args);
}
3.输出自定义banner.txt的方法就是:
// 输出的Banner信息
Banner printedBanner = printBanner(environment);
在当前项目的资源目录下，定义了一个banner.txt内容如下，接下来讲解这个txt的内容是如何输出到控制台的。
进入printBanner这个方法:
Banner.Mode有三个枚举值:
enum Mode {
/**
* 禁用打印横幅
*/
OFF,
/**
* 打印横幅到System.out。
*/
CONSOLE,
/**
* 将横幅打印到日志文件中。
*/
LOG
}
this.bannerMode 是默认的
Banner.Mode bannerMode = Banner.Mode.CONSOLE;这里会输出到控制台
private Banner printBanner(ConfigurableEnvironment environment) {
if (this.bannerMode == Banner.Mode.OFF) {
return null;
}
ResourceLoader resourceLoader = (this.resourceLoader != null) ? this.resourceLoader
: new DefaultResourceLoader(getClassLoader());
SpringApplicationBannerPrinter bannerPrinter = new SpringApplicationBannerPrinter(resourceLoader, this.banner);
if (this.bannerMode == Mode.LOG) {
return bannerPrinter.print(environment, this.mainApplicationClass, logger);
}
return bannerPrinter.print(environment, this.mainApplicationClass, System.out);
}
这里会进入最后一个return bannerPrinter.print(environment, this.mainApplicationClass, System.out);
Banner print(Environment environment, Class<?> sourceClass, PrintStream out) {
Banner banner = getBanner(environment);
banner.printBanner(environment, sourceClass, out);
return new PrintedBanner(banner, sourceClass);
}
getBanner方法会选择图片或者是文字打印输出内容，这里是txt直接进入getTextBanner
private Banner getBanner(Environment environment) {
Banners banners = new Banners();
banners.addIfNotNull(getImageBanner(environment));
banners.addIfNotNull(getTextBanner(environment));
if (banners.hasAtLeastOneBanner()) {
return banners;
}
if (this.fallbackBanner != null) {
return this.fallbackBanner;
}
return DEFAULT_BANNER;
}
getTextBanner实现细节如下:
这里没有配置BANNER_LOCATION_PROPERTY 所以location 会是banner.txt。
static final String BANNER_LOCATION_PROPERTY = "spring.banner.location";
static final String DEFAULT_BANNER_LOCATION = "banner.txt";
private Banner getTextBanner(Environment environment) {
String location = environment.getProperty(BANNER_LOCATION_PROPERTY, DEFAULT_BANNER_LOCATION);
Resource resource = this.resourceLoader.getResource(location);
if (resource.exists()) {
return new ResourceBanner(resource);
}
return null;
}
getBanner有一个DEFAULT_BANNER，这个默认的内容如下:
private static final Banner DEFAULT_BANNER = new SpringBootBanner();
SpringBootBanner内容如下:
这个输出就是springBoot默认启动输出的logo,因为这里自定义了txt所以不会输出这个。
得到banner之后开始打印到控制台的逻辑了
banner.printBanner(environment, sourceClass, out);实现如下:
继续printBanner：
这里，自定义的banner就完成了打印功能。
原文地址：https://blog.csdn.net/qq_37200262/article/details/143587309
免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！