从0-1了解SpringBoot是如何运行起来的（二）：定制你的banner

原来是笑傲菌殿下

已于 2022-04-10 17:23:47 修改

阅读量575

点赞数

分类专栏： Springboot JAVA 文章标签：后端 java SpringBoot

于 2022-04-10 17:20:26 首次发布

本文链接：https://blog.csdn.net/Laugh_xiaoao/article/details/124081940

版权

JAVA 同时被 2 个专栏收录

22 篇文章 3 订阅

订阅专栏

Springboot

14 篇文章 0 订阅

订阅专栏

本文详细解析了SpringBoot启动过程中`configureIgnoreBeanInfo`和`printBanner`的源码，探讨了JavaBean、内省机制以及SpringBoot禁用内省的原因，同时介绍了自定义Banner的实现方式，帮助读者更深入地理解SpringBoot的启动流程和性能优化策略。

摘要由CSDN通过智能技术生成

最深刻了解一个框架的思想的方式，莫过于看源码，本系列旨在于从Springboot底层源码（Version - 2.6.6）出发，一步步了解springboot是如何运行起来的。

前言

上期我们聊了Spring是如何装配环境的。这期我们来接着往下看，一同来了解springBoot是如何加载出banner图片信息的。

public ConfigurableApplicationContext run(String... args) {
    StopWatch stopWatch = new StopWatch(); 
    stopWatch.start();
    ConfigurableApplicationContext context = null;
    Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList();
    this.configureHeadlessProperty(); 
    SpringApplicationRunListeners listeners = this.getRunListeners(args);
    listeners.starting();
    Collection exceptionReporters;
    try {
        //step 2 配置BeanInfo 及 banner配置
        configureIgnoreBeanInfo(environment);
        Banner printedBanner = printBanner(environment);
		......
    } catch (Throwable var10) {
        this.handleRunFailure(context, var10, exceptionReporters, listeners);
        throw new IllegalStateException(var10);
    }
	
    ......
}

configureIgnoreBeanInfo

紧接着上一篇文章中介绍的配置好了相应的初始环境environment后，Spring调用了configureIgnoreBeanInfo的方法。

private void configureIgnoreBeanInfo(ConfigurableEnvironment environment) {
   if (System.getProperty(CachedIntrospectionResults.IGNORE_BEANINFO_PROPERTY_NAME) == null) {
      Boolean ignore = environment.getProperty("spring.beaninfo.ignore", Boolean.class, Boolean.TRUE);
      System.setProperty(CachedIntrospectionResults.IGNORE_BEANINFO_PROPERTY_NAME, ignore.toString());
   }
}

这里的内容其实比较容易理解，就是首先判断当前系统内是否已经有IGNORE_BEANINFO_PROPERTY_NAME对应的对象，如果没有，那么此时会从相应的environment中去获取，且默认设置为true。

那么问题来了，这个"spring.beaninfo.ignore"是个什么东西？要起的又是什么作用呢？要了解Springboot为什么要设置这个属性，就不得不先聊到JAVA的Bean和内省机制

Java Bean

根据维基百科对于JavaBean的定义：JavaBeans是Java中一种特殊的类，可以将多个对象封装到一个对象（bean）中。特点是可序列化，提供无参构造器，提供getter方法和setter方法访问对象的属性。其规范如下：

有一个public的无参数构造器。
属性可以通过get、set、is（可以替代get，用在布尔型属性上）方法或遵循特定命名规范的其他方法访问。
可序列化。

内省机制

内省机制听着很陌生，但其实在我们的日常编程中其实使用的很多。举个例子，如我们常使用的**@RequestBody注解、BeanUtil.copyProperties方法**等都是使用了这个机制。

在使用这些注解和方法的时候，你是否有疑惑，SpringBoot是如何将前端的Json数据，映射成后端的类对象的呢？BeanUtil是如何方便的将两个不同类同名的对象进行复制的呢？这其实就是内省机制的体现。这里我们简单实现一下，假设现在有一个对象CalcPriceParam：

public class CalcPriceParam {
    int type;

    BigDecimal price;
   
    String person;
}

这个时候我们想获取他的属性的名称信息，那么我们就可以使用bean的内省机制。

// 在Object类时候停止检索，可以选择在任意一个父类停止
BeanInfo beanInfo = Introspector.getBeanInfo(CalcPriceParam.class,Object.class);

获取到的对象beanInfo信息就如下所示：

file

可以看到，我们轻松获得了CalcPriceParam类对应的变量信息。那么为什么SpringBoot需要禁用这种机制呢？主要的原因在于，自省机制底层是基于反射的，其速度会比单纯的采用gettter、setter方法慢上近5倍。会很大程度的拖垮程序的性能，因此难怪springboot需要禁用这种机制了。

printBanner

紧接着来到printBanner这一部分，这一部分其实相对轻松，主要是针对Spring内的Banner的输出进行控制的。关键代码先罗列如下：

private Banner printBanner(ConfigurableEnvironment environment) {
    //判断当前是否禁止输出banner
   if (this.bannerMode == Banner.Mode.OFF) {
      return null;
   }
    //设置ResourceLoader，这里其实是对文件流的一个封装对象。
   ResourceLoader resourceLoader = (this.resourceLoader != null) ? this.resourceLoader
         : new DefaultResourceLoader(null);
    //根据文件流设置相应的banner打印机
   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);
}

这一段的逻辑并不复杂，达至的逻辑是先定义出资源加载器和banner打印机，再根据相应的banner模式进行输出打印。紧跟着我们追入 bannerPrinter.print的代码中：

Banner print(Environment environment, Class<?> sourceClass, Log logger) {
   Banner banner = getBanner(environment);
   try {
      logger.info(createStringFromBanner(banner, environment, sourceClass));
   }
   catch (UnsupportedEncodingException ex) {
      logger.warn("Failed to create String for banner", ex);
   }
   return new PrintedBanner(banner, sourceClass);
}

可以看到，print的关键方法其实是getBanner。其源代码如下：

private Banner getBanner(Environment environment) {
   Banners banners = new Banners();
    //找到spring.banner.image.location下的"gif", "jpg", "png"图片作为banner
   banners.addIfNotNull(getImageBanner(environment));
    //找到spring.banner.location下的
   banners.addIfNotNull(getTextBanner(environment));
   if (banners.hasAtLeastOneBanner()) {
      return banners;
   }
   if (this.fallbackBanner != null) {
      return this.fallbackBanner;
   }
   return DEFAULT_BANNER;
}

很显然，这里的代码提示Spring支持两种banner的形式，一种为图片的形式、另外一种为Text文本的形式。其原理是找到对应environment中的配置路径（文本为：spring.banner.location；图片为：spring.banner.image.location），采用resourceLoader对相应的图片或文本进行加载。但是如果没有找到，则采用默认的banner图片信息：

file