电脑知识|欧美黑人一区二区三区|软件|欧美黑人一级爽快片淫片高清|系统|欧美黑人狂野猛交老妇|数据库|服务器|编程开发|网络运营|知识问答|技术教程文章 - 好吧啦网

您的位置:首頁技術文章
文章詳情頁

@SpringBootApplication注解的使用

瀏覽:6日期:2023-03-18 09:53:17
一、前言

大部分的配置都可以用Java類+注解來代替,而在SpringBoot項目中見的最多的莫過于@SpringBootApplication注解了,它在每個SpringBoot的啟動類上都有標注。

這個注解對SpringBoot的啟動和自動配置到底有什么樣的影響呢?本文將為各位大佬解析它的源碼,揭開@SpringBootApplication注解神秘的面紗。

二、正文

對SpringBoot工程的自動配置很感興趣,于是學習其源碼并整理了其中一些內容,如果有錯誤請大家指正~話不多說,直接上源碼;

@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 {...}

可以看到這是一個復合注解,一共包括7個不同的注解,下面對這7個不同的注解進行分析。

2.1 注解2.1.1 注解1:@Target({ElementType.TYPE})

用來表示注解作用范圍,TYPE表示作用范圍為類或接口。

@SpringBootApplication注解的使用

2.1.2 注解2:@Retention(RetentionPolicy.RUNTIME)

@SpringBootApplication注解的使用

2.1.3 注解3:@Documented

表明這個注釋是由 javadoc記錄的。

2.1.4 注解4:@Inherited

放在注解上,當父類加了@SpringBootApplication注解時,子類也會繼承這個注解(對接口的實現類無效)。

2.1.5 注解5:@SpringBootConfiguration

底層仍是@Configuration注解, 源碼如下:

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Configurationpublic @interface SpringBootConfiguration {}2.1.6 注解6:@ComponetScan

@ComponentScan這個注解在Spring中很重要,它對應XML配置中的元素@ComponentScan的功能其實就是自動掃描并加載符合條件的組件(比如@Component和@Repository等)或者bean定義,最終將這些bean定義加載到IoC容器中。

可以通過basePackages等屬性來細粒度的定制@ComponentScan自動掃描的范圍,如果不指定,則默認Spring框架實現會從聲明@ComponentScan所在類的package進行掃描。所以SpringBoot的啟動類最好是放在root package下,因為默認不指定basePackages。

2.2 注解:@EnableAutoConfiguration

個人感覺@EnableAutoConfiguration這個Annotation最為重要它的作用可以概括為:借助@Import的幫助,將所有符合自動配置條件的bean定義加載到IoC容器。

其源碼如下:

@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(AutoConfigurationImportSelector.class)兩個注解。

2.2.1 注釋:@AutoConfigurationPackage

源碼如下:

@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 {};}

可以發現這個注解的核心其實也是Import注解,表示對于標注該注解的類的包,應當使用AutoConfigurationPackages注冊。接著看Registrar這個類:

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {​ @Override //metadata是我們注解所在的元信息 public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { //將我們注解所在包下所有的組件進行注冊 register(registry, new PackageImport(metadata).getPackageName()); }​ @Override public Set<Object> determineImports(AnnotationMetadata metadata) { return Collections.singleton(new PackageImport(metadata)); }}

這個類中的核心方法是register方法:

private static final String BEAN = AutoConfigurationPackages.class.getName(); public static void register(BeanDefinitionRegistry registry, String... packageNames) { if (registry.containsBeanDefinition(BEAN)) { BeanDefinition beanDefinition = registry.getBeanDefinition(BEAN); ConstructorArgumentValues constructorArguments = beanDefinition.getConstructorArgumentValues(); constructorArguments.addIndexedArgumentValue(0, addBasePackages(constructorArguments, packageNames));​ } else { GenericBeanDefinition beanDefinition = new GenericBeanDefinition(); beanDefinition.setBeanClass(BasePackages.class); beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0, packageNames); beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE); registry.registerBeanDefinition(BEAN, beanDefinition); }}

register方法的邏輯非常清晰:如果這個bean已經被注冊,就獲取它的構造函數參數值,并將包名添加進去;否則就創建一個新的bean定義并進行注冊。通過@AutoConfigurationPackage這個注解,可以將注解所在包下所有的組件進行注冊。

2.2.2 注解:@Import(AutoConfigurationImportSelector.class)

這個注解導入了AutoConfigurationImportSelector這個類這個類的核心方法是selectImports方法,實現ImportSelector接口。方法基于我們在pom.xml文件中配置的jar包和組件進行導入。所以方法返回的是一個Class全路徑的String數組,返回的Class會被Spring容器管理。方法源碼如下:

@Overridepublic String[] selectImports(AnnotationMetadata annotationMetadata) { if (!isEnabled(annotationMetadata)) { return NO_IMPORTS; } AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader .loadMetadata(this.beanClassLoader); AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata); return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());}

這個方法的結構也很清晰,首先通過isEnabled方法判斷是否需要進行導入,如果需要導入的話,通過loadMetadata方法獲取配置信息,并通過getAutoConfigurationEntry進行自動裝配。isEnabled方法源碼如下:

protected boolean isEnabled(AnnotationMetadata metadata) { if (getClass() == AutoConfigurationImportSelector.class) { return getEnvironment().getProperty(EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY, Boolean.class, true); } return true;}

這個方法通過EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY這個配置項進行判斷是否需要自動配置,默認為true。loadMetadata方法源碼如下:

protected static final String PATH = 'META-INF/' + 'spring-autoconfigure-metadata.properties';​ public static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader) { return loadMetadata(classLoader, PATH); }​ static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader, String path) { try { Enumeration<URL> urls = (classLoader != null) ? classLoader.getResources(path) : ClassLoader.getSystemResources(path); Properties properties = new Properties(); while (urls.hasMoreElements()) {properties.putAll(PropertiesLoaderUtils.loadProperties(new UrlResource(urls.nextElement()))); } return loadMetadata(properties); } catch (IOException ex) { throw new IllegalArgumentException('Unable to load @ConditionalOnClass location [' + path + ']', ex); } } static AutoConfigurationMetadata loadMetadata(Properties properties) { return new PropertiesAutoConfigurationMetadata(properties); }

可以看到這個方法會加載META-INF/spring-autoconfigure-metadata.properties下的所有配置信息并包裝成AutoConfigurationMetadata對象返回。

注:spring-autoconfigure-metadata.properties文件在spring-boot-autoconfigure-2.1.9.RELEASE.jar/META-INF下。

getAutoConfigurationEntry方法源碼如下:

protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) { if (!isEnabled(annotationMetadata)) { return EMPTY_ENTRY; } AnnotationAttributes attributes = getAttributes(annotationMetadata); List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes); configurations = removeDuplicates(configurations); Set<String> exclusions = getExclusions(annotationMetadata, attributes); checkExcludedClasses(configurations, exclusions); configurations.removeAll(exclusions); configurations = filter(configurations, autoConfigurationMetadata); fireAutoConfigurationImportEvents(configurations, exclusions); return new AutoConfigurationEntry(configurations, exclusions);}

這個方法是AutoConfiguration的主流程方法,可以將這個方法的每一行看做一個步驟,那么處理步驟如下:

1. 加載配置了@EnableAutoConfiguration注解的屬性值getAttribute方法:

protected AnnotationAttributes getAttributes(AnnotationMetadata metadata) { String name = getAnnotationClass().getName(); AnnotationAttributes attributes = AnnotationAttributes.fromMap(metadata.getAnnotationAttributes(name, true)); Assert.notNull(attributes, () -> 'No auto-configuration attributes found. Is ' + metadata.getClassName()+ ' annotated with ' + ClassUtils.getShortName(name) + '?'); return attributes;}

2.得到META-INF/spring.factories文件中以@EnableAutoConfiguration完全限定類名做key的value,getCandidateConfigurations方法:

​protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) { List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),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;}protected Class<?> getSpringFactoriesLoaderFactoryClass() { return EnableAutoConfiguration.class;}

其中,SpringFactoriesLoader.loadFactoryNames()這個方法的作用是使用給定的類加載器從META-INF/spring.factories加載給定類型的工廠實現的完全限定類名;

3.去重;

4.得到需要排除的類的類名,這些類可以在@EnableAutoConfiguration注解中配置;

5.檢查這兩個集合;

6.把需要排除的類移除;

7.根據OnBeanCondition、OnClassCondition等條件進行過濾(有興趣可以深入了解);

8.廣播事件,得到AutoConfigurationImportListener所有實現類,然后生成事件進行廣播;

9.把需要裝配和排除的類完全限定名封裝成了AutoConfigurationEntry對象返回。

因此,@EnableAutoConfiguration可以簡單總結為:從classpath中搜尋所有的META-INF/spring.factories配置文件,并將其中EnableAutoConfiguration對應的配置項通過反射實例化為對應的標注了@Configuration的IoC容器配置類,并加載到IoC容器。

三、小結

通過以上分析可知@SpringBootApplication注解的運作是通過@SpringApplicationConfiguration聲明被標注類為配置類,從而被AnnotationConfigApplicationContext掃描并初始化Spring容器。

通過@EnableAutoConfiguration來掃描,過濾并加載所需要的組件;通過@ComponentScan掃描并注冊所有標注了@Component及其子注解的類;這些注解的共同運作實現了springboot工程強大的自動配置能力。

以上就是@SpringBootApplication注解的使用的詳細內容,更多關于@SpringBootApplication注解的使用的資料請關注好吧啦網其它相關文章!

標簽: Spring
相關文章:
主站蜘蛛池模板: 微波萃取合成仪-电热消解器价格-北京安合美诚科学仪器有限公司 | 飞扬动力官网-广告公司管理软件,广告公司管理系统,喷绘写真条幅制作管理软件,广告公司ERP系统 | 校园气象站_超声波气象站_农业气象站_雨量监测站_风途科技 | 合肥废气治理设备_安徽除尘设备_工业废气处理设备厂家-盈凯环保 合肥防火门窗/隔断_合肥防火卷帘门厂家_安徽耐火窗_良万消防设备有限公司 | 今日娱乐圈——影视剧集_八卦娱乐_明星八卦_最新娱乐八卦新闻 | 3A别墅漆/3A环保漆_广东美涂士建材股份有限公司【官网】 | SRRC认证_电磁兼容_EMC测试整改_FCC认证_SDOC认证-深圳市环测威检测技术有限公司 | 并网柜,汇流箱,电控设备,中高低压开关柜,电气电力成套设备,PLC控制设备订制厂家,江苏昌伟业新能源科技有限公司 | PCB厂|线路板厂|深圳线路板厂|软硬结合板厂|电路板生产厂家|线路板|深圳电路板厂家|铝基板厂家|深联电路-专业生产PCB研发制造 | 艺术涂料|木纹漆施工|稻草漆厂家|马来漆|石桦奴|水泥漆|选加河南天工涂料 | 杰福伦_磁致伸缩位移传感器_线性位移传感器-意大利GEFRAN杰福伦-河南赉威液压科技有限公司 | 自动气象站_气象站监测设备_全自动气象站设备_雨量监测站-山东风途物联网 | 北京自然绿环境科技发展有限公司专业生产【洗车机_加油站洗车机-全自动洗车机】 | 智能家居全屋智能系统多少钱一套-小米全套价格、装修方案 | 钢丝绳探伤仪-钢丝绳检测仪-钢丝绳探伤设备-洛阳泰斯特探伤技术有限公司 | 震动筛选机|震动分筛机|筛粉机|振筛机|振荡筛-振动筛分设备专业生产厂家高服机械 | 无线联网门锁|校园联网门锁|学校智能门锁|公租房智能门锁|保障房管理系统-KEENZY中科易安 | 金属抛光机-磁悬浮抛光机-磁力研磨机-磁力清洗机 - 苏州冠古科技 | 华夏医界网_民营医疗产业信息平台_民营医院营销管理培训 | 辽宁资质代办_辽宁建筑资质办理_辽宁建筑资质延期升级_辽宁中杭资质代办 | 滚筒烘干机_转筒烘干机_滚筒干燥机_转筒干燥机_回转烘干机_回转干燥机-设备生产厂家 | 电池挤压试验机-自行车喷淋-车辆碾压试验装置-深圳德迈盛测控设备有限公司 | 深圳宣传片制作-企业宣传视频制作-产品视频拍摄-产品动画制作-短视频拍摄制作公司 | Akribis直线电机_直线模组_力矩电机_直线电机平台|雅科贝思Akribis-杭州摩森机电科技有限公司 | 艺术漆十大品牌_艺术涂料加盟代理_蒙太奇艺术涂料厂家品牌|艺术漆|微水泥|硅藻泥|乳胶漆 | 上海风淋室_上海风淋室厂家_上海风淋室价格_上海伯淋 | 云南成考网_云南成人高考报名网 粤丰硕水性环氧地坪漆-防静电自流平厂家-环保地坪涂料代理 | 旗杆生产厂家_不锈钢锥形旗杆价格_铝合金电动旗杆-上海锥升金属科技有限公司 | 纸箱抗压机,拉力机,脂肪测定仪,定氮仪-山东德瑞克仪器有限公司 | 玻璃钢格栅盖板|玻璃钢盖板|玻璃钢格栅板|树篦子-长沙川皖玻璃钢制品有限公司 | 铝箔-铝板-花纹铝板-铝型材-铝棒管-上海百亚金属材料有限公司 | 影合社-影视人的内容合作平台| 粉丝机械,粉丝烘干机,粉丝生产线-招远市远东粉丝机械有限公司 | 航空障碍灯_高中低光强航空障碍灯_民航许可认证航空警示灯厂家-东莞市天翔航天科技有限公司 | 贵州成人高考网_贵州成考网| 踏板力计,制动仪,非接触多功能速度仪,逆反射系数测试仪-创宇 | 南京租车,南京汽车租赁,南京包车,南京会议租车-南京七熹租车 | 深圳市人通智能科技有限公司| 整车VOC采样环境舱-甲醛VOC预处理舱-多舱法VOC检测环境仓-上海科绿特科技仪器有限公司 | 万家财经_财经新闻_在线财经资讯网| 新型锤式破碎机_新型圆锥式_新型颚式破碎机_反击式打沙机_锤式制砂机_青州建源机械 |