山寨一個Spring的@Component註解

碼農小胖哥發表於2020-10-06
Spring

1. 前言

我們在上一篇對Mybatis如何將Mapper介面注入Spring IoC進行了分析，有同學問胖哥這個有什麼用，這個作用其實挺大的，比如讓你實現一個類似@Controller的註解（或者繼承某個統一介面）來完成比如定時任務的統一注入或者Websocket處理器的統一注入等這種將某種共性的Bean動態注入。

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

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

以上虛擬碼就是一個模仿Controller的定時任務Bean。

2. 設計思路

詳細的開發設計思路我已經總結好了，各位同學只要按部就班就可以實現這個功能了。

2.1 定義掃描註解

定義一個類似@MappScan的進行匯入自定義ImportBeanDefinitionRegistrar,並指定掃描包範圍。

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

    String[] basePackages();
}

我們自定義了一個掃描註解@XBeanScan。它有兩個作用：

  • 通過basePackages指定掃描包的範圍。
  • 匯入我們自定義ImportBeanDefinitionRegistrar 的實現XBeanDefinitionRegistrar。

2.2 定義目標Bean的通用標記

通常我們可以選擇一個標識介面，所有其實現類都會注入Spring IoC；或者用更加方便的註解，所有被該註解標記的類都將注入Spring IoC。這裡我們使用更加靈活方便的註解，實現了一個@XBean標記註解:

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

2.3 實現掃描器

Spring框架為我們提供了掃描器來註冊被標記的Bean,它就是上節提到的ClassPathBeanDefinitionScanner，我們繼承它進行稍加改造：

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

這裡我們不使用預設的過濾器，我們指定了掃描器掃描的目標為被@XBean標記的那些Bean。

2.4 實現 Bean 序號產生器

重頭戲來了，我們需要將2.1到2.3定義的這些元件在ImportBeanDefinitionRegistrar的實現中組裝起來。

/**
 * 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) {
        // 不使用預設過濾器
        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  包路徑陣列
     */
    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");
    }
}

從註解後設資料importingClassMetadata解析我們需要的掃描路徑basePackages等後設資料，然後讓掃描器在該路徑掃描即可。

2.5 使用

在具有@Configuration標記的類或者Spring Boot的Main類上使用@XBeanScan即可，是不是非常簡單！

其實@ComponentScan提供類似的功能。

3. 總結

本篇是對上一篇理論的具體應用，說實話上一篇比較枯燥甚至抓不住重點，但是有時候理論就是這樣的。一旦你結合本篇來看你會恍然大悟。如果你需要更加細粒度控制就加上那些BeanDefinitionRegistryPostProcessor和FactoryBean等Spring提供的功能性介面。從這兩篇中更多需要你學習的是如何從閱讀原始碼中觸類旁通，來利用已有的元件來實現自己的邏輯。這對你的提高是極大的。好了今天就到這裡，多多關注：碼農小胖哥 更多幹貨等著你。

關注公眾號：Felordcn 獲取更多資訊

個人部落格：https://felord.cn

相關文章