SpringBoot中的@Component注解源碼
@Component注解的作用
@Component注解標(biāo)識的bean會注入到SpringBoot中,托管給SpringBoot。
使用@Component注解需要注意
@Component需要搭配@ComponentScan注解才可以生效。
@Component注解標(biāo)識的bean什么時候注入SpringBoot?
我們知道@SpringBootApplication注解,這個組合注解就是使用了@ComponentScan注解,
1. 使用自動裝配@ComponentScan注解,入口方法為invokeBeanFactoryPostProcessors();
2. @ComponentScan注解掃描
3. 掃描出來的bean
???????Set<BeanDefinitionHolder> scannedBeanDefinitions = this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());
4. ComponentScanAnnotationParser.parse();方法
// 解析@ComponentScan注解,掃描注入bean public Set<BeanDefinitionHolder> parse(AnnotationAttributes componentScan, String declaringClass) { ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(this.registry, componentScan.getBoolean("useDefaultFilters"), this.environment, this.resourceLoader); // bean名稱生成器,在解析注冊BeanDefinition的時候用到 Class<? extends BeanNameGenerator> generatorClass = componentScan.getClass("nameGenerator"); boolean useInheritedGenerator = (BeanNameGenerator.class == generatorClass); scanner.setBeanNameGenerator(useInheritedGenerator ? this.beanNameGenerator : BeanUtils.instantiateClass(generatorClass)); // 掃描到@Component組件是是否生成代理以及生成代理方式 ScopedProxyMode scopedProxyMode = componentScan.getEnum("scopedProxy"); if (scopedProxyMode != ScopedProxyMode.DEFAULT) { scanner.setScopedProxyMode(scopedProxyMode); } else { Class<? extends ScopeMetadataResolver> resolverClass = componentScan.getClass("scopeResolver"); scanner.setScopeMetadataResolver(BeanUtils.instantiateClass(resolverClass)); } // 掃描路徑時規(guī)則 scanner.setResourcePattern(componentScan.getString("resourcePattern")); // 如果一個對象如果不加上@Component注解,但是在掃描注解上加上該類的名稱,那么也會被掃描加載 for (AnnotationAttributes includeFilterAttributes : componentScan.getAnnotationArray("includeFilters")) { List<TypeFilter> typeFilters = TypeFilterUtils.createTypeFiltersFor(includeFilterAttributes, this.environment, this.resourceLoader, this.registry); for (TypeFilter typeFilter : typeFilters) { scanner.addIncludeFilter(typeFilter); } } // 掃描到某個類時需要忽略它 for (AnnotationAttributes excludeFilterAttributes : componentScan.getAnnotationArray("excludeFilters")) { List<TypeFilter> typeFilters = TypeFilterUtils.createTypeFiltersFor(excludeFilterAttributes, this.environment, this.resourceLoader, this.registry); for (TypeFilter typeFilter : typeFilters) { scanner.addExcludeFilter(typeFilter); } } // 標(biāo)識掃描注冊BeanDefinition后是否延遲初始化,默認(rèn)false boolean lazyInit = componentScan.getBoolean("lazyInit"); if (lazyInit) { scanner.getBeanDefinitionDefaults().setLazyInit(true); } Set<String> basePackages = new LinkedHashSet<>(); // 要掃描的路徑,如果為空,解析的時候會解析被@ComponentScan標(biāo)注類的包路徑 String[] basePackagesArray = componentScan.getStringArray("basePackages"); for (String pkg : basePackagesArray) { String[] tokenized = StringUtils.tokenizeToStringArray(this.environment.resolvePlaceholders(pkg), ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS); Collections.addAll(basePackages, tokenized); } // 包路徑類,與basePackages互斥 for (Class<?> clazz : componentScan.getClassArray("basePackageClasses")) { basePackages.add(ClassUtils.getPackageName(clazz)); } // 獲取啟動類所在的包 if (basePackages.isEmpty()) { basePackages.add(ClassUtils.getPackageName(declaringClass)); } scanner.addExcludeFilter(new AbstractTypeHierarchyTraversingFilter(false, false) { @Override protected boolean matchClassName(String className) { return declaringClass.equals(className); } }); // 在指定的基本包中執(zhí)行掃描,返回注冊的bean定義。 return scanner.doScan(StringUtils.toStringArray(basePackages)); }
因為我沒有配置@ComponentScan注解中的basePackages屬性,所以默認(rèn)掃描使用啟動類所在的包下的bean
???????protected Set<BeanDefinitionHolder> doScan(String... basePackages) { Assert.notEmpty(basePackages, "At least one base package must be specified"); Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<>(); for (String basePackage : basePackages) { // 掃描basePackage包,獲取所有配置了@Component注解的bean Set<BeanDefinition> candidates = findCandidateComponents(basePackage); for (BeanDefinition candidate : candidates) { ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate); candidate.setScope(scopeMetadata.getScopeName()); String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry); if (candidate instanceof AbstractBeanDefinition) { postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName); } if (candidate instanceof AnnotatedBeanDefinition) { AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate); } if (checkCandidate(beanName, candidate)) { BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName); definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry); beanDefinitions.add(definitionHolder); // 注冊@Component注解標(biāo)識的bean,將其放到beanDefinitionMap容器中 registerBeanDefinition(definitionHolder, this.registry); } } } return beanDefinitions; }
問題1,如何掃描到basePackage包下面的@Component注解的類?
這塊的代碼邏輯封裝在findCandidateComponents(basePackage);方法中
public Set<BeanDefinition> findCandidateComponents(String basePackage) { if (this.componentsIndex != null && indexSupportsIncludeFilters()) { return addCandidateComponentsFromIndex(this.componentsIndex, basePackage); } else { // 掃描@Component注解的類 return scanCandidateComponents(basePackage); } } private Set<BeanDefinition> scanCandidateComponents(String basePackage) { // 搜集合適BeanDefinition的集合 Set<BeanDefinition> candidates = new LinkedHashSet<>(); try { // 包路徑 classpath*:com/sunpeiyu/visualweb/**/*.class String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + resolveBasePackage(basePackage) + '/' + this.resourcePattern; // 獲取包路徑下面的所有文件 Resource[] resources = getResourcePatternResolver().getResources(packageSearchPath); boolean traceEnabled = logger.isTraceEnabled(); boolean debugEnabled = logger.isDebugEnabled(); // 遍歷文件資源 for (Resource resource : resources) { if (traceEnabled) { logger.trace("Scanning " + resource); } try { // 讀取資源的元信息,本身資源信息resource,元注解信息annotationMetadata MetadataReader metadataReader = getMetadataReaderFactory().getMetadataReader(resource); if (isCandidateComponent(metadataReader)) { ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader); sbd.setSource(resource); // 判斷當(dāng)前資源是否為@Component注解標(biāo)識的類 if (isCandidateComponent(sbd)) { if (debugEnabled) { logger.debug("Identified candidate component class: " + resource); } // 添加到搜集@Component注解的類的容器 candidates.add(sbd); } else { if (debugEnabled) { logger.debug("Ignored because not a concrete top-level class: " + resource); } } } else { if (traceEnabled) { logger.trace("Ignored because not matching any filter: " + resource); } } } catch (FileNotFoundException ex) { if (traceEnabled) { logger.trace("Ignored non-readable " + resource + ": " + ex.getMessage()); } } catch (Throwable ex) { throw new BeanDefinitionStoreException( "Failed to read candidate component class: " + resource, ex); } } } catch (IOException ex) { throw new BeanDefinitionStoreException("I/O failure during classpath scanning", ex); } return candidates; }
這塊的代碼邏輯封裝在ClassUtils.getPackageName(declaringClass)方法中,拿到全路徑啟動類,然后字符串截取前面的包
類似@Component的其他注解@Service、@Controller、@Repository注解
這些注解本身還是@Component注解,所以本身這些注解會走上面一樣的方法進(jìn)行注入bean到beanDefinitionMap中。
@Repository
@Service
@Controller
到此這篇關(guān)于SpringBoot中的@Component注解源碼的文章就介紹到這了,更多相關(guān)SpringBoot @Component注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
如何使用axis調(diào)用WebService及Java?WebService調(diào)用工具類
Axis是一個基于Java的Web服務(wù)框架,可以用來調(diào)用Web服務(wù)接口,下面這篇文章主要給大家介紹了關(guān)于如何使用axis調(diào)用WebService及Java?WebService調(diào)用工具類的相關(guān)資料,需要的朋友可以參考下2023-04-04Spring?MVC數(shù)據(jù)響應(yīng)處理詳解
這篇文章主要給大家介紹了關(guān)于Spring?MVC數(shù)據(jù)響應(yīng)處理的相關(guān)資料,本教程詳細(xì)的講解SpringMVC框架的使用,非常詳細(xì)的案例講解,一步一步帶你走入springmvc框架的核心,需要的朋友可以參考下2022-05-05MyBatis-Plus 使用枚舉自動關(guān)聯(lián)注入
本文主要介紹了MyBatis-Plus 使用枚舉自動關(guān)聯(lián)注入,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-06-06Springmvc ResponseBody響應(yīng)json數(shù)據(jù)實現(xiàn)過程
這篇文章主要介紹了Springmvc ResponseBody響應(yīng)json數(shù)據(jù)實現(xiàn)過程,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-10-10Spring?Cloud?Gateway整合sentinel?實現(xiàn)流控熔斷的問題
本文給大家介紹下?spring?cloud?gateway?如何整合?sentinel實現(xiàn)流控熔斷,本文通過實例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友一起看看吧2022-02-02三分鐘教你如何在IDEA中快速創(chuàng)建工程的方法
這篇文章主要介紹了三分鐘教你如何在IDEA中快速創(chuàng)建工程的方法,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-04-04spring.factories文件的解析源碼API機(jī)制詳解
通過本文深入探討Spring?Boot的背景歷史、業(yè)務(wù)場景、功能點(diǎn)以及底層原理,使讀者對Spring?Boot有了更深入的了解,結(jié)合實例代碼給大家介紹的非常詳細(xì),感興趣的朋友跟隨小編一起看看吧2024-11-11