經過這篇文章文章,是不是對@Component?的使用和實現原理一清二楚了呢,其實Spring?中還有@Service、@Controller和@Repository?等注解,他們和@Component有什么區別呢,你知道嗎?
概述
想必@Component注解大家一直在使用,只要類上加上它,就可以被Spring容器管理,那大家有想過它是怎么實現的嗎?本篇文章就帶領到家揭秘。
注解介紹
用來標記的類是一個“組件”或者說是一個Bean,Spring會自動掃描標記@Component注解的類作為一個Spring Bean對象。
注解源碼:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Indexed
public @interface Component {
/**
* The value may indicate a suggestion for a logical component name,
* to be turned into a Spring bean in case of an autodetected component.
* @return the suggested component name, if any (or empty String otherwise)
*/
String value() default "";
}
屬性說明:
- value: 自定義當前組件或者說bean的名稱,可以不配置, 不配置的話默認為組件的首字母小寫的類名。
元注解說明:
- 該注解只能使用在類,接口、枚舉、其他注解上
- 該注解的生命周期是運行時JVM
- @Indexed?元注解在spring 5.0引入,用于項目編譯打包時,會在自動生成META-INF/spring.components文件,簡歷索引,從而提高組件掃描效率,減少應用啟動時間。
注解使用
- 定義Person類,被@Component注解修飾

- 檢查Person類是否在掃描路徑下

- 獲取bean驗證


小結: 通過添加@Component能夠將類轉為Spring中的Bean對象,前提是能過夠被掃描到。
原理解析
閱讀源碼,我們查看@Component?注解的源碼,從中可以看到一個關鍵的類ClassPathBeanDefinitionScanner,我們可以從這個類下手,找到切入點。

分析ClassPathBeanDefinitionScanner?類,找到核心方法doscan, 打個斷點,了解整個調用鏈路。

具體分析結果如下:
- SpringBoot?應用啟動會注冊ConfigurationClassPostProcessor這個Bean,它實現了BeanDefinitionRegistryPostProcessor接口,而這個接口是Spring提供的一個擴展點,可以往BeanDefinition Registry中添加BeanDefintion。所以,只要能夠掃描到@Component注解的類,并且把它注冊到BeanDefinition Registry中即可。

- 關鍵方法ConfigurationClassPostProcessor的postProcessBeanDefinitionRegistry,查找@Component的類,并進行注冊。

- 我們直接跳到是如何查找@Component的類的,核心方法就是ClassPathBeanDefinitionScanner#doScan。
protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
Assert.notEmpty(basePackages, "At least one base package must be specified");
Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<>();
// 遍歷多個掃描目錄,如本例中的com.alvinlkk
for (String basePackage : basePackages) {
// 核心方法查找所有符合條件的BeanDefinition, 該方法后面重點關注
Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
// 遍歷找到的BeanDefinition
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);
}
// 驗證BeanDefinition
if (checkCandidate(beanName, candidate)) {
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
definitionHolder =
AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
beanDefinitions.add(definitionHolder);
// 注冊BeanDefinition到registry中
registerBeanDefinition(definitionHolder, this.registry);
}
}
}
return beanDefinitions;
}
- 重點關注ClassPathBeanDefinitionScanner#findCandidateComponents方法,找出候選的Bean Component。
public Set<BeanDefinition> findCandidateComponents(String basePackage) {
// 判斷組件是否加了索引,打包后默認會有索引,用于加快掃描
if (this.componentsIndex != null && indexSupportsIncludeFilters()) {
return addCandidateComponentsFromIndex(this.componentsIndex, basePackage);
}
// 重點查看else邏輯
else {
return scanCandidateComponents(basePackage);
}
}
private Set<BeanDefinition> scanCandidateComponents(String basePackage) {
Set<BeanDefinition> candidates = new LinkedHashSet<>();
try {
// 解析出需要掃描的路徑,本例是classpath*:com/alvinlkk/**/*.class
String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +
resolveBasePackage(basePackage) + '/' + this.resourcePattern;
// 根據掃描路徑找到所有的Resource
Resource[] resources = getResourcePatternResolver().getResources(packageSearchPath);
boolean traceEnabled = logger.isTraceEnabled();
boolean debugEnabled = logger.isDebugEnabled();
// 遍歷掃描路徑
for (Resource resource : resources) {
if (traceEnabled) {
logger.trace("Scanning " + resource);
}
try {
// 解析出掃描到類的元數據信息,里面包含了注解信息
MetadataReader metadataReader = getMetadataReaderFactory().getMetadataReader(resource);
// 關鍵方法,判斷是否候選組件
if (isCandidateComponent(metadataReader)) {
ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader);
sbd.setSource(resource);
if (isCandidateComponent(sbd)) {
if (debugEnabled) {
logger.debug("Identified candidate component class: " + resource);
}
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;
}
// 判斷是否候選的Bean Component
protected boolean isCandidateComponent(MetadataReader metadataReader) throws IOException {
// exclude過濾器,在exclude過濾其中的,會直接排除掉,返回false
for (TypeFilter tf : this.excludeFilters) {
if (tf.match(metadataReader, getMetadataReaderFactory())) {
return false;
}
}
// include過濾器, 這里會看到有AnnotationTypeFilter,注解類型過濾器
for (TypeFilter tf : this.includeFilters) {
// 調用AnnotationTypeFilter的match方法,來判斷是否滿足條件
if (tf.match(metadataReader, getMetadataReaderFactory())) {
// 下面在進行Condition的判斷,就是類上的@Conditional,這里不是重點
return isConditionMatch(metadataReader);
}
}
return false;
}

而這個AnnotationTypeFilter默認是在構造函數中注冊進去的。

小結:
@Component到Spring bean容器管理過程如下:
- 初始化時設置了Component類型過濾器;
- 根據指定掃描包掃描.class文件,生成Resource對象;
- 解析.class文件并注解歸類,生成MetadataReader對象;
- 使用第一步的注解過濾器過濾出有@Component類;
- 生成BeanDefinition對象;
- 把BeanDefinition注冊到Spring容器。
總結
經過這篇文章文章,是不是對@Component?的使用和實現原理一清二楚了呢,其實Spring?中還有@Service、@Controller和@Repository?等注解,他們和@Component有什么區別呢,你知道嗎?