ShardingSphere-Proxy分库分表以及多租户安装使用
需求:你提供SAAS服务,你有你有2个租户(商户),各自的数据进各自的库,而你不希望你的微服务java里默认配置多个租户数据源,数据连接池太多,而且后面动态增加也不方便,诸如此类很多问题。
方案:ShardingSphere-Proxy基于数据库表有一个租户字段
1.ShardingSphere-Proxy家族产品简介
ShardingSphere-Proxy和ShardingSphere-JDBC都是ShardingSphere的不同产品。
ShardingSphere-JDBC是客户端分库分表,而ShardingSphere-Proxy是一个中间层,客户端代码无需配置修改,定位为透明化的数据库代理端,提供封装了数据库二进制协议的服务端版本,用于完成对异构语言的支持。 目前提供 MySQL 和 PostgreSQL(兼容 openGauss 等基于 PostgreSQL 的数据库)版本,它可以使用任何兼容 MySQL/PostgreSQL 协议的访问客户端(如:MySQL Command Client, MySQL Workbench, Navicat 等)操作数据,对 DBA 更加友好。
向应用程序完全透明,可直接当做 MySQL/PostgreSQL 使用。
适用于任何兼容 MySQL/PostgreSQL 协议的的客户端。
2.分库分表和多租户
分库分表一般使用的是hash取模的方式,很多类似产品都是这样实现的。
ShardingSphere有一个特别的亮点是基于表中某一个字段进行分库分表。
我们可以利用这个实现多租户。
至于ShardingSphere-Proxy和ShardingSphere-JDBC配置使用是一样的,只是一个客户端一个中间层而已。
3.系统环境依赖
很多参考信息包括官方网站都不是很友好,导致安装使用过程中遇到太多问题需要解决,那么我这里就把完整的教程和注意事项写下来,照着做就行了。
环境:CentOS7.8
ShardingSphere-Proxy官方网站:ShardingSphere
安装java
ShardingSphere-Proxy需要基于java,如果已经安装可以忽略。
另外本机内存需要注意需要4G内存以上,不然Java启动会报错内存不足。
我们这边假设是从阿里云进行购买ECS,自己安装。
cd /usr/local
解压jdk,1.8以上版本皆可
tar -zxvf jdk-8u221-linux-x64.tar.gz
将jdk配置到/etc/profile
vim /etc/profile
export JAVA_HOME=/usr/local/jdk1.8.0_221
export JRE_HOME=${JAVA_HOME}/jre
export CLASSPATH=.:${JAVA_HOME}/lib:${JRE_HOME}/lib:$CLASSPATH
export JAVA_PATH=${JAVA_HOME}/bin:${JRE_HOME}/bin
export PATH=$PATH:${JAVA_PATH}
通过命令source /etc/profile让profile文件立即生效
source /etc/profile
查看是否安装好
java -version
只是source /etc/profile如果还报错nohup: failed to run command ‘java’: No such file or directory
需要重启才可以生效
reboot
4.下载安装ShardingSphere-Proxy
下载 :: ShardingSphere
下载地址:Apache Downloads
cd /usr/local
wget https://dlcdn.apache.org/shardingsphere/5.0.0/apache-shardingsphere-5.0.0-shardingsphere-proxy-bin.tar.gz
tar -xzvf apache-shardingsphere-5.0.0-shardingsphere-proxy-bin.tar.gz
解压好之后目录结构如下:
conf是配置目录,bin是启动目录,lib是库目录。
如果使用mysql需要把mysql对应的jar拷贝到这里。
cd ./lib
wget https://repo1.maven.org/maven2/mysql/mysql-connector-java/5.1.49/mysql-connector-java-5.1.49.jar
5.下载安装配置ShardingSphere-Proxy
回到conf目录
修改2个文件其他文件暂时不用动
server.xml和config-sharding.yaml
需要注意的是ShardingSphere-Proxy其他版本例如4.0的配置和5.0有些许差异,特别是其他博文是4.0的例子,不能直接拿来就用,会启动报错。
5.0的配置默认都给你注释了,你就用官方给你的就行。
server.xml
rules:
- !AUTHORITY
users:
- root@%:root
- sharding@:sharding
provider:
type: ALL_PRIVILEGES_PERMITTED
- !TRANSACTION
defaultType: XA
providerType: Atomikos
props:
max.connections.size.per.query: 1
acceptor.size: 16 # The default value is available processors count * 2.
executor.size: 16 # Infinite by default.
proxy.frontend.flush.threshold: 128 # The default value is 128.
# LOCAL: Proxy will run with LOCAL transaction.
# XA: Proxy will run with XA transaction.
# BASE: Proxy will run with B.A.S.E transaction.
proxy.transaction.type: LOCAL
proxy.opentracing.enabled: false
proxy.hint.enabled: false
query.with.cipher.column: true
# 这个属性会打印sql 语句
sql.show: true
# 该属性会允许范围查询,默认为 false ,要是我们分库分表是水平切分,可以想得到范围查询会像广播去查每一个表,比较耗性能能。
allow.range.query.with.inline.sharding: true
例如你有2个完全一样的库,你有2个商户,各自的数据进各自的库。
schemaName: sharding_db
dataSources:
his95001:
url: jdbc:mysql://localhost:3306/order1001?useUnicode=true&characterEncoding=utf8
username: root
password: root
connectionTimeoutMilliseconds: 30000
idleTimeoutMilliseconds: 60000
maxLifetimeMilliseconds: 1800000
maxPoolSize: 50
minPoolSize: 1
his95002:
url: jdbc:mysql://localhost:3306/order1002?useUnicode=true&characterEncoding=utf8
username: root
password: root
connectionTimeoutMilliseconds: 30000
idleTimeoutMilliseconds: 60000
maxLifetimeMilliseconds: 1800000
maxPoolSize: 50
minPoolSize: 1
rules:
- !SHARDING
tables:
tb_order:
actualDataNodes: order1001.tb_order,order1002.tb_order
tb_content:
actualDataNodes: order1001.tb_content,order1002.tb_content
defaultDatabaseStrategy:
standard:
shardingColumn: tenantid
shardingAlgorithmName: database_inline
shardingAlgorithms:
database_inline:
type: INLINE
props:
algorithm-expression: order${tenantid}
需要注意的是数据库名是 前缀+租户id 不可以有下划线横线之类,记得之前的4.0版本会出错,还有数据库密码不能保护#,其他特殊字符我没注意,如果报错数据库连不上也是这些问题。
启动文件在bin目录
默认是启动3307端口,你可以修改为你需要的端口日志位置,如果JVM需要调休可以修改对应配置。
./bin/start.sh
需要看日志,如果有异常,一开始主要是配置异常那么你要适当的去修改。
cat ./stdout.log
例如下面是缺少mysql-connector-java-5.1.49.jar
成功启动会提示:frontend.ShardingSphereProxy - ShardingSphere-Proxy start success
6.使用ShardingSphere-Proxy
启动好之后可以使用navicat.exe测试连接。
我们可以看到现在我们链家我们搭建的ShardingSphere-Proxy的服务器所在的ip+3007端口可以看到代理的数据库了。
如果你点开其中一个表可以看到数据是聚合的。
实际上你的SQL需要带对应的租户id就路由到对应的数据库了。
7.安装Zookeeper
https://linuxstyle.blog.csdn.net/article/details/122367289
修改server.yaml 去掉注释就行了
#mode:
# type: Cluster
# repository:
# type: ZooKeeper
# props:
# namespace: governance_ds
# server-lists: localhost:2181
# retryIntervalMilliseconds: 500
# timeToLiveSeconds: 60
# maxRetries: 3
# operationTimeoutMilliseconds: 500
# overwrite: true
8.最佳实践
sharding-jdbc分表查询优化:maxConnectionsSizePerQuery
sharding-jdbc配置maxConnectionsSizePerQuery当存在分表,且查询语句不包含分表键时,每个查询都需要分解成不同的分表sql查询数据库,能够同时执行的sql数量由此参数设置;
这个数据最好=你的分表数量