使用手册

Proxy启动

  1. 下载Sharding-Proxy的最新发行版，地址:https://github.com/sharding-sphere/sharding-sphere-doc/raw/master/dist/sharding-proxy-3.0.0.tar.gz
  2. 如果使用docker，可以执行docker pull shardingsphere/sharding-proxy获取镜像。详细信息请参考Docker镜像。
  3. 解压缩后修改conf/server.yaml和以config-前缀开头的文件，如：conf/config-xxx.yaml文件，进行分片规则、读写分离规则配置. 配置方式请参考配置手册。
  4. Linux操作系统请运行bin/start.sh，Windows操作系统请运行bin/start.bat启动Sharding-Proxy。如需配置启动端口、配置文件位置，可参考快速入门 进行启动。
  5. 使用任何MySQL的客户端连接。如: mysql -u root -h 127.0.0.1 -P 3307

注册中心使用

若想使用Sharding-Proxy的数据库治理功能，则需要使用注册中心实现实例熔断和从库禁用功能。详情请参考支持的注册中心。

Zookeeper

  1. Sharding-Proxy默认提供了Zookeeper的注册中心解决方案。您只需按照配置规则进行注册中心的配置，即可使用。

Etcd

  1. 将Sharding-Proxy的lib目录下的sharding-orchestration-reg-zookeeper-curator-${sharding-sphere.version}.jar文件删除。
  2. Maven仓库下载Etcd解决方案的最新稳定版jar包。
  3. 将下载下来的jar包放到Sharding-Proxy的lib目录下。
  4. 按照配置规则进行注册中心的配置，即可使用。

其他第三方注册中心

  1. 将Sharding-Proxy的lib目录下的sharding-orchestration-reg-zookeeper-curator-${sharding-sphere.version}.jar文件删除。
  2. 使用SPI方式实现相关逻辑编码，并将生成的jar包放到Sharding-Proxy的lib目录下。
  3. 按照配置规则进行注册中心的配置，即可使用。

分布式事务

Sharding-Proxy原生支持XA事务，不需要额外的配置。

配置默认事务类型

默认事务类型可在server.yaml中进行配置，例如：

proxy.transaction.type: XA

切换运行时事务类型

命令行方式

mysql> sctl: set transantcion_type=XA
mysql> sctl: show transaction_type

原生JDBC方式

如果通过JDBC-Driver的方式连接Sharding-Proxy，可以在获取连接后，发送sctl:set transaction_type=XA的SQL切换事务类型。

Spring注解方式

引入Maven依赖：

<dependency>
    <groupId>io.shardingsphere</groupId>
    <artifactId>sharding-transaction-spring</artifactId>
    <version>${shardingsphere.version}</version>
</dependency>

然后在需要事务的方法或类中添加相关注解即可，例如：

@ShardingTransactionType(TransactionType.LOCAL)
@Transactional

或

@ShardingTransactionType(TransactionType.XA)
@Transactional

注意：@ShardingTransactionType需要同Spring的@Transactional配套使用，事务才会生效。

Atomikos参数配置

ShardingSphere默认的XA事务管理器为Atomikos。 可以通过在Sharding-Proxy的conf目录中添加jta.properties来定制化Atomikos配置项。 具体的配置规则请参考Atomikos的官方文档。

注意事项

  1. Sharding-Proxy默认使用3307端口，可以通过启动脚本追加参数作为启动端口号。如: bin/start.sh 3308
  2. Sharding-Proxy使用conf/server.yaml配置注册中心、认证信息以及公用属性。
  3. Sharding-Proxy支持多逻辑数据源，每个以config-前缀命名的yaml配置文件，即为一个逻辑数据源。