简介

YAML 提供通过配置文件的方式与 ShardingSphere-JDBC 交互。 配合治理模块一同使用时,持久化在配置中心的配置均为 YAML 格式。

YAML 配置是最常见的配置方式,可以省略编程的复杂度,简化用户配置。

使用步骤

引入 Maven 依赖

  1. <dependency>
  2. <groupId>org.apache.shardingsphere</groupId>
  3. <artifactId>shardingsphere-jdbc-core</artifactId>
  4. <version>${shardingsphere.version}</version>
  5. </dependency>

配置 YAML

ShardingSphere-JDBC 的 YAML 配置文件通过 Schema 名称、运行模式、数据源集合、规则集合以及属性配置组成。

  1. # JDBC 中的数据源的别名。在集群模式,使用该参数联通 ShardingSphere-JDBC 与 ShardingSphere-Proxy 共同使用。
  2. # 默认值:logic_db
  3. schemaName (?):
  4. mode:
  5. dataSources:
  6. rules:
  7. - !FOO_XXX
  8. ...
  9. - !BAR_XXX
  10. ...
  11. props:
  12. key_1: value_1
  13. key_2: value_2

模式详情请参见模式配置

数据源详情请参见数据源配置

规则详情请参见规则配置

构建数据源

通过 YamlShardingSphereDataSourceFactory 工厂创建的 ShardingSphereDataSource 实现自 JDBC 的标准接口 DataSource。

  1. File yamlFile = // 指定 YAML 文件路径
  2. DataSource dataSource = YamlShardingSphereDataSourceFactory.createDataSource(yamlFile);

使用数据源

使用方式同 Java API。

语法说明

!! 表示实例化该类

! 表示自定义别名

- 表示可以包含一个或多个

[] 表示数组,可以与减号相互替换使用