什麼是行表達式?
行表達式是 ShardingSphere 中用於實現簡化和統一配置信息的一種工具,在日常開發過程中應用得非常廣泛。 它的使用方式非常直觀,只需要在配置中使用 ${expression} 或 $->{expression} 表達式即可。
基於行表達式語法,${begin..end} 表示的是一個從"begin"到"end"的範圍區間,而多個 ${expression} 之間可以用"."符號進行連接,代表多個表達式數值之間的一種笛卡爾積關係。
類似場景也可以使用枚舉的方式來列舉所有可能值。行表達式也提供了 ${[enum1, enum2,…, enumx]} 語法來表示枚舉值,所以"ds${0..1}.user${0..1}"的效果等同於"ds${[0,1]}.user${[0,1]}"。
由於 ${expression} 與 Spring 本身的屬性文件佔位符衝突,而 Spring 又是目前主流的開發框架,因此在正式環境中建議你使用 $->{expression} 來進行配置。
ShardingSphere有哪些核心配置?
對於分庫分表、讀寫分離操作而言,配置的主要任務是完成各種規則的創建和初始化。配置是整個ShardingSphere的核心,也是我們日常開發過程中的抓藥工作。可以說,只要我們掌握了ShardingSphere的核心配置項,就相當於掌握了這個框架的使用方法。那麼,ShardingSphere 有哪些核心配置呢?這裏以分片引擎爲例介紹最常用的幾個配置項,而與讀寫分離、數據脫敏、編排治理相關的配置項我們會在介紹具體的應用場景時再做展開。
ShardingRuleConfiguration
DataSource是我們使用ShardingSphere的入口,創建DataSource的過程中使用到了一個ShardingDataSourceFactory類,這個工廠類的構造函數中需要傳入一個ShardingRuleConfiguration對象。顯然,從命名上看,這個ShardingRuleConfiguration就是用於分片規則的配置入口。
ShardingRuleConfiguration中所需要配置的規則比較多,下面通過一張圖例來進行簡單說明
事實上,對於ShardingRuleConfiguration而言,必須要設置的只有一個配置項,即TableRuleConfiguration。
TableRuleConfiguration
從命名上看,TableRuleConfiguration是表分片規則配置,但事實上,這個類同時包含了對分庫和分表兩種場景的設置,TableRuleConfiguration包含很多重要的配置項:
- actualDataNodes:代表真實的數據節點,由數據源名+表名組成,支持行表達式。例如:ds${0..1}.user${0..1}
- databaseShardingStrategyConfig:代表分表策略,如果不設置也會使用默認分表策略,這裏的默認分表策略同樣來自ShardingRuleConfiguration中的defaultTableShardingStrategyConfig配置
- keyGeneratorConfig:代表分佈式環境下的自增列生成器配置,ShardingSphere中集成了雪花算法等分佈式ID的生成器實現。
ShardingStrategyConfiguration
dataBaseShardingStrategyConfig和tableShardingStrategyConfig的類型都是一個ShardingStrategyConfiguration對象。在ShardingSphere中,ShardingStrategyConfiguration實際上是一個空接口,存在一系列的實現類,其中的每個實現類都代表一種分片策略:
在這些具體的分片策略中,通常需要指定一個分片列 shardingColumn 以及一個或多個分片算法 ShardingAlgorithm。
KeyGeneratorConfiguration
可以想象,對於一個自增列而言,KeyGeneratorConfiguration 中首先需要指定一個列名 column。同時,因爲 ShardingSphere 中內置了一批自增列的實現機制(例如雪花算法 SNOWFLAKE 以及通用唯一識別碼 UUID),所以需要通過一個 type 配置項進行指定
ShardingSphere提供了哪些配置方式?
ShardingSphere提供了4種配置方式。用於不同的使用場景:
- Java代碼配置
- Yaml配置
- Spring命名空間配置
- Spring Boot配置
[詳細配置看官網](https://shardingsphere.apache.org/document/legacy/4.x/document/cn/manual/sharding-jdbc/configuration/ "詳細配置看官網")
ShardingSphere的配置體系是如何實現的?
ShardingRuleConfiguration配置體系
對於ShardingSphere而言,配置體系的作用本質上就是用來初始化DataSource等JDBC對象。例如,ShardingDataSourceFactory就是基於傳入的數據源Map、ShardingRuleConfiguration以及Properties來創建一個ShardingDataSource對象:
public final class ShardingDataSourceFactory {
public static DataSource createDataSource(
final Map<String, DataSource> dataSourceMap, final ShardingRuleConfiguration shardingRuleConfig, final Properties props) throws SQLException {
return new ShardingDataSource(dataSourceMap, new ShardingRule(shardingRuleConfig, dataSourceMap.keySet()), props);
}
}
在 ShardingSphere 中,所有規則配置類都實現了一個頂層接口 RuleConfiguration。RuleConfiguration 是一個空接口,ShardingRuleConfiguration 就是這個接口的實現類之一,專門用來處理分片引擎的應用場景。下面這段代碼就是 ShardingRuleConfiguration 類的實現過程:
public final class ShardingRuleConfiguration implements RuleConfiguration {
//表分片規則列表
private Collection<TableRuleConfiguration> tableRuleConfigs = new LinkedList<>();
//綁定表規則列表
private Collection<String> bindingTableGroups = new LinkedList<>();
//廣播表規則列表
private Collection<String> broadcastTables = new LinkedList<>();
//默認數據源
private String defaultDataSourceName;
//默認分庫策略
private ShardingStrategyConfiguration defaultDatabaseShardingStrategyConfig;
//默認分表策略
private ShardingStrategyConfiguration defaultTableShardingStrategyConfig;
//默認自增列值生成器
private KeyGeneratorConfiguration defaultKeyGeneratorConfig;
//讀寫分離規則
private Collection<MasterSlaveRuleConfiguration> masterSlaveRuleConfigs = new LinkedList<>();
//數據脫敏規則
private EncryptRuleConfiguration encryptRuleConfig;
}
可以看到,ShardingRuleConfiguration 中包含的就是一系列的配置類定義,通過前面的內容介紹,我們已經明白了這些配置類的作用和使用方法。其中,核心的 TableRuleConfiguration 定義也比較簡單,主要包含了邏輯表、真實數據節點以及分庫策略和分表策略的定義:
public final class TableRuleConfiguration {
//邏輯表
private final String logicTable;
//真實數據節點
private final String actualDataNodes;
//分庫策略
private ShardingStrategyConfiguration databaseShardingStrategyConfig;
//分表策略
private ShardingStrategyConfiguration tableShardingStrategyConfig;
//自增列生成器
private KeyGeneratorConfiguration keyGeneratorConfig;
public TableRuleConfiguration(final String logicTable) {
this(logicTable, null);
}
public TableRuleConfiguration(final String logicTable, final String actualDataNodes) {
Preconditions.checkArgument(!Strings.isNullOrEmpty(logicTable), "LogicTable is required.");
this.logicTable = logicTable;
this.actualDataNodes = actualDataNodes;
}
}
無論採用哪種配置方式,所有的配置項都是在這些核心配置類的基礎之上進行封裝和轉換。最終生成ShardingRuleConfiguration,然後通過ShardingDataSourceFatory生成ShardingDataSource獲取連接。