從-1開始實現一箇中介軟體

別人都寫從0開始實現xxx，我先從-1開始就顯得更牛逼一些。

今天，先開個頭，來教大家怎麼實現一箇中介軟體。

新建專案

首先，我們新建一個多 module 的專案用於測試。

專案包含兩個模組，test-infra使用者中介軟體模組的開發，demo用於測試。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.aixiaoxian.infra</groupId>
    <artifactId>aixiaoxian-infra</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <name>aixiaoxian-infra</name>
    <description>aixiaoxian-infra</description>
    <packaging>pom</packaging>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <modules>
        <module>demo</module>
        <module>test-infra</module>
    </modules>

    <dependencies>

    </dependencies>

    <build>
        <plugins>
            <!-- Source -->
            <plugin>
                <artifactId>maven-source-plugin</artifactId>
                <inherited>true</inherited>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>jar-no-fork</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

開發中介軟體

專案建立 OK 了，接著開始開發一個最最最簡單的中介軟體。

在resources目錄下建立META-INFA/spring.factories檔案，用於自動裝配，別問我啥是自動裝配，然後設定一個自動裝配類。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.aixiaoxian.testInfra.config.TestConfiguration

實現 TestConfiguration，最簡單的方式，直接使用@Bean註解宣告一個 Bean 交給 Spring 管理。

@Configuration
public class TestConfiguration implements BeanDefinitionRegistryPostProcessor, EnvironmentAware {
    private Environment environment;

    @Bean
    public TestManager getTestManager() {
        return new TestManager();
    }
  
   @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }

}

然後實現真正的中介軟體邏輯的處理部分TestManager。

@Slf4j
public class TestManager {

    public TestManager() {
        init();
    }

    public void init(){
        log.info("TestManager start");
    }
}

這樣的話，一個最簡單的中介軟體就開發好了，直接把他新增到demo模組中，啟動測試即可。

 <dependency>
   <groupId>com.aixiaoxian.infra</groupId>
   <artifactId>test-infra</artifactId>
   <version>0.0.1-SNAPSHOT</version>
 </dependency>

換個姿勢

我們換個姿勢去建立 Bean，使用BeanDefinitionRegistryPostProcessor，讓 TestConfiguration 去實現它，重寫postProcessBeanDefinitionRegistry，註冊一個新的 Bean aiManager，這樣也是 OK的，寫法很多，不再贅述。

@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry) throws BeansException {
    BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(AiManager.class);
    beanDefinitionBuilder.addConstructorArgValue(this.environment);
    beanDefinitionRegistry.registerBeanDefinition("aiManager", beanDefinitionBuilder.getBeanDefinition());
}

@Slf4j
public class AiManager {
    private Environment environment;

    public AiManager(Environment environment) {
        this.environment = environment;

        init();
    }

    public void init(){
        log.info("AiManager start");
    }
}

再換個姿勢

對於自動裝配建立 Bean 有了基本的瞭解，那如果我想宣告一個註解給別人用該怎麼做？

首先建立一個註解，注意我使用了@Import註解，TestImportSelector 實現TestImportSelector介面。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import({TestImportSelector.class})
@Documented
public @interface TestAnnotation {
}

public class TestImportSelector implements DeferredImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        return new String[]{AnnotationConfiguration.class.getName()};
    }
}

AnnotationConfiguration 寫法也很簡單了，這樣也實現了自動裝配，當然了你要是用上面的寫法也能達到一樣的效果，但是建議這樣寫，別問，問就是這樣。

public class AnnotationConfiguration implements BeanDefinitionRegistryPostProcessor {

    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry) throws BeansException {
        BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(AnnotationManager.class);
        beanDefinitionRegistry.registerBeanDefinition("annotationManager", beanDefinitionBuilder.getBeanDefinition());
    }

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {

    }
}

@Slf4j
public class AnnotationManager {

    public AnnotationManager() {
        init();
    }

    public void init(){
        log.info("AnnotationManager start");
    }
}

最後在demo啟動類上打上我們這個註解。

@SpringBootApplication
@TestAnnotation
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

最後我們可以看到輸出：

2022-06-21 19:05:07.433  INFO 4598 --- [           main] c.a.testInfra.manager.TestManager        : TestManager start
2022-06-21 19:05:07.456  INFO 4598 --- [           main] c.a.testInfra.manager.AiManager          : AiManager start
2022-06-21 19:05:07.456  INFO 4598 --- [           main] c.a.testInfra.manager.AnnotationManager  : AnnotationManager start

好了，就這樣，我猜，沒人需要這個原始碼吧？為了後面的文章，先寫個這個鋪墊一下，結束。