SpringBoot2.0原始碼分析(一):SpringBoot簡單分析

貳級天災發表於2018-09-30

SpringBoot2.0簡單介紹:SpringBoot2.0應用(一):SpringBoot2.0簡單介紹

本系列將從原始碼角度談談SpringBoot2.0。

先來看一個簡單的例子

@SpringBootApplication
@EnableJms
public class SampleActiveMQApplication {
    // 貳級天災
	@Bean
	public Queue queue() {
		return new ActiveMQQueue("sample.queue");
	}

	public static void main(String[] args) {
		SpringApplication.run(SampleActiveMQApplication.class, args);
	}

}
複製程式碼

這是一個簡單的SpringBoot整合ActiveMQ的例子。本篇將主要談談為什麼這麼幾行程式碼就能整合ActiveMQ。

上面那段程式碼主要有三個部分:

  • SpringApplication.run(SampleActiveMQApplication.class, args);
  • @SpringBootApplication
  • @EnableJms

SpringApplication的run方法

SpringApplication的run方法是通過new一個SpringApplication物件,然後執行該物件的run方法。程式碼如下:

	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 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;
	}
複製程式碼

SpringBoot先準備Spring的環境,再列印banner,列印完後,通過環境準備上下文。準備好上下文後,會重新整理上下文,即真正去準備專案的Spring環境。 之前看到一篇文章講到了可以自己指定banner,主要是跟banner的獲取方法有關。

	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;
	}
複製程式碼

SpringBoot會先去找影象banner和文字banner,只要有一個就使用它們。這兩banner的預設配置如下圖所示。所以只要在src/main/resources目錄下放上banner.gif或banner.txt檔案就可以修改banner了。

    {
      "name": "spring.banner.image.location",
      "type": "org.springframework.core.io.Resource",
      "description": "Banner image file location (jpg or png can also be used).",
      "defaultValue": "classpath:banner.gif"
    },{
      "defaultValue": "classpath:banner.txt",
      "deprecated": true,
      "name": "banner.location",
      "description": "Banner text resource location.",
      "type": "org.springframework.core.io.Resource",
      "deprecation": {
        "level": "error",
        "replacement": "spring.banner.location"
      }
    }
複製程式碼

回到正題,重新整理上下文主要是呼叫的AbstractApplicationContext類裡面的refresh方法。

    public void refresh() throws BeansException, IllegalStateException {
        synchronized(this.startupShutdownMonitor) {
            this.prepareRefresh();
            ConfigurableListableBeanFactory beanFactory = this.obtainFreshBeanFactory();
            this.prepareBeanFactory(beanFactory);

            try {
                this.postProcessBeanFactory(beanFactory);
                this.invokeBeanFactoryPostProcessors(beanFactory);
                this.registerBeanPostProcessors(beanFactory);
                this.initMessageSource();
                this.initApplicationEventMulticaster();
                this.onRefresh();
                this.registerListeners();
                this.finishBeanFactoryInitialization(beanFactory);
                this.finishRefresh();
            } catch (BeansException var9) {
                if(this.logger.isWarnEnabled()) {
                    this.logger.warn("Exception encountered during context initialization - cancelling refresh attempt: " + var9);
                }

                this.destroyBeans();
                this.cancelRefresh(var9);
                throw var9;
            } finally {
                this.resetCommonCaches();
            }

        }
    }
複製程式碼

可以看到,這裡主要處理的SpringBean的建立。

  • prepareRefresh:預處理,包括屬性驗證等。
  • prepareBeanFactory:主要對beanFactory設定了相關屬性,並註冊了3個Bean:environment,systemProperties和systemEnvironment供程式中注入使用。
  • invokeBeanFactoryPostProcessors:執行所以BeanFactoryPostProcessor的postProcessBeanFactory方法。
  • registerBeanPostProcessors:註冊BeanFactoryPostProcessors到BeanFactory。
  • initMessageSource:初始化MessageSource。
  • initApplicationEventMulticaster:初始化事件廣播器ApplicationEventMulticaster。
  • registerListeners:事件廣播器新增監聽器,並廣播早期事件。
  • finishBeanFactoryInitialization:結束BeanFactory的例項化,也就是在這真正去建立單例Bean。
  • finishRefresh:重新整理的收尾工作。清理快取,初始化生命週期處理器等等。
  • destroyBeans:銷燬建立的bean。
  • cancelRefresh:取消重新整理。
  • resetCommonCaches:清理快取。

@SpringBootApplication

註解本身沒有意義,被解析了才有意義。下面我們具體看下@SpringBootApplication的組成。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
    // 貳級天災
    @AliasFor(
        annotation = EnableAutoConfiguration.class
    )
    Class<?>[] exclude() default {};

    @AliasFor(
        annotation = EnableAutoConfiguration.class
    )
    String[] excludeName() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackages"
    )
    String[] scanBasePackages() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackageClasses"
    )
    Class<?>[] scanBasePackageClasses() default {};
}
複製程式碼
  • @SpringBootConfiguration:允許在使用該註解的地方使用@Bean注入。
  • @EnableAutoConfiguration:允許自動配置。
  • @ComponentScan:指定要掃描的哪些類。SpringBoot預設會掃描Application類所在包及子包的類的就是因為這個。

@EnableJms

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({JmsBootstrapConfiguration.class})
public @interface EnableJms {
    // 貳級天災
}
複製程式碼

@EnableJms註解其實就是匯入了JmsBootstrapConfiguration類。


本篇到此結束,如果讀完覺得有收穫的話,歡迎點贊、關注、加公眾號【貳級天災】,查閱更多精彩歷史!!!

SpringBoot2.0原始碼分析(一):SpringBoot簡單分析

相關文章