从0-1了解SpringBoot是如何运行起来的(二):定制你的banner

最深刻了解一个框架的思想的方式,莫过于看源码,本系列旨在于从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
可以看到SpringbootBanner跟咱平常启动的时候看到的banner图是一模一样的。这里咱们可以做点骚操作,定制下自己想要的banner图片。(需要注意的是,定制的图片需要注意尺寸及像素,同时需要放置在Resource目录下,否则ClassPathResource类加载会失败。)
file

像上面一样设置好banner的信息,控制台就可以输出如下的内容啦~:

file

总结

本期相对来说,configureIgnoreBeanInfo和printBanner的源代码都相对简单易读,在spring的启动流程中页相对没有那么重要。但java对于bean的定义、内省机制对我受用良多。同时banner的打印原理、以及如何自定义自己的banner也让我收获颇丰。

参考文献:

小明学Spring基础系列——BeanInfo内省与Spring BeanUtil

本文由博客一文多发平台 OpenWrite 发布!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,084评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,623评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,450评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,322评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,370评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,274评论 1 300
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,126评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,980评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,414评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,599评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,773评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,470评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,080评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,713评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,852评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,865评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,689评论 2 354

推荐阅读更多精彩内容