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

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

@SpringBootApplication注解的使用

瀏覽:7日期: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
相關文章:
主站蜘蛛池模板: 超声波焊接机_超音波熔接机_超声波塑焊机十大品牌_塑料超声波焊接设备厂家 | 注浆压力变送器-高温熔体传感器-矿用压力传感器|ZHYQ朝辉 | 湖南长沙商标注册专利申请,长沙公司注册代理记账首选美创! | 【MBA备考网】-2024年工商管理硕士MBA院校/报考条件/培训/考试科目/提前面试/考试/学费-MBA备考网 | 六维力传感器_三维力传感器_二维力传感器-南京神源生智能科技有限公司 | SEO网站优化,关键词排名优化,苏州网站推广-江苏森歌网络 | 武汉印刷厂-不干胶标签印刷厂-武汉不干胶印刷-武汉标签印刷厂-武汉标签制作 - 善进特种标签印刷厂 | 成人纸尿裤,成人尿不湿,成人护理垫-山东康舜日用品有限公司 | B2B网站_B2B免费发布信息网站_B2B企业贸易平台 - 企资网 | 集装箱箱号识别_自重载重图像识别_铁路车号自动识别_OCR图像识别 | 电动手术床,医用护理床,led手术无影灯-曲阜明辉医疗设备有限公司 | 粘弹体防腐胶带,聚丙烯防腐胶带-全民塑胶 | 深圳市索富通实业有限公司-可燃气体报警器 | 可燃气体探测器 | 气体检测仪 | 风淋室生产厂家报价_传递窗|送风口|臭氧机|FFU-山东盛之源净化设备 | 大连海岛旅游网>>大连旅游,大连海岛游,旅游景点攻略,海岛旅游官网 | 找果网 | 苹果手机找回方法,苹果iPhone手机丢了找回,认准找果网! | 微水泥_硅藻泥_艺术涂料_艺术漆_艺术漆加盟-青岛泥之韵环保壁材 武汉EPS线条_EPS装饰线条_EPS构件_湖北博欧EPS线条厂家 | 亮化工程,亮化设计,城市亮化工程,亮化资质合作,长沙亮化照明,杰奥思【官网】 | 无菌实验室规划装修设计-一体化实验室承包-北京洁净净化工程建设施工-北京航天科恩实验室装备工程技术有限公司 | 超声波分散机-均质机-萃取仪-超声波涂料分散设备-杭州精浩 | 压砖机、液压制砖机、静压砖机、环保砖机生产厂家—杜甫机械 | 皮带式输送机械|链板式输送机|不锈钢输送机|网带输送机械设备——青岛鸿儒机械有限公司 | 贴板式电磁阀-不锈钢-气动上展式放料阀-上海弗雷西阀门有限公司 工业机械三维动画制作 环保设备原理三维演示动画 自动化装配产线三维动画制作公司-南京燃动数字 | 挤奶设备过滤纸,牛奶过滤纸,挤奶机过滤袋-济南蓝贝尔工贸有限公司 | 拉曼光谱仪_便携式|激光|显微共焦拉曼光谱仪-北京卓立汉光仪器有限公司 | 吹田功率计-长创耐压测试仪-深圳市新朗普电子科技有限公司 | 黑龙江京科脑康医院-哈尔滨精神病医院哪家好_哈尔滨精神科医院排名_黑龙江精神心理病专科医院 | 软文世界-软文推广-软文营销-新闻稿发布-一站式软文自助发稿平台 | 微量水分测定仪_厂家_卡尔费休微量水分测定仪-淄博库仑 | 纯水设备_苏州皙全超纯水设备水处理设备生产厂家| 论文查重_免费论文查重_知网学术不端论文查重检测系统入口_论文查重软件 | 不锈钢水箱生产厂家_消防水箱生产厂家-河南联固供水设备有限公司 | 二手电脑回收_二手打印机回收_二手复印机回_硒鼓墨盒回收-广州益美二手电脑回收公司 | 订做不锈钢_不锈钢定做加工厂_不锈钢非标定制-重庆侨峰金属加工厂 | 四川职高信息网-初高中、大专、职业技术学校招生信息网 | 无锡不干胶标签,卷筒标签,无锡瑞彩包装材料有限公司 | 对夹式止回阀_对夹式蝶形止回阀_对夹式软密封止回阀_超薄型止回阀_不锈钢底阀-温州上炬阀门科技有限公司 | 电磁流量计_智能防腐防爆管道式计量表-金湖凯铭仪表有限公司 | 立式硫化罐-劳保用品硫化罐-厂家直销-山东鑫泰鑫硫化罐厂家 | 耐高温硅酸铝板-硅酸铝棉保温施工|亿欧建设工程 | 招商帮-一站式网络营销服务|互联网整合营销|网络推广代运营|信息流推广|招商帮企业招商好帮手|搜索营销推广|短视视频营销推广 |