本系列Spring Boot 版本 3.1.0
本系列ShardingSphere 版本 5.4.0
Spring Boot
基础依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
Mybatis Plus
:
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-spring-boot3-starter</artifactId>
<version>3.5.5</version>
</dependency>
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>
ShardingSphere
在5.3.0
及之后的版本,考虑到维护兼容成本,更加专心于自身功能迭代,移除了Spring Boot Starter
,所以只能引入 ShardingSphere-JDBC
核心包:
<dependency>
<groupId>org.apache.shardingsphere</groupId>
<artifactId>shardingsphere-jdbc-core</artifactId>
<version>5.4.0</version>
</dependency>
<!--java.lang.ClassNotFoundException: com.sun.xml.internal.bind.v2.ContextFactory-->
<dependency>
<groupId>org.glassfish.jaxb</groupId>
<artifactId>jaxb-runtime</artifactId>
<version>2.3.8</version>
</dependency>
ShardingSphere-JDBC
在5.3.0
及之后的版本不再提供Spring Boot Starter
,所以配置方面有较大的变化,目前只支持Java API
和YAML
进行配置。
ShardingSphere
提供了 JDBC
驱动,首先需要在application.yml
中配置ShardingSphereDriver
,并指定YAML
配置文件地址:
server:
port: 8080
spring:
datasource:
# 配置 DataSource Driver
driver-class-name: org.apache.shardingsphere.driver.ShardingSphereDriver
# 指定 YAML 配置文件
url: jdbc:shardingsphere:classpath:readwrite-splitting-config.yml # 读写分离配置文件
application.yml
同级目录下创建readwrite-splitting-config.yml
续写分离配置文件,在该文件中,首先添加数据源配置:
# 数据源配置
dataSources:
# 主库
write_ds: # 逻辑名称
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://192.168.56.101:3306/test
username: root
password: "root"
# 从库1
read_ds_0:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://192.168.56.101:3307/test
username: root
password: "root"
# 从库2
read_ds_1:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://192.168.56.101:3308/test
username: root
password: "root"
然后添加读写分离规则、从库负载均衡相关配置:
# 规则配置
rules:
# 读写分离配置
- !READWRITE_SPLITTING
dataSources: # 数据源
readwrite_ds: # 读写分离逻辑数据源名称
writeDataSourceName: write_ds # 写库数据源名称
readDataSourceNames: # 读库数据源名称,多个从数据源用逗号分隔
- read_ds_0
- read_ds_1
transactionalReadQueryStrategy: PRIMARY # 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源)。默认值:DYNAMIC
loadBalancerName: read # 负载均衡自定义算法名称
# 负载均衡算法
loadBalancers:
read: # 自定义的算法名称
type: RANDOM # 负载均衡算法类型
props:
# 是否打印 SQL
sql-show: true
负载均衡(Load Balancing
)用于将工作负载分配到多个计算资源,以提高性能、可靠性、可扩展性。读写分离环境下,对于多台从库的访问策略,ShardingSphere
内置了多种负载均衡算法,满足用户绝大多数业务场景的需要
轮询
按顺序轮流对读库进行访问。
# 规则配置
rules:
# 读写分离配置
- !READWRITE_SPLITTING
dataSources: # 数据源
readwrite_ds: # 读写分离逻辑数据源名称
writeDataSourceName: write_ds # 写库数据源名称
readDataSourceNames: # 读库数据源名称,多个从数据源用逗号分隔
- read_ds_0
- read_ds_1
transactionalReadQueryStrategy: PRIMARY # 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源)。默认值:DYNAMIC
loadBalancerName: read # 负载均衡自定义算法名称
# 负载均衡算法
loadBalancers:
read: # 自定义的算法名称
type: ROUND_ROBIN # 负载均衡算法类型
随机
随机选取一台读库进行访问。
# 规则配置
rules:
# 读写分离配置
- !READWRITE_SPLITTING
dataSources: # 数据源
readwrite_ds: # 读写分离逻辑数据源名称
writeDataSourceName: write_ds # 写库数据源名称
readDataSourceNames: # 读库数据源名称,多个从数据源用逗号分隔
- read_ds_0
- read_ds_1
transactionalReadQueryStrategy: PRIMARY # 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源)。默认值:DYNAMIC
loadBalancerName: read # 负载均衡自定义算法名称
# 负载均衡算法
loadBalancers:
read: # 自定义的算法名称
type: RANDOM # 负载均衡算法类型
权重
给读库分配权重,权重高的优先访问。
# 规则配置
rules:
# 读写分离配置
- !READWRITE_SPLITTING
dataSources: # 数据源
readwrite_ds: # 读写分离逻辑数据源名称
writeDataSourceName: write_ds # 写库数据源名称
readDataSourceNames: # 读库数据源名称,多个从数据源用逗号分隔
- read_ds_0
- read_ds_1
transactionalReadQueryStrategy: PRIMARY # 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源)。默认值:DYNAMIC
loadBalancerName: read # 负载均衡自定义算法名称
# 负载均衡算法
loadBalancers:
read: # 自定义的算法名称
type: WEIGHT # 负载均衡算法类型
# 属性
props:
# 属性名使用读库名称,参数填写读库对应的权重值。权重参数范围最小值 > 0,合计 <= Double.MAX_VALUE。
# 读库名称: 权重
read_ds_0: 9
read_ds_1: 1
自定义
考虑到业务场景的复杂性,提供基于SPI
接口实现符合自己业务需要的负载均衡算法。
ShardingSphere
提供了读库负载均衡算法接口ReadQueryLoadBalanceAlgorithm
,用户根据自定的算法返回一个可访问的读库。
public interface ReadQueryLoadBalanceAlgorithm extends ShardingSphereAlgorithm {
/**
*
* @param name 读写分离逻辑数据源名称
* @param writeDataSourceName 写库数据源名称
* @param readDataSourceNames 读库数据源名称集合
* @return 命中的读库名称
*/
String getDataSource(String name, String writeDataSourceName, List<String> readDataSourceNames) {
}
实现ReadQueryLoadBalanceAlgorithm
接口,自定义一个负载均衡算法:
public final class CustomReadQueryLoadBalanceAlgorithm implements ReadQueryLoadBalanceAlgorithm {
/**
* 配置类中的props属性
* # 负载均衡算法
* loadBalancers:
* read: # 自定义的算法名称
* type: CUSTOM # 负载均衡算法类型
* # 属性
* props:
* # 属性名使用读库名称,参数填写读库对应的权重值。权重参数范围最小值 > 0,合计 <= Double.MAX_VALUE。
* # 读库名称: 权重
* read_ds_0: 9
* read_ds_1: 1
*/
private Properties props;
// 将配置类props属性赋值给当前对象
public void init(Properties props) {
this.props = props;
}
public String getDataSource(String name, String writeDataSourceName, List<String> readDataSourceNames) {
// 自定义算法逻辑(这里演示,直接返回第一个)
return readDataSourceNames.get(0);
}
/**
* 声明算法类型
*/
public String getType() {
return "CUSTOM";
}
/**
* 是否是默认
*/
public boolean isDefault() {
return false;
}
public Properties getProps() {
return props;
}
public void setProps(Properties props) {
this.props = props;
}
}
在resources
目录下创建META-INF\services
文件夹,并创建文件,名称为org.apache.shardingsphere.readwritesplitting.spi.ReadQueryLoadBalanceAlgorithm
,文件内容为自定义算法类全限定类名:
com.pearl.shardingsphere.rw.algorithm.CustomReadQueryLoadBalanceAlgorithm
配置类修改算法类型为自定义:
# 规则配置
rules:
# 读写分离配置
- !READWRITE_SPLITTING
dataSources: # 数据源
readwrite_ds: # 读写分离逻辑数据源名称
writeDataSourceName: write_ds # 写库数据源名称
readDataSourceNames: # 读库数据源名称,多个从数据源用逗号分隔
- read_ds_0
- read_ds_1
transactionalReadQueryStrategy: PRIMARY # 事务内读请求的路由策略,可选值:PRIMARY(路由至主库)、FIXED(同一事务内路由至固定数据源)、DYNAMIC(同一事务内路由至非固定数据源)。默认值:DYNAMIC
loadBalancerName: read # 负载均衡自定义算法名称
# 负载均衡算法
loadBalancers:
read: # 自定义的算法名称
type: CUSTOM # 负载均衡算法类型