spring boot的一些简单源码随笔

banner

banner 的设置方式一共分为以下几种方式

1. 兜底banner   
2. 图片banner 
3.  txt banner 
4. 关闭banner

目的 

我们来查看源码分析banner的基本实现，从原理上把banner的配置弄明白，以后就不用死记硬背banner的配置了

代码分析

首先进到SpringApplication  的run() 方法，printBanner（）这是我们banner的获取逻辑也是我们重点分析的地方。

public ConfigurableApplicationContext run(String... args) {
		StopWatch stopWatch = new StopWatch();
		stopWatch.start();
		ConfigurableApplicationContext context = null;
		Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
		configureHeadlessProperty();
		SpringApplicationRunListeners listeners = getRunListeners(args);
		listeners.starting();
		try {
			ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
			ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);
			configureIgnoreBeanInfo(environment);
            //这是我们banner的获取逻辑也是我们重点分析的地方
			Banner printedBanner = printBanner(environment);
			context = createApplicationContext();
			exceptionReporters = getSpringFactoriesInstances(SpringBootExceptionReporter.class,
					new Class[] { ConfigurableApplicationContext.class }, context);
			prepareContext(context, environment, listeners, applicationArguments, printedBanner);
			refreshContext(context);
			afterRefresh(context, applicationArguments);
			stopWatch.stop();
			if (this.logStartupInfo) {
				new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), stopWatch);
			}
			listeners.started(context);
			callRunners(context, applicationArguments);
		}
		catch (Throwable ex) {
			handleRunFailure(context, ex, exceptionReporters, listeners);
			throw new IllegalStateException(ex);
		}

		try {
			listeners.running(context);
		}
		catch (Throwable ex) {
			handleRunFailure(context, ex, exceptionReporters, null);
			throw new IllegalStateException(ex);
		}
		return context;
	}

 如果banner为关闭模式则直接返回null  配置方式是在配置文件中使用spring.main.banner-mod=off进行关闭，下面判断是打印到控制台还是打印到日志,这里打印到日志和打印到控制台的逻辑基本上是一致的，故我们择一去探究即可。

private Banner printBanner(ConfigurableEnvironment environment) {
        //如果banner为关闭模式则直接返回null  配置方式是在配置文件中使用spring.main.banner-mod=off进行关闭
		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);
	}

print（） 这段代码简单明了，无非就是 获取banner   打印banner  将banner作为参数返回，我们了解了如何获取banner，我们自然而然的也就知道怎么配置banner了

//这段代码简单明了，无非就是 获取banner   打印banner  将banner作为参数返回，我们了解了如何获取banner，我们自然而然的也就知道怎么配置banner了

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

private Banner getBanner(Environment environment) {
        //构造banner实例
		Banners banners = new Banners();
        //获取图片banner并添加到队列中
		banners.addIfNotNull(getImageBanner(environment));
        //获取textbanner 并添加到队列中
		banners.addIfNotNull(getTextBanner(environment));
    //返回封装所有banner的代理banner
		if (banners.hasAtLeastOneBanner()) {
			return banners;
		}
.        //如果没有设置banner返回兜底的banner
		if (this.fallbackBanner != null) {
			return this.fallbackBanner;
		}
        //否则返回默认的banner
		return DEFAULT_BANNER;
	}

//逻辑简单明了获取BANNER_IMAGE_LOCATION_PROPERTY 属性的value属性值，属性名称为spring.banner.image.location，根据value加载资源并构造banner 如果没有设置  BANNER_IMAGE_LOCATION_PROPERTY 属性则 查找classpath下banner.xxx的资源如果有则返回,xxx是什么呢， 具体如下{ "gif", "jpg", "png" };
private Banner getImageBanner(Environment environment) {
		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;
		}
		for (String ext : IMAGE_EXTENSION) {
			Resource resource = this.resourceLoader.getResource("banner." + ext);
			if (resource.exists()) {
				return new ImageBanner(resource);
			}
		}
		return null;
	}

/text 的也简单明了，如果设置了BANNER_LOCATION_PROPERTY 则获取该value属性值，如果没有设置则有默认值 banner.txt,之后根据 location 进行资源的加载并返回
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;
	}

到此banner的获取基本上就分析返程了，

流程总结 

1. 首先获取imagebanner    1 是否配置有spring.banner.image.location属性，如果有使用该属性值获取banner  2 根据banner.xxx 后缀名称可以是"gif", "jpg", "png"获取banner
2. 获取text banner  1是否配置有spring.banner.location 属性 如果有根据该路径获取banner 2如果没有根据banner.txt 获取banner
3. 否则           如果text  或 image 类型都查找不到banner  查看我们兜底的banner有没有设置，如果有使用兜底banner 如果没有使用SpringBootBanner