我们知道Soul网关内置了多种数据同步的支持，只需要简单的配置，即可使用数据同步功能。那么它是如何实现的呢？

下面我们针对基于Websocket数据同步进行分析，首先需要在pom.xml中加入下面的配置：

<dependency>
    <groupId>org.dromara</groupId>
    <artifactId>soul-spring-boot-starter-sync-data-websocket</artifactId>
    <version>${project.version}</version>
</dependency>

然后，在application.yml中加入：

soul:
  sync:
    websocket:
      urls: ws://localhost:9095/websocket

自动配置

我们知道Soul网关是Spring Boot应用，Spring Boot有个核心功能就是自动配置功能。该功能实现了根据classpath下的依赖内容自动配置Bean到Ioc容器。也就是spring-boot-autoconfigure模块

spring-boot-autoconfigure自动配置原理

Spring Boot的自动配置通过在class上标注@Configuration注解，并且基于@ConditionalOnClass和@ConditionalOnMissingBean等@Conditional注解的条件过滤，保证Spring Boot在满足一定条件下，才会将Bean自动注入IoC容器。

Spring Boot启动的时，Spring Boot通过在@EnableAutoConfiguration注解内使用@Import注解来完成导入配置功能，而EnableAutoConfigurationImportSelector内部则使用SpringFactoriesLoader.loadFactoryNames方法扫描有META-INF/spring.factories文件的jar包，加载以org.springframework.autoconfigure.EnableAutoConfiguration作为key的value配置。

soul-spring-boot-starter-sync-data-websocket.jar包下的spring.factories：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.dromara.soul.spring.boot.starter.sync.data.websocket.WebsocketSyncDataConfiguration

下面通过对WebsocketSyncDataConfiguration类的讲解来了解Spring Boot是如何进行自动装配的。

WebsocketSyncDataConfiguration.java

// Spring加载该类时，发现@Configuration注解。会扫描该类下所有带@Bean注解
// 的方法。并将该Bean自动注入到IoC容器。
@Configuration
// 当且仅当classpath下存在指定的WebsocketSyncDataService类时才成立
@ConditionalOnClass(WebsocketSyncDataService.class)
// 当且仅当application.yml中存在指定的配置项时成立
@ConditionalOnProperty(prefix = "soul.sync.websocket", name = "urls")
@Slf4j
public class WebsocketSyncDataConfiguration {
    // 创建 WebsocketSyncDataService Bean
    @Bean
    public SyncDataService websocketSyncDataService(final ObjectProvider<WebsocketConfig> websocketConfig, final ObjectProvider<PluginDataSubscriber> pluginSubscriber,
                                           final ObjectProvider<List<MetaDataSubscriber>> metaSubscribers, final ObjectProvider<List<AuthDataSubscriber>> authSubscribers) {
        log.info("you use websocket sync soul data.......");
        return new WebsocketSyncDataService(websocketConfig.getIfAvailable(WebsocketConfig::new), pluginSubscriber.getIfAvailable(),
                metaSubscribers.getIfAvailable(Collections::emptyList), authSubscribers.getIfAvailable(Collections::emptyList));
    }

    // 创建 WebsocketConfig Bean
    @Bean
    // 加载application.yml的soul.sync.websocket配置信息
    @ConfigurationProperties(prefix = "soul.sync.websocket")
    public WebsocketConfig websocketConfig() {
        return new WebsocketConfig();
    }
}

总结

主要学习spring-boot-autoconfigure的原理及常用的注解：

1. @Configuration和@Bean：基于Java代码的Bean配置
2. @Conditional：表示在满足某种条件后才会去初始化一个Bean或启用某些配置
3. @EnableConfigurationProperties和@ConfigurationProperties：读取配置文件转换为Bean。
4. @EnableAutoConfiguration和@Import：实现Bean发现和加载。