ShardingSphere-JDBC——读写分离配置手册-京东云开发者社区

# Java API

## 配置入口

类名称：ReplicaQueryRuleConfiguration

可配置属性：

| *名称*             | *数据类型*                                             | *说明*            |
| ----------------- | ----------------------------------------------------- | ----------------- |
| dataSources (+)   | Collection\<ReplicaQueryDataSourceRuleConfiguration\> | 主从数据源配置      |
| loadBalancers (*) | Map\<String, ShardingSphereAlgorithmConfiguration\>   | 从库负载均衡算法配置 |

## 主从数据源配置

类名称：ReplicaQueryDataSourceRuleConfiguration

可配置属性：

| *名称*                     | *数据类型*             | *说明*             | *默认值*       |
| -------------------------- | -------------------- | ------------------ | ------------- |
| name                       | String               | 读写分离数据源名称   | -             |
| primaryDataSourceName      | String               | 主库数据源名称      | -              |
| replicaDataSourceNames (+) | Collection\<String\> | 从库数据源名称列表   | -              |
| loadBalancerName (?)       | String               | 从库负载均衡算法名称 | 轮询负载均衡算法 |

算法类型的详情，请参见[内置负载均衡算法列表]
# YAML配置
+++
title = "读写分离"
weight = 2
+++

## 配置项说明

```yaml
dataSources: # 省略数据源配置，请参考使用手册

rules:
- !REPLICA_QUERY
  dataSources:
    <data-source-name> (+): # 读写分离逻辑数据源名称
      primaryDataSourceName: # 主库数据源名称
      replicaDataSourceNames: 
        - <replica-data_source-name> (+) # 从库数据源名称
      loadBalancerName: # 负载均衡算法名称
  
  # 负载均衡算法配置
  loadBalancers:
    <load-balancer-name> (+): # 负载均衡算法名称
      type: # 负载均衡算法类型
      props: # 负载均衡算法属性配置
        # ...

props:
  # ...
```

算法类型的详情，请参见[内置负载均衡算法列表]
# SPRING BOOT STARTER 配置

## 配置项说明

```properties
spring.shardingsphere.datasource.names= # 省略数据源配置，请参考使用手册

spring.shardingsphere.rules.replica-query.data-sources.<replica-query-data-source-name>.primary-data-source-name= # 主数据源名称
spring.shardingsphere.rules.replica-query.data-sources.<replica-query-data-source-name>.replica-data-source-names= # 从数据源名称，多个从数据源用逗号分隔
spring.shardingsphere.rules.replica-query.data-sources.<replica-query-data-source-name>.load-balancer-name= # 负载均衡算法名称

# 负载均衡算法配置
spring.shardingsphere.rules.replica-query.load-balancers.<load-balance-algorithm-name>.type= # 负载均衡算法类型
spring.shardingsphere.rules.replica-query.load-balancers.<load-balance-algorithm-name>.props.xxx= # 负载均衡算法属性配置
```

算法类型的详情，请参见[内置负载均衡算法列表]

# SPRING 命名空间配置

## 配置项说明

命名空间：[http://shardingsphere.apache.org/schema/shardingsphere/replica-query/replica-query-5.0.0.xsd](http://shardingsphere.apache.org/schema/shardingsphere/replica-query/replica-query-5.0.0.xsd)

\<replica-query:rule />

| *名称*                | *类型* | *说明*           |
| -------------------- | ------ | --------------- |
| id                   | 属性   | Spring Bean Id   |
| data-source-rule (+) | 标签   | 读写分离数据源规则配置 |

\<replica-query:data-source-rule />

| *名称*                     | *类型* | *说明*                          |
| -------------------------- | ----- | ------------------------------- |
| id                         | 属性  | 读写分离数据源规则名称             |
| primary-data-source-name   | 属性  | 主数据源名称                      |
| replica-data-source-names  | 属性  | 从数据源名称，多个从数据源用逗号分隔 |
| load-balance-algorithm-ref | 属性  | 负载均衡算法名称                   |

\<replica-query:load-balance-algorithm />

| *名称*    | *类型* | *说明*            |
| --------- | ----- | ----------------- |
| id        | 属性  | 负载均衡算法名称    |
| type      | 属性  | 负载均衡算法类型    |
| props (?) | 标签  | 负载均衡算法属性配置 |

算法类型的详情，请参见[内置负载均衡算法列表]。