首先,先看SpringBoot的主配置類:
@SpringBootApplicationpublic class StartEurekaApplication{ public static void main(String[] args) { SpringApplication。run(StartEurekaApplication。class, args); }}
點進@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 {}
首先我們先來看 @SpringBootConfiguration:
@Target({ElementType。TYPE})@Retention(RetentionPolicy。RUNTIME)@Documented@Configurationpublic @interface SpringBootConfiguration {}
可以看到這個註解除了元註解以外,就只有一個@Configuration,那也就是說這個註解相當於@Configuration,所以這兩個註解作用是一樣的,它讓我們能夠去註冊一些額外的Bean,並且匯入一些額外的配置。
那@Configuration還有一個作用就是把該類變成一個配置類,不需要額外的XML進行配置。所以@SpringBootConfiguration就相當於@Configuration。進入@Configuration,發現@Configuration核心是@Component,說明Spring的配置類也是Spring的一個元件。
@Target({ElementType。TYPE})@Retention(RetentionPolicy。RUNTIME)@Documented@Componentpublic @interface Configuration { @AliasFor( annotation = Component。class ) String value() default “”;}
繼續來看下一個@EnableAutoConfiguration,這個註解是開啟自動配置的功能。
@Target({ElementType。TYPE})@Retention(RetentionPolicy。RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import({AutoConfigurationImportSelector。class})public @interface EnableAutoConfiguration { String ENABLED_OVERRIDE_PROPERTY = “spring。boot。enableautoconfiguration”; Class<?>[] exclude() default {}; String[] excludeName() default {};}
可以看到它是由 @AutoConfigurationPackage,@Import(EnableAutoConfigurationImportSelector。class)這兩個而組成的,我們先說@AutoConfigurationPackage,他是說:讓包中的類以及子包中的類能夠被自動掃描到spring容器中。
@Target({ElementType。TYPE})@Retention(RetentionPolicy。RUNTIME)@Documented@Inherited@Import({Registrar。class})public @interface AutoConfigurationPackage {}
使用@Import來給Spring容器中匯入一個元件 ,這裡匯入的是Registrar。class。來看下這個Registrar:
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports { Registrar() { } public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { AutoConfigurationPackages。register(registry, (new AutoConfigurationPackages。PackageImport(metadata))。getPackageName()); } public Set
就是透過以上這個方法獲取掃描的包路徑,可以debug檢視具體的值:
那metadata是什麼呢,可以看到是標註在@SpringBootApplication註解上的DemosbApplication,也就是我們的主配置類Application:
其實就是將主配置類(即@SpringBootApplication標註的類)的所在包及子包裡面所有元件掃描載入到Spring容器。因此我們要把DemoApplication放在專案的最高階中(最外層目錄)。
看看註解@Import(AutoConfigurationImportSelector。class),@Import註解就是給Spring容器中匯入一些元件,這裡傳入了一個元件的選擇器:AutoConfigurationImportSelector。
可以從圖中看出AutoConfigurationImportSelector 繼承了 DeferredImportSelector 繼承了 ImportSelector,ImportSelector有一個方法為:selectImports。將所有需要匯入的元件以全類名的方式返回,這些元件就會被新增到容器中。
public String[] selectImports(AnnotationMetadata annotationMetadata) { if (!this。isEnabled(annotationMetadata)) { return NO_IMPORTS; } else { AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader。loadMetadata(this。beanClassLoader); AutoConfigurationImportSelector。AutoConfigurationEntry autoConfigurationEntry = this。getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata); return StringUtils。toStringArray(autoConfigurationEntry。getConfigurations()); }}
會給容器中匯入非常多的自動配置類(xxxAutoConfiguration);就是給容器中匯入這個場景需要的所有元件,並配置好這些元件。
有了自動配置類,免去了我們手動編寫配置注入功能元件等的工作。那是如何獲取到這些配置類的呢,看看下面這個方法:
protected AutoConfigurationImportSelector。AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) { if (!this。isEnabled(annotationMetadata)) { return EMPTY_ENTRY; } else { AnnotationAttributes attributes = this。getAttributes(annotationMetadata); List
我們可以看到getCandidateConfigurations()這個方法,他的作用就是引入系統已經載入好的一些類,到底是那些類呢:
protected List
public static List
會從META-INF/spring。factories中獲取資源,然後透過Properties載入資源:
private static Map
可以知道SpringBoot在啟動的時候從類路徑下的META-INF/spring。factories中獲取EnableAutoConfiguration指定的值,將這些值作為自動配置類匯入到容器中,自動配置類就生效,幫我們進行自動配置工作。以前我們需要自己配置的東西,自動配置類都幫我們完成了。如下圖可以發現Spring常見的一些類已經自動匯入。
接下來看@ComponentScan註解,@ComponentScan(excludeFilters = { @Filter(type = FilterType。CUSTOM, classes = TypeExcludeFilter。class), @Filter(type = FilterType。CUSTOM, classes = AutoConfigurationExcludeFilter。class) }),這個註解就是掃描包,然後放入spring容器。
@ComponentScan(excludeFilters = { @Filter(type = FilterType。CUSTOM,classes = {TypeExcludeFilter。class}), @Filter(type = FilterType。CUSTOM,classes = {AutoConfigurationExcludeFilter。class})})public @interface SpringBootApplication {}
總結下@SpringbootApplication:就是說,他已經把很多東西準備好,具體是否使用取決於我們的程式或者說配置。
接下來繼續看run方法:
public static void main(String[] args) { SpringApplication。run(Application。class, args); }
來看下在執行run方法到底有沒有用到哪些自動配置的東西,我們點進run:
public ConfigurableApplicationContext run(String。。。 args) { //計時器 StopWatch stopWatch = new StopWatch(); stopWatch。start(); ConfigurableApplicationContext context = null; Collection
那我們關注的就是 refreshContext(context); 重新整理context,我們點進來看。
private void refreshContext(ConfigurableApplicationContext context) { refresh(context); if (this。registerShutdownHook) { try { context。registerShutdownHook(); } catch (AccessControlException ex) { // Not allowed in some environments。 } }}
我們繼續點進refresh(context);
protected void refresh(ApplicationContext applicationContext) { Assert。isInstanceOf(AbstractApplicationContext。class, applicationContext); ((AbstractApplicationContext) applicationContext)。refresh();}
他會呼叫 ((AbstractApplicationContext) applicationContext)。refresh();方法,我們點進來看:
public void refresh() throws BeansException, IllegalStateException { synchronized (this。startupShutdownMonitor) { // Prepare this context for refreshing。 prepareRefresh(); // Tell the subclass to refresh the internal bean factory。 ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory(); // Prepare the bean factory for use in this context。 prepareBeanFactory(beanFactory); try { // Allows post-processing of the bean factory in context subclasses。 postProcessBeanFactory(beanFactory); // Invoke factory processors registered as beans in the context。 invokeBeanFactoryPostProcessors(beanFactory); // Register bean processors that intercept bean creation。 registerBeanPostProcessors(beanFactory); // Initialize message source for this context。 initMessageSource(); // Initialize event multicaster for this context。 initApplicationEventMulticaster(); // Initialize other special beans in specific context subclasses。 onRefresh(); // Check for listener beans and register them。 registerListeners(); // Instantiate all remaining (non-lazy-init) singletons。 finishBeanFactoryInitialization(beanFactory); // Last step: publish corresponding event。 finishRefresh(); }catch (BeansException ex) { if (logger。isWarnEnabled()) { logger。warn(“Exception encountered during context initialization - ” + “cancelling refresh attempt: ” + ex); } // Destroy already created singletons to avoid dangling resources。 destroyBeans(); // Reset ‘active’ flag。 cancelRefresh(ex); // Propagate exception to caller。 throw ex; }finally { // Reset common introspection caches in Spring‘s core, since we // might not ever need metadata for singleton beans anymore。。。 resetCommonCaches(); } }}
由此可知,就是一個spring的bean的載入過程。繼續來看一個方法叫做 onRefresh():
protected void onRefresh() throws BeansException { // For subclasses: do nothing by default。}
他在這裡並沒有直接實現,但是我們找他的具體實現:
比如Tomcat跟web有關,我們可以看到有個ServletWebServerApplicationContext:
@Overrideprotected void onRefresh() { super。onRefresh(); try { createWebServer(); } catch (Throwable ex) { throw new ApplicationContextException(“Unable to start web server”, ex); }}
可以看到有一個createWebServer();方法他是建立web容器的,而Tomcat不就是web容器,那是如何建立的呢,我們繼續看:
private void createWebServer() { WebServer webServer = this。webServer; ServletContext servletContext = getServletContext(); if (webServer == null && servletContext == null) { ServletWebServerFactory factory = getWebServerFactory(); this。webServer = factory。getWebServer(getSelfInitializer()); } else if (servletContext != null) { try { getSelfInitializer()。onStartup(servletContext); } catch (ServletException ex) { throw new ApplicationContextException(“Cannot initialize servlet context”, ex); } } initPropertySources();}
factory。getWebServer(getSelfInitializer());他是透過工廠的方式建立的。
public interface ServletWebServerFactory { WebServer getWebServer(ServletContextInitializer。。。 initializers);}
可以看到 它是一個介面,為什麼會是介面。因為我們不止是Tomcat一種web容器。
我們看到還有Jetty,那我們來看TomcatServletWebServerFactory:
@Overridepublic WebServer getWebServer(ServletContextInitializer。。。 initializers) { Tomcat tomcat = new Tomcat(); File baseDir = (this。baseDirectory != null) ? this。baseDirectory : createTempDir(“tomcat”); tomcat。setBaseDir(baseDir。getAbsolutePath()); Connector connector = new Connector(this。protocol); tomcat。getService()。addConnector(connector); customizeConnector(connector); tomcat。setConnector(connector); tomcat。getHost()。setAutoDeploy(false); configureEngine(tomcat。getEngine()); for (Connector additionalConnector : this。additionalTomcatConnectors) { tomcat。getService()。addConnector(additionalConnector); } prepareContext(tomcat。getHost(), initializers); return getTomcatWebServer(tomcat);}
那這塊程式碼,就是我們要尋找的內建Tomcat,在這個過程當中,我們可以看到建立Tomcat的一個流程。
如果不明白的話, 我們在用另一種方式來理解下,大家要應該都知道stater舉點例子。
首先自定義一個stater。
我們先來看maven配置寫入版本號,如果自定義一個stater的話必須依賴spring-boot-autoconfigure這個包,我們先看下專案目錄。
public class GwServiceImpl implements GwService{ @Autowired GwProperties properties; @Override public void Hello() { String name=properties。getName(); System。out。println(name+“說:你們好啊”); }}
我們做的就是透過配置檔案來定製name這個是具體實現。
@Component@ConfigurationProperties(prefix = “spring。gwname”)public class GwProperties { String name=“zgw”; public String getName() { return name; } public void setName(String name) { this。name = name; }}
這個類可以透過@ConfigurationProperties讀取配置檔案。
@Configuration@ConditionalOnClass(GwService。class) //掃描類@EnableConfigurationProperties(GwProperties。class) //讓配置類生效public class GwAutoConfiguration { /** * 功能描述 託管給spring * @author zgw * @return */ @Bean @ConditionalOnMissingBean public GwService gwService() { return new GwServiceImpl(); }}
這個為配置類,為什麼這麼寫因為,spring-boot的stater都是這麼寫的,我們可以參照他仿寫stater,以達到自動配置的目的,然後我們在透過spring。factories也來進行配置。
org。springframework。boot。autoconfigure。EnableAutoConfiguration=com。gw。GwAutoConfiguration
然後這樣一個簡單的stater就完成了,然後可以進行maven的打包,在其他專案引入就可以使用。
原文:cnblogs。com/jing99/p/11504113。html