读写分离Springboot2.x+ShardingSphere-JDBC+mybatis爬坑实录

通过本案例测试，务必保持版本统一，不同版本差别很大，可能会出现一些莫名错误
版本信息：
springboot:2.1.5
shardingsphere-jdbc-core-spring-boot-starter:5.0.0-alpha

1. 项目依赖：

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.46</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.0</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.shardingsphere</groupId>
            <artifactId>shardingsphere-jdbc-core-spring-boot-starter</artifactId>
            <version>5.0.0-alpha</version>
        </dependency>
    </dependencies>

2. application.properties配置文件内容：

1.如果需要yaml格式，可以搜索在线properties转yaml工具
2.使用如下配置，版本请保持一致

# 配置真实数据源
spring.shardingsphere.datasource.names=demo,demo1,demo2
#5.0.0-alpha版本版本数据源，要配公共数据源
spring.shardingsphere.datasource.common.type=com.zaxxer.hikari.HikariDataSource
spring.shardingsphere.datasource.common.driver-class-name=com.mysql.jdbc.Driver
spring.shardingsphere.datasource.common.username=root
spring.shardingsphere.datasource.common.password= 123456

# 配置写数据源
spring.shardingsphere.datasource.demo.jdbc-url=jdbc:mysql://localhost:3306/demo?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8

# 配置读数据源
spring.shardingsphere.datasource.demo1.jdbc-url=jdbc:mysql://localhost:3306/demo1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
spring.shardingsphere.datasource.demo2.jdbc-url=jdbc:mysql://localhost:3306/demo2?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8


#使用5.0.0-alpha版本，属性名为下面这个。所以使用时候，一定要保证统一
spring.shardingsphere.rules.replica-query.load-balancers.round-robin.type=ROUND_ROBIN
spring.shardingsphere.rules.replica-query.data-sources.rw.primary-data-source-name=demo
spring.shardingsphere.rules.replica-query.data-sources.rw.replica-data-source-names=demo1,demo2
spring.shardingsphere.rules.replica-query.data-sources.rw.load-balancer-name=round-robin
#必须得配，不配报错。虽然官方文档写负载均衡没有其他属性配置
spring.shardingsphere.rules.replica-query.load-balancers.round-robin.props.workId=123456

#打印sql
spring.shardingsphere.props.sql-show=true

mybatis.mapper-locations=classpath:mapper/*.xml
mybatis.type-aliases-package=com.lzc.shardingsphererwtest.entity

3. 测试用的库合表：

测试用表结构：

create table user
(
	id int auto_increment
		primary key,
	name varchar(25) null comment '姓名',
	age int null comment '年龄'
)
comment '测试用户表';

4. mybatis配置
和正常springboot整合mybatis一样。

5. 单元测试

6. 结果

写的时候都写在demo.user表里，说明实现了只写master

读的时候，在demo1.user 和demo2.user两张表里轮询读取，读取到结果和预期相符。

爬坑总结：

• 配置数据源，请使用common这种配置方式（上面application.properties文件中已提供）
  

• 使用最新5.0.0-alpha版本，配置读写分离时候，官方文档还没跟新。请使用如下正确配置方式
  

• 必须加上一个负载均衡的props配置，虽然官网说没有更多的负载均衡配置，但是不配置会报错。worerId你换成aaa都没事，但是这一项必须配置。
  

• 配置文件中自定义的一些名称不能有 ‘_’ 划线，可以有 ‘-’ 划线
  

• 遇到Caused by: java.util.NoSuchElementException: No value bound，请检查配置
  1.配置方式和使用的版本对不上，包括springboot版本很shardingJDBC版本；
  2.负载均衡的props未配置；
  3.还找不到原因去githu上官方仓库里的issue里搜吧，很多人都遇到这个坑