Java SpringBoot首先看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<Object> determineImports(AnnotationMetadata metadata) {return Collections.singleton(new AutoConfigurationPackages.PackageImport(metadata));}}
就是通过以上这个方法获取扫描的包路径,可以debug查看具体的值:
那metadata是什么呢,可以看到是标注在@SpringBootApplication注解上的DemosbApplication,也就是主配置类Application:
其实就是将主配置类(即@SpringBootApplication标注的类)的所在包及子包里面所有组件扫描加载到Spring容器。因此要把DemoApplication放在项目的最高级中(最外层目录)。看看注解@Import(AutoConfigurationImportSelector.class),@Import注解就是给Spring容器中导入一些组件,这里传入了一个组件的选择器:AutoConfigurationImportSelector。可以从图中看出AutoConfigurationImportSelector%20继承了%20DeferredImportSelector%20继承了%20ImportSelector,ImportSelector有一个方法为:selectImports。将所有需要导入的组件以全类名的方式返回,这些组件就会被添加到容器中。
public%20String[]%20selectImports(AnnotationMetadata%20annotationMetadata)%20{%20%20%20%20if%20(!this.isEnabled(annotationMetadata))%20{%20%20%20%20%20%20%20%20return%20NO_IMPORTS;%20%20%20%20}%20else%20{%20%20%20%20%20%20%20%20AutoConfigurationMetadata%20autoConfigurationMetadata%20=%20AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);%20%20%20%20%20%20%20%20AutoConfigurationImportSelector.AutoConfigurationEntry%20autoConfigurationEntry%20=%20%20%20%20%20%20%20%20%20this.getAutoConfigurationEntry(autoConfigurationMetadata,%20annotationMetadata);%20%20%20%20%20%20%20%20return%20StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());%20%20%20%20}}
会给容器中导入非常多的自动配置类(xxxAutoConfiguration);就是给容器中导入这个场景需要的所有组件,并配置好这些组件。有了自动配置类,免去了手动编写配置注入功能组件等的工作。那是如何获取到这些配置类的呢,看看下面这个方法:
protected AutoConfigurationImportSelector.AutoConfigurationEntrygetAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) {if (!this.isEnabled(annotationMetadata)) {return EMPTY_ENTRY;} else {AnnotationAttributes attributes = this.getAttributes(annotationMetadata);List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);configurations = this.removeDuplicates(configurations);Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);this.checkExcludedClasses(configurations, exclusions);configurations.removeAll(exclusions);configurations = this.filter(configurations, autoConfigurationMetadata);this.fireAutoConfigurationImportEvents(configurations, exclusions);return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);}}
可以看到getCandidateConfigurations()这个方法,他的作用就是引入系统已经加载好的一些类,到底是那些类呢:
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());Assert.notEmpty(configurations,"No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");return configurations;}
public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {String factoryClassName = factoryClass.getName();return (List)loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());}
会从META-INF/spring.factories中获取资源,然后通过Properties加载资源:
private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {MultiValueMap<String, String> result = (MultiValueMap)cache.get(classLoader);if (result != null) {return result;} else {try {Enumeration<URL> urls = classLoader !=null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");LinkedMultiValueMap result = new LinkedMultiValueMap();while(urls.hasMoreElements()) {URL url = (URL)urls.nextElement();UrlResource resource = new UrlResource(url);Properties properties = PropertiesLoaderUtils.loadProperties(resource);Iterator var6 = properties.entrySet().iterator();while(var6.hasNext()) {Map.Entry<?, ?> entry = (Map.Entry)var6.next();String factoryClassName = ((String)entry.getKey()).trim();String[] var9 = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());int var10 = var9.length;for(int var11 = 0; var11 < var10; ++var11) {String factoryName = var9[var11];result.add(factoryClassName, factoryName.trim());}}}cache.put(classLoader, result);return result;} catch (IOException var13) {throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var13);}}}
可以知道SpringBoot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfiguration指定的值,将这些值作为自动配置类导入到容器中,自动配置类就生效,进行自动配置工作。以前需要自己配置的东西,自动配置类都完成了。如下图可以发现Spring常见的一些类已经自动导入。
接下来看@ComponentScan注解,@ComponentScan(excludeFilters%20=%20{%20@Filter(type%20=%20FilterType.CUSTOM,%20classes%20=%20TypeExcludeFilter.class),%20@Filter(type%20=%20FilterType.CUSTOM,%20classes%20=%20AutoConfigurationExcludeFilter.class)%20}),这个注解就是扫描包,然后放入spring容器。
@ComponentScan(excludeFilters%20=%20{%20%20%20%20@Filter(type%20=%20FilterType.CUSTOM,classes%20=%20{TypeExcludeFilter.class}),%20%20%20%20%20@Filter(type%20=%20FilterType.CUSTOM,classes%20=%20{AutoConfigurationExcludeFilter.class})})public%20@interface%20SpringBootApplication%20{}
总结下@SpringbootApplication:就是说,他已经把很多东西准备好,具体是否使用取决于程序或者说配置。接下来继续看run方法:
public%20static%20void%20main(String[]%20args)%20{%20%20%20%20SpringApplication.run(Application.class,%20args);}
来看下在执行run方法到底有没有用到哪些自动配置的东西,点进run:
public%20ConfigurableApplicationContext%20run(String...%20args)%20{%20%20%20%20//计时器%20%20%20%20StopWatch%20stopWatch%20=%20new%20StopWatch();%20%20%20%20stopWatch.start();%20%20%20%20ConfigurableApplicationContext%20context%20=%20null;%20%20%20%20Collection<SpringBootExceptionReporter>%20exceptionReporters%20=%20new%20ArrayList();%20%20%20%20this.configureHeadlessProperty();%20%20%20%20//监听器%20%20%20%20SpringApplicationRunListeners%20listeners%20=%20this.getRunListeners(args);%20%20%20%20listeners.starting();%20%20%20%20Collection%20exceptionReporters;%20%20%20%20try%20{%20%20%20%20%20%20%20%20ApplicationArguments%20applicationArguments%20=%20new%20DefaultApplicationArguments(args);%20%20%20%20%20%20%20%20ConfigurableEnvironment%20environment%20=%20this.prepareEnvironment(listeners,%20applicationArguments);%20%20%20%20%20%20%20%20this.configureIgnoreBeanInfo(environment);%20%20%20%20%20%20%20%20Banner%20printedBanner%20=%20this.printBanner(environment);%20%20%20%20%20%20%20%20//准备上下文%20%20%20%20%20%20%20%20context%20=%20this.createApplicationContext();%20%20%20%20%20%20%20%20exceptionReporters%20=%20this.getSpringFactoriesInstances(SpringBootExceptionReporter.class,%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20new%20Class[]{ConfigurableApplicationContext.class},%20context);%20%20%20%20%20%20%20%20//预刷新context%20%20%20%20%20%20%20%20this.prepareContext(context,%20environment,%20listeners,%20applicationArguments,%20printedBanner);%20%20%20%20%20%20%20%20//刷新context%20%20%20%20%20%20%20%20this.refreshContext(context);%20%20%20%20%20%20%20%20//刷新之后的context%20%20%20%20%20%20%20%20this.afterRefresh(context,%20applicationArguments);%20%20%20%20%20%20%20%20stopWatch.stop();%20%20%20%20%20%20%20%20if%20(this.logStartupInfo)%20{%20%20%20%20%20%20%20%20%20%20%20%20(new%20StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(),%20stopWatch);%20%20%20%20%20%20%20%20}%20%20%20%20%20%20%20%20listeners.started(context);%20%20%20%20%20%20%20%20this.callRunners(context,%20applicationArguments);%20%20%20%20}%20catch%20(Throwable%20var10)%20{%20%20%20%20%20%20%20%20this.handleRunFailure(context,%20var10,%20exceptionReporters,%20listeners);%20%20%20%20%20%20%20%20throw%20new%20IllegalStateException(var10);%20%20%20%20}%20%20%20%20try%20{%20%20%20%20%20%20%20%20listeners.running(context);%20%20%20%20%20%20%20%20return%20context;%20%20%20%20}%20catch%20(Throwable%20var9)%20{%20%20%20%20%20%20%20%20this.handleRunFailure(context,%20var9,%20exceptionReporters,%20(SpringApplicationRunListeners)null);%20%20%20%20%20%20%20%20throw%20new%20IllegalStateException(var9);%20%20%20%20}}
那关注的就是%20refreshContext(context);%20刷新context,点进来看。
private%20void%20refreshContext(ConfigurableApplicationContext%20context)%20{%20%20%20refresh(context);%20%20%20if%20(this.registerShutdownHook)%20{%20%20%20%20%20%20try%20{%20%20%20%20%20%20%20%20%20context.registerShutdownHook();%20%20%20%20%20%20}%20%20%20%20%20%20catch%20(AccessControlException%20ex)%20{%20%20%20%20%20%20%20%20%20//%20Not%20allowed%20in%20some%20environments.%20%20%20%20%20%20}%20%20%20}}
继续点进refresh(context);
protected%20void%20refresh(ApplicationContext%20applicationContext)%20{%20%20%20Assert.isInstanceOf(AbstractApplicationContext.class,%20applicationContext);%20%20%20((AbstractApplicationContext)%20applicationContext).refresh();}
他会调用%20((AbstractApplicationContext)%20applicationContext).refresh();方法,点进来看:
public%20void%20refresh()%20throws%20BeansException,%20IllegalStateException%20{%20%20%20synchronized%20(this.startupShutdownMonitor)%20{%20%20%20%20%20%20//%20Prepare%20this%20context%20for%20refreshing.%20%20%20%20%20%20prepareRefresh();%20%20%20%20%20%20//%20Tell%20the%20subclass%20to%20refresh%20the%20internal%20bean%20factory.%20%20%20%20%20%20ConfigurableListableBeanFactory%20beanFactory%20=%20obtainFreshBeanFactory();%20%20%20%20%20%20//%20Prepare%20the%20bean%20factory%20for%20use%20in%20this%20context.%20%20%20%20%20%20prepareBeanFactory(beanFactory);%20%20%20%20%20%20try%20{%20%20%20%20%20%20%20%20%20//%20Allows%20post-processing%20of%20the%20bean%20factory%20in%20context%20subclasses.%20%20%20%20%20%20%20%20%20postProcessBeanFactory(beanFactory);%20%20%20%20%20%20%20%20%20//%20Invoke%20factory%20processors%20registered%20as%20beans%20in%20the%20context.%20%20%20%20%20%20%20%20%20invokeBeanFactoryPostProcessors(beanFactory);%20%20%20%20%20%20%20%20%20//%20Register%20bean%20processors%20that%20intercept%20bean%20creation.%20%20%20%20%20%20%20%20%20registerBeanPostProcessors(beanFactory);%20%20%20%20%20%20%20%20%20//%20Initialize%20message%20source%20for%20this%20context.%20%20%20%20%20%20%20%20%20initMessageSource();%20%20%20%20%20%20%20%20%20//%20Initialize%20event%20multicaster%20for%20this%20context.%20%20%20%20%20%20%20%20%20initApplicationEventMulticaster();%20%20%20%20%20%20%20%20%20//%20Initialize%20other%20special%20beans%20in%20specific%20context%20subclasses.%20%20%20%20%20%20%20%20%20onRefresh();%20%20%20%20%20%20%20%20%20//%20Check%20for%20listener%20beans%20and%20register%20them.%20%20%20%20%20%20%20%20%20registerListeners();%20%20%20%20%20%20%20%20%20//%20Instantiate%20all%20remaining%20(non-lazy-init)%20singletons.%20%20%20%20%20%20%20%20%20finishBeanFactoryInitialization(beanFactory);%20%20%20%20%20%20%20%20%20//%20Last%20step:%20publish%20corresponding%20event.%20%20%20%20%20%20%20%20%20finishRefresh();%20%20%20%20%20%20}catch%20(BeansException%20ex)%20{%20%20%20%20%20%20%20%20%20if%20(logger.isWarnEnabled())%20{%20%20%20%20%20%20%20%20%20%20%20%20logger.warn("Exception%20encountered%20during%20context%20initialization%20-%20"%20+%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20"cancelling%20refresh%20attempt:%20"%20+%20ex);%20%20%20%20%20%20%20%20%20}%20%20%20%20%20%20%20%20%20//%20Destroy%20already%20created%20singletons%20to%20avoid%20dangling%20resources.%20%20%20%20%20%20%20%20%20destroyBeans();%20%20%20%20%20%20%20%20%20//%20Reset%20'active'%20flag.%20%20%20%20%20%20%20%20%20cancelRefresh(ex);%20%20%20%20%20%20%20%20%20//%20Propagate%20exception%20to%20caller.%20%20%20%20%20%20%20%20%20throw%20ex;%20%20%20%20%20%20}finally%20{%20%20%20%20%20%20%20%20%20//%20Reset%20common%20introspection%20caches%20in%20Spring's%20core,%20since%20we%20%20%20%20%20%20%20%20%20//%20might%20not%20ever%20need%20metadata%20for%20singleton%20beans%20anymore...%20%20%20%20%20%20%20%20%20resetCommonCaches();%20%20%20%20%20%20}%20%20%20}}
由此可知,就是一个Spring的bean的加载过程。继续来看一个方法叫做%20onRefresh():
protected%20void%20onRefresh()%20throws%20BeansException%20{%20%20%20//%20For%20subclasses:%20do%20nothing%20by%20default.}
他在这里并没有直接实现,找他的具体实现:比如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,举点例子。
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-freemarker</artifactId></dependency>
首先自定义一个stater。
<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.1.4.RELEASE</version><relativePath/></parent><groupId>com.zgw</groupId><artifactId>gw-spring-boot-starter</artifactId><version>1.0-SNAPSHOT</version><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId></dependency></dependencies>
先来看maven配置写入版本号,如果自定义一个stater的话必须依赖spring-boot-autoconfigure这个包,先看下项目目录。
public class GwServiceImpl implements GwService{@AutowiredGwProperties properties;@Overridepublic 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@ConditionalOnMissingBeanpublic GwService gwService(){return new GwServiceImpl();}}
这个为配置类,为什么这么写因为,spring-boot的stater都是这么写的,可以参照他仿写stater,以达到自动配置的目的,然后在通过spring.factories也来进行配置。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.gw.GwAutoConfiguration
然后这样一个简单的stater就完成了,然后可以进行maven的打包,在其他项目引入就可以使用。
版权声明
本站仅做备份收录,仅供研究与教学参考之用。
读者将信息用于其他用途的,全部法律及连带责任由读者自行承担,本站不承担任何责任。









评论