ShardingSphere-JDBC5.2.X读写分离配置示例（Java Config）

不负众望，ShardingSphere的5.2.X版本，在带来若干新特性的同时，又双叒叕修改了API。
以下，就是ShardingSphere-JDBC5.2.X版本的读写分离JavaConfig配置示例。
5.2.0和5.2.1版本，都可以使用以下配置，初始化读写分离数据源。

JavaConfig

package cn.mrxionge.webtemplatemysql.config;

import com.zaxxer.hikari.HikariDataSource;
import lombok.extern.slf4j.Slf4j;
import org.apache.shardingsphere.driver.api.ShardingSphereDataSourceFactory;
import org.apache.shardingsphere.infra.config.algorithm.AlgorithmConfiguration;
import org.apache.shardingsphere.readwritesplitting.api.ReadwriteSplittingRuleConfiguration;
import org.apache.shardingsphere.readwritesplitting.api.rule.ReadwriteSplittingDataSourceRuleConfiguration;
import org.apache.shardingsphere.readwritesplitting.api.strategy.StaticReadwriteSplittingStrategyConfiguration;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;
import java.sql.SQLException;
import java.util.*;

/**
 * MySQL读写分离数据源
 */
@Slf4j
@Configuration
public class MySQLConfig {

    @Value("${mysql-ds.master.jdbc-url}")
    private String masterJdbcUrl;

    @Value("${mysql-ds.master.username}")
    private String masterUsername;

    @Value("${mysql-ds.master.password}")
    private String masterPassword;

    @Value("${mysql-ds.replica-1.jdbc-url}")
    private String replica1JdbcUrl;

    @Value("${mysql-ds.replica-1.username}")
    private String replica1Username;

    @Value("${mysql-ds.replica-1.password}")
    private String replica1Password;

    @Value("${mysql-ds.replica-2.jdbc-url}")
    private String replica2JdbcUrl;

    @Value("${mysql-ds.replica-2.username}")
    private String replica2Username;

    @Value("${mysql-ds.replica-2.password}")
    private String replica2Password;

    @Bean
    public DataSource dataSource() throws SQLException {
        //数据源Map
        Map<String, DataSource> dsMap = new HashMap<>();
        //配置主库
        HikariDataSource masterDs = new HikariDataSource();
        masterDs.setDriverClassName("com.mysql.cj.jdbc.Driver");
        masterDs.setJdbcUrl(masterJdbcUrl);
        masterDs.setMinimumIdle(16);
        masterDs.setMaximumPoolSize(32);
        masterDs.setConnectionInitSql("SET NAMES utf8mb4");
        masterDs.setUsername(masterUsername);
        masterDs.setPassword(masterPassword);
        dsMap.put("master_ds", masterDs);
        //配置读库1
        HikariDataSource replicaDs1 = new HikariDataSource();
        replicaDs1.setDriverClassName("com.mysql.cj.jdbc.Driver");
        replicaDs1.setJdbcUrl(replica1JdbcUrl);
        replicaDs1.setMinimumIdle(16);
        replicaDs1.setMaximumPoolSize(32);
        replicaDs1.setConnectionInitSql("SET NAMES utf8mb4");
        replicaDs1.setUsername(replica1Username);
        replicaDs1.setPassword(replica1Password);
        dsMap.put("replica_ds_1", replicaDs1);
        //配置读库2
        HikariDataSource replicaDs2 = new HikariDataSource();
        replicaDs2.setDriverClassName("com.mysql.cj.jdbc.Driver");
        replicaDs2.setJdbcUrl(replica2JdbcUrl);
        replicaDs2.setMinimumIdle(16);
        replicaDs2.setMaximumPoolSize(32);
        replicaDs2.setConnectionInitSql("SET NAMES utf8mb4");
        replicaDs2.setUsername(replica2Username);
        replicaDs2.setPassword(replica2Password);
        dsMap.put("replica_ds_2", replicaDs2);
        //主从数据源配置
        List<ReadwriteSplittingDataSourceRuleConfiguration> dsConfig = new ArrayList<>();
        dsConfig.add(new ReadwriteSplittingDataSourceRuleConfiguration("ds",
                new StaticReadwriteSplittingStrategyConfiguration("master_ds", List.of("replica_ds_1", "replica_ds_2", "replica_ds_3")),
                null, "load_balancer"));
        //负载均衡算法配置
        Map<String, AlgorithmConfiguration> loadBalanceMap = new HashMap<>();
        loadBalanceMap.put("load_balancer", new AlgorithmConfiguration("ROUND_ROBIN", new Properties()));
        ReadwriteSplittingRuleConfiguration ruleConfig = new ReadwriteSplittingRuleConfiguration(dsConfig, loadBalanceMap);
        //创建DS
        log.info("创建 ShardingSphere 读写分离数据源");
        return ShardingSphereDataSourceFactory.createDataSource(dsMap, List.of(ruleConfig), new Properties());
    }
}

注意事项

①版本

如果使用的shardingsphere-jdbc版本>=5.2.1，所依赖的snakeyaml本版需要>=1.32。

        <dependency>
            <groupId>org.yaml</groupId>
            <artifactId>snakeyaml</artifactId>
            <version>1.32</version>
        </dependency>

②数据源数量

以上面的JavaConfig为例，一共是1个主库，2个从库，按道理，初始化读写分离数据源的时候，我们在日志中看到3个HikariDataSource初始化的信息。但是5.2.0之后，我们会看到初始化了4个数据源。
具体原因可以参考issue：https://github.com/apache/shardingsphere/issues/21650
相关类：“org.apache.shardingsphere.mode.repository.standalone.jdbc.JDBCRepository”