Apache ShardingSphere 属性配置详解

Apache ShardingSphere 属性配置详解

shardingsphere Distributed SQL transaction & query engine for data sharding, scaling, encryption, and more - on any database. 项目地址: https://gitcode.com/gh_mirrors/sh/shardingsphere

什么是属性配置

在分布式数据库中间件 Apache ShardingSphere 中，属性配置（Props）是一组用于控制系统行为的全局参数。这些参数不直接涉及具体的分片规则或数据源配置，而是影响整个 ShardingSphere 运行时的表现和特性。

属性配置的核心作用

属性配置主要控制以下几个方面：

1. SQL日志输出：控制SQL语句及其执行细节的日志记录
2. 执行引擎行为：调节查询执行时的线程池和连接管理
3. 元数据校验：管理表结构元数据的校验机制

详细参数解析

SQL日志相关配置

sql-show

• 类型：布尔值

• 默认值：false

• 作用：是否在日志中输出SQL执行详情

• 详细说明： 当设置为true时，ShardingSphere会在日志中记录完整的SQL执行信息，包括：

  • 逻辑SQL（应用程序发送的原始SQL）
  • 实际SQL（路由后真正执行到各数据库节点的SQL）
  • SQL解析结果（SQL的抽象语法树分析结果）

  这些日志使用专门的日志主题"ShardingSphere-SQL"，日志级别为INFO，非常适合开发调试阶段使用。

sql-simple

• 类型：布尔值
• 默认值：false
• 作用：控制SQL日志的输出格式
• 详细说明： 当与sql-show配合使用时，此参数决定日志的显示风格：
  • false（默认）：输出详细格式，包含完整上下文信息
  • true：输出简化格式，只显示核心SQL内容

执行引擎配置

kernel-executor-size

• 类型：整数
• 默认值：无限制（infinite）
• 作用：设置任务处理线程池大小
• 重要说明：
  • 每个ShardingSphereDataSource实例都拥有自己独立的线程池
  • 同一JVM内的不同数据源实例不会共享线程池资源
  • 合理设置此值可以平衡系统资源使用和并发性能

max-connections-size-per-query

• 类型：整数
• 默认值：1
• 作用：控制每次查询在每个数据库实例上能使用的最大连接数
• 应用场景： 对于需要同时从多个分片获取数据的查询，适当增加此值可以：
  • 提高并行度
  • 加速数据获取 但设置过高可能导致：
  • 数据库连接池压力增大
  • 系统资源消耗增加

元数据校验配置

check-table-metadata-enabled

• 类型：布尔值
• 默认值：false
• 作用：是否在启动和更新时检查分片元数据的结构一致性
• 详细说明： 当设置为true时，ShardingSphere会在以下时机检查元数据：
  1. 应用启动时
  2. 分片规则更新时 检查内容包括：
  • 表结构定义
  • 字段类型
  • 约束条件等 确保各分片的表结构保持一致

配置方式示例

属性配置采用YAML格式，通常与数据源配置、分片规则配置等一起放置在配置文件中。基本结构如下：

props:
    sql-show: true
    sql-simple: false
    kernel-executor-size: 20
    max-connections-size-per-query: 5
    check-table-metadata-enabled: true

最佳实践建议

1. 开发环境：建议开启sql-show以方便调试，生产环境则应关闭
2. 线程池大小：根据服务器CPU核心数和并发量合理设置kernel-executor-size
3. 连接数控制：max-connections-size-per-query应根据数据库性能和查询复杂度调整
4. 元数据校验：在表结构可能频繁变更的环境中建议开启check-table-metadata-enabled

通过合理配置这些属性，可以优化ShardingSphere的性能表现，同时获得必要的运行日志用于系统监控和问题排查。

shardingsphere Distributed SQL transaction & query engine for data sharding, scaling, encryption, and more - on any database. 项目地址: https://gitcode.com/gh_mirrors/sh/shardingsphere