### 一、背景

ShardingSphereDataSourceFactory 是 Apache ShardingSphere-JDBC 端的最基礎使用者 API，它用於將使用者的規則配置物件進行轉化，並生成為標準 DataSource 的實現。除此之外，它還提供了用於 YAML 配置的 YamlShardingSphereDataSourceFactory，以及用於 Spring 的自定義名稱空間和 Spring Boot Starter。

DataSource 是標準的 Java JDBC 介面，工程師可以透過它進一步建立符合 JDBC 標準的 Connection、Statement、PreparedStatement、ResultSet 等耳熟能詳的標準物件。**完全符合 JDBC 介面的實現，讓工程師使用 Apache ShardingSphere-JDBC 與使用原生的 JDBC 沒有區別，也可以透明化的對接各種 ORM 框架**。

### 二、痛點

雖然標準的 JDBC 介面，可以在開發過程中完全適配，但透過 ShardingSphere API 建立 DataSource，卻改變了工程師的原有的資料庫驅動載入方式。雖然只需要修改少量（一行）的啟動程式碼，但是對於希望平滑遷移至 ShardingSphere 的系統來說，切實地增加了額外的開發成本；且對於無法掌握原始碼的系統（如：外採系統）來說，使用 ShardingSphere 則困難重重。

一直以來，ShardingSphere 都缺乏 JDBC 驅動的實現，這主要受限於它的設計初衷。透過 Java 配置的 ShardingSphere-JDBC 可以將靈活度提升到可程式設計級別，但 JDBC 的 Driver 介面則並未提供太多可額外配置的空間，僅透過 URL 和 Properties，會大幅限制 ShardingSphere 的配置靈活度。YAML 配置雖然可以和 Driver 的 URL 更好的適配，且可讀性更強，但屬於靜態配置的範疇，與動態配置的靈活度相比，則明顯不足。因此，ShardingSphere-JDBC 採用資料庫連線池的相似策略，繞過了 JDBC 標準介面的限制，直接將 DataSource 暴露給使用者。

**然而，改動一行程式碼和一行程式碼都不改動是不可逾越的天塹，這也成為了 ShardingSphere-JDBC 易用性的最大痛點**。

### 三、契機

隨著 ShardingSphere 的另一款產品 —— ShardingSphere-Proxy 的逐漸成熟，它的兩個重要的生態類功能——混合部署和 DistSQL 應運而生。

ShardingSphere-JDBC 的輕量級和高效能的特性，使其更加適合於面向應用執行時的 CRUD 操作；ShardingSphere-Proxy 的易用性和相容性，則使其更加適合於面向資料庫管控的 DDL 操作。兩個產品共同使用，互相取長補短，成為了更加完善的新一代架構方案。

兼具程式設計和 SQL 展現力的 DistSQL，在靈活性和易用性之間取得了完美的平衡。因此，在 ShardingSphere-JDBC 的配置屬性大幅降低的架構模型中，使用 JDBC 的 URL 連線治理中心，並採用 DistSQL 進行配置操作，是最佳的解決方案。DistSQL 的安全性，是 Java 和 YAML 的配置方式所不具備的，它天然支援許可權控制和 SQL 審計等高階能力，讓 DBA 運維資料庫叢集更加得心應手。

### 四、實現

在前提條件一一達成之後，ShardingSphere-JDBC 5.1.2 版本順勢而為，提供了 JDBC 驅動。**它可以僅透過配置變更即可使用，工程師再也無需修改程式碼**。

**驅動類名稱**

`org.apache.shardingsphere.driver.ShardingSphereDriver`

**URL 配置說明**

* 以 `jdbc:shardingsphere`: 為字首

* 配置檔案：`xxx.yaml`，配置檔案格式與 YAML 配置一致

* 配置檔案載入規則：

* 無字首表示從絕對路徑載入配置檔案

* classpath: 字首表示從類路徑中載入配置檔案

### 五、使用步驟

**使用原生驅動**

```
Class.forName("org.apache.shardingsphere.driver.ShardingSphereDriver");
String jdbcUrl = "jdbc:shardingsphere:classpath:config.yaml";

String sql = "SELECT i.* FROM t_order o JOIN t_order_item i ON o.order_id=i.order_id WHERE o.user_id=? AND o.order_id=?";
try (
        Connection conn = DriverManager.getConnection(jdbcUrl);
        PreparedStatement ps = conn.prepareStatement(sql)) {
    ps.setInt(1, 10);
    ps.setInt(2, 1000);
    try (ResultSet rs = preparedStatement.executeQuery()) {
        while(rs.next()) {
            // ...        }
    }
}
```

**使用資料庫連線池**

```
String driverClassName = "org.apache.shardingsphere.driver.ShardingSphereDriver";
String jdbcUrl = "jdbc:shardingsphere:classpath:config.yaml";// 以 HikariCP 為例 HikariDataSource dataSource = new HikariDataSource();
dataSource.setDriverClassName(driverClassName);
dataSource.setJdbcUrl(jdbcUrl);

String sql = "SELECT i.* FROM t_order o JOIN t_order_item i ON o.order_id=i.order_id WHERE o.user_id=? AND o.order_id=?";
try (
        Connection conn = dataSource.getConnection();
        PreparedStatement ps = conn.prepareStatement(sql)) {
    ps.setInt(1, 10);
    ps.setInt(2, 1000);
    try (ResultSet rs = preparedStatement.executeQuery()) {
        while(rs.next()) {
            // ...        }
    }
}
```

**參考資訊**

* JDBC 驅動

[https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/jdbc-driver/](https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-jdbc/jdbc-driver/)

### 六、結語

ShardingSphere-JDBC 驅動的出現，使 ShardingSphere 的易用性獲得了前所未有的加強。在未來規劃中，JDBC 驅動可以進一步簡化，直接在 URL 中提供治理中心地址即可。Apache ShardingSphere 已大踏步向多元化的分散式叢集邁進。新時代已經到來，快來體驗一下 ShardingSphere 的新版本的強大功能吧！

以上就是本次分享的全部內容，如果有對 Apache ShardingSphere 有任何疑問或建議，歡迎在 GitHub issue 列表提出，或可前往中文社群交流討論。

GitHub issue：

[https://github.com/apache/shardingsphere/issues](https://github.com/apache/shardingsphere/issues)

貢獻指南：

[https://shardingsphere.apache.org/community/cn/contribute/](https://shardingsphere.apache.org/community/cn/contribute/)

中文社群：

[https://community.sphere-ex.com/](https://community.sphere-ex.com/)

Apache ShardingSphere 官網：

[https://shardingsphere.apache.org/](https://shardingsphere.apache.org/)

SphereEx 官網：

[https://www.sphere-ex.com](https://www.sphere-ex.com)

**作者**

張亮，SphereEx CEO，Apache ShardingSphere PMC Chair。主要負責 ShardingSphere 架構演進和技術難點攻克。

終於可以一行程式碼也不用改了！ShardingSphere 原生驅動問世

相關文章