Spring的@Component注解怎么使用

本篇內(nèi)容介紹了“Spring的@Component注解怎么使用”的有關(guān)知識(shí)，在實(shí)際案例的操作過程中，不少人都會(huì)遇到這樣的困境，接下來就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧！希望大家仔細(xì)閱讀，能夠?qū)W有所成！

1. 前言

實(shí)現(xiàn)一個(gè)類似@Controller的注解（或者繼承某個(gè)統(tǒng)一接口）來完成比如定時(shí)任務(wù)的統(tǒng)一注入或者Websocket處理器的統(tǒng)一注入等這種將某種共性的Bean動(dòng)態(tài)注入。

// 模仿 Controller  
@XBean(description = "ETL JOB")
public class JobShedule {

    @Caller(cron = "* * 0/5 * * ?")
    public void exec(){
        // job 
    }
}

以上偽代碼就是一個(gè)模仿Controller的定時(shí)任務(wù)Bean。

2. 設(shè)計(jì)思路

詳細(xì)的開發(fā)設(shè)計(jì)思路我已經(jīng)總結(jié)好了，各位同學(xué)只要按部就班就可以實(shí)現(xiàn)這個(gè)功能了。

2.1 定義掃描注解

定義一個(gè)類似@MappScan的進(jìn)行導(dǎo)入自定義ImportBeanDefinitionRegistrar,并指定掃描包范圍。

@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Import(XBeanDefinitionRegistrar.class)
public @interface XBeanScan {

    String[] basePackages();
}

我們自定義了一個(gè)掃描注解@XBeanScan。它有兩個(gè)作用：

• 通過basePackages指定掃描包的范圍。

• 導(dǎo)入我們自定義ImportBeanDefinitionRegistrar 的實(shí)現(xiàn)XBeanDefinitionRegistrar。

2.2 定義目標(biāo)Bean的通用標(biāo)記

通常我們可以選擇一個(gè)標(biāo)識(shí)接口，所有其實(shí)現(xiàn)類都會(huì)注入Spring IoC；或者用更加方便的注解，所有被該注解標(biāo)記的類都將注入Spring IoC。這里我們使用更加靈活方便的注解，實(shí)現(xiàn)了一個(gè)@XBean標(biāo)記注解:

@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface XBean {
    String description() default "";
}

2.3 實(shí)現(xiàn)掃描器

Spring框架為我們提供了掃描器來注冊(cè)被標(biāo)記的Bean,它就是上節(jié)提到的ClassPathBeanDefinitionScanner，我們繼承它進(jìn)行稍加改造：

public class XBeanDefinitionScanner extends ClassPathBeanDefinitionScanner {
    public XBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters) {
        super(registry, useDefaultFilters);
        super.addIncludeFilter(new AnnotationTypeFilter(XBean.class));
    }
}

這里我們不使用默認(rèn)的過濾器，我們指定了掃描器掃描的目標(biāo)為被@XBean標(biāo)記的那些Bean。

2.4 實(shí)現(xiàn) Bean 注冊(cè)機(jī)

重頭戲來了，我們需要將2.1到2.3定義的這些組件在ImportBeanDefinitionRegistrar的實(shí)現(xiàn)中組裝起來。

/**
 * The type X bean definition registrar.
 *
 * @author felord.cn
 * @since 2020 /9/18 22:59
 */
public class XBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {
    private ResourceLoader resourceLoader;

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        // 不使用默認(rèn)過濾器
        XBeanDefinitionScanner xBeanDefinitionScanner = new XBeanDefinitionScanner(registry, false);
        xBeanDefinitionScanner.setResourceLoader(resourceLoader);
        // 掃描XBeanScan注解指定的包
        xBeanDefinitionScanner.scan(getBasePackagesToScan(importingClassMetadata));
    }

    @Override
    public void setResourceLoader(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }

    /**
     * 獲取{@link XBeanScan}中聲明的掃描包路徑
     * @param metadata the meta
     * @return  包路徑數(shù)組
     */
    private String[] getBasePackagesToScan(AnnotationMetadata metadata) {
        String name = XBeanScan.class.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.getStringArray("basePackages");
    }
}

從注解元數(shù)據(jù)importingClassMetadata解析我們需要的掃描路徑basePackages等元數(shù)據(jù)，然后讓掃描器在該路徑掃描即可。

2.5 使用

在具有@Configuration標(biāo)記的類或者Spring Boot的Main類上使用@XBeanScan即可，是不是非常簡(jiǎn)單！

其實(shí)@ComponentScan提供類似的功能。

“Spring的@Component注解怎么使用”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)可以關(guān)注億速云網(wǎng)站，小編將為大家輸出更多高質(zhì)量的實(shí)用文章！