From 36f5fc47ad27c1b94a860d181385c735637c11c1 Mon Sep 17 00:00:00 2001
From: "Yangkai.Shen" <237497819@qq.com>
Date: Tue, 26 Mar 2019 16:53:11 +0800
Subject: [PATCH] =?UTF-8?q?:sparkles:=20spring-boot-demo-sharding-jdbc=20?=
=?UTF-8?q?=E5=AE=8C=E6=88=90?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
spring-boot-demo-sharding-jdbc/README.md | 251 +++++++++++++++++++++
.../jdbc/config/DataSourceShardingConfig.java | 12 +-
...SpringBootDemoShardingJdbcApplicationTests.java | 1 -
3 files changed, 261 insertions(+), 3 deletions(-)
create mode 100644 spring-boot-demo-sharding-jdbc/README.md
diff --git a/spring-boot-demo-sharding-jdbc/README.md b/spring-boot-demo-sharding-jdbc/README.md
new file mode 100644
index 0000000..01d7135
--- /dev/null
+++ b/spring-boot-demo-sharding-jdbc/README.md
@@ -0,0 +1,251 @@
+# spring-boot-demo-sharding-jdbc
+
+> 本 demo 主要演示了如何集成 `sharding-jdbc` 实现分库分表操作，ORM 层使用了`Mybatis-Plus`简化开发，童鞋们可以按照自己的喜好替换为 JPA、通用Mapper、JdbcTemplate甚至原生的JDBC都可以。
+>
+> PS：
+>
+> 1. 目前当当官方提供的starter存在bug，版本号：`3.1.0`，因此本demo采用手动配置。
+> 2. 文档真的很垃圾 :joy:
+
+## 1. 运行方式
+
+1. 在数据库创建2个数据库，分别为：`spring-boot-demo`、`spring-boot-demo-2`
+2. 去数据库执行 `sql/schema.sql` ，创建 `6` 张分片表
+3. 找到 `DataSourceShardingConfig` 配置类，修改 `数据源` 的相关配置，位于 `dataSourceMap()` 这个方法
+4. 找到测试类 `SpringBootDemoShardingJdbcApplicationTests` 进行测试
+
+## 2. 关键代码
+
+### 2.1. `pom.xml`
+
+```xml
+
+
+ 4.0.0
+
+ spring-boot-demo-sharding-jdbc
+ 1.0.0-SNAPSHOT
+ jar
+
+ spring-boot-demo-sharding-jdbc
+ Demo project for Spring Boot
+
+
+ com.xkcoding
+ spring-boot-demo
+ 1.0.0-SNAPSHOT
+
+
+
+ UTF-8
+ UTF-8
+ 1.8
+
+
+
+
+ org.springframework.boot
+ spring-boot-starter
+
+
+
+ org.springframework.boot
+ spring-boot-starter-test
+ test
+
+
+
+ com.baomidou
+ mybatis-plus-boot-starter
+ 3.1.0
+
+
+
+ mysql
+ mysql-connector-java
+
+
+
+ io.shardingsphere
+ sharding-jdbc-core
+ 3.1.0
+
+
+
+ cn.hutool
+ hutool-all
+
+
+
+ org.projectlombok
+ lombok
+ true
+
+
+
+
+ spring-boot-demo-sharding-jdbc
+
+
+ org.springframework.boot
+ spring-boot-maven-plugin
+
+
+
+
+
+```
+
+### 2.2. `DataSourceShardingConfig.java`
+
+```java
+/**
+ *
+ * sharding-jdbc 的数据源配置
+ *
+ *
+ * @package: com.xkcoding.sharding.jdbc.config
+ * @description: sharding-jdbc 的数据源配置
+ * @author: yangkai.shen
+ * @date: Created in 2019-03-26 16:47
+ * @copyright: Copyright (c) 2019
+ * @version: V1.0
+ * @modified: yangkai.shen
+ */
+@Configuration
+public class DataSourceShardingConfig {
+ /**
+ * 需要手动配置事务管理器
+ */
+ @Bean
+ public DataSourceTransactionManager transactionManager(@Qualifier("dataSource") DataSource dataSource) {
+ return new DataSourceTransactionManager(dataSource);
+ }
+
+ @Bean(name = "dataSource")
+ @Primary
+ public DataSource dataSource() throws SQLException {
+ ShardingRuleConfiguration shardingRuleConfig = new ShardingRuleConfiguration();
+ // 设置分库策略
+ shardingRuleConfig.setDefaultDatabaseShardingStrategyConfig(new InlineShardingStrategyConfiguration("user_id", "ds${user_id % 2}"));
+ // 设置规则适配的表
+ shardingRuleConfig.getBindingTableGroups().add("t_order");
+ // 设置分表策略
+ shardingRuleConfig.getTableRuleConfigs().add(orderTableRule());
+ shardingRuleConfig.setDefaultDataSourceName("ds0");
+ shardingRuleConfig.setDefaultTableShardingStrategyConfig(new NoneShardingStrategyConfiguration());
+
+ Properties properties = new Properties();
+ properties.setProperty("sql.show", "true");
+
+ return ShardingDataSourceFactory.createDataSource(dataSourceMap(), shardingRuleConfig, new ConcurrentHashMap<>(16), properties);
+ }
+
+ private TableRuleConfiguration orderTableRule() {
+ TableRuleConfiguration tableRule = new TableRuleConfiguration();
+ // 设置逻辑表名
+ tableRule.setLogicTable("t_order");
+ // ds${0..1}.t_order_${0..2} 也可以写成 ds$->{0..1}.t_order_$->{0..1}
+ tableRule.setActualDataNodes("ds${0..1}.t_order_${0..2}");
+ tableRule.setTableShardingStrategyConfig(new InlineShardingStrategyConfiguration("order_id", "t_order_$->{order_id % 3}"));
+ tableRule.setKeyGenerator(new DefaultKeyGenerator());
+ tableRule.setKeyGeneratorColumnName("order_id");
+ return tableRule;
+ }
+
+ private Map dataSourceMap() {
+ Map dataSourceMap = new HashMap<>(16);
+
+ // 配置第一个数据源
+ HikariDataSource ds0 = new HikariDataSource();
+ ds0.setDriverClassName("com.mysql.cj.jdbc.Driver");
+ ds0.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/spring-boot-demo?useUnicode=true&characterEncoding=UTF-8&useSSL=false&autoReconnect=true&failOverReadOnly=false&serverTimezone=GMT%2B8");
+ ds0.setUsername("root");
+ ds0.setPassword("root");
+
+ // 配置第二个数据源
+ HikariDataSource ds1 = new HikariDataSource();
+ ds1.setDriverClassName("com.mysql.cj.jdbc.Driver");
+ ds1.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/spring-boot-demo-2?useUnicode=true&characterEncoding=UTF-8&useSSL=false&autoReconnect=true&failOverReadOnly=false&serverTimezone=GMT%2B8");
+ ds1.setUsername("root");
+ ds1.setPassword("root");
+
+ dataSourceMap.put("ds0", ds0);
+ dataSourceMap.put("ds1", ds1);
+ return dataSourceMap;
+ }
+
+}
+```
+
+### 2.3. `SpringBootDemoShardingJdbcApplicationTests.java`
+
+```java
+/**
+ *
+ * 测试sharding-jdbc分库分表
+ *
+ *
+ * @package: com.xkcoding.sharding.jdbc
+ * @description: 测试sharding-jdbc分库分表
+ * @author: yangkai.shen
+ * @date: Created in 2019-03-26 13:44
+ * @copyright: Copyright (c) 2019
+ * @version: V1.0
+ * @modified: yangkai.shen
+ */
+@Slf4j
+@RunWith(SpringRunner.class)
+@SpringBootTest
+public class SpringBootDemoShardingJdbcApplicationTests {
+ @Autowired
+ private OrderMapper orderMapper;
+
+ /**
+ * 测试新增
+ */
+ @Test
+ public void testInsert() {
+ for (long i = 1; i < 10; i++) {
+ for (long j = 1; j < 20; j++) {
+ Order order = Order.builder().userId(i).orderId(j).remark(RandomUtil.randomString(20)).build();
+ orderMapper.insert(order);
+ }
+ }
+ }
+
+ /**
+ * 测试更新
+ */
+ @Test
+ public void testUpdate() {
+ Order update = new Order();
+ update.setRemark("修改备注信息");
+ orderMapper.update(update, Wrappers.update().lambda().eq(Order::getOrderId, 2).eq(Order::getUserId, 2));
+ }
+
+ /**
+ * 测试删除
+ */
+ @Test
+ public void testDelete() {
+ orderMapper.delete(new QueryWrapper<>());
+ }
+
+ /**
+ * 测试查询
+ */
+ @Test
+ public void testSelect() {
+ List orders = orderMapper.selectList(Wrappers.query().lambda().in(Order::getOrderId, 1, 2));
+ log.info("【orders】= {}", JSONUtil.toJsonStr(orders));
+ }
+
+}
+```
+
+## 3. 参考
+
+1. `ShardingSphere` 官网：https://shardingsphere.apache.org/index_zh.html (虽然文档确实垃圾，但是还是得参考啊~)
+2. `Mybatis-Plus` 语法参考官网：https://mybatis.plus/
\ No newline at end of file
diff --git a/spring-boot-demo-sharding-jdbc/src/main/java/com/xkcoding/sharding/jdbc/config/DataSourceShardingConfig.java b/spring-boot-demo-sharding-jdbc/src/main/java/com/xkcoding/sharding/jdbc/config/DataSourceShardingConfig.java
index 8f48680..bacc521 100644
--- a/spring-boot-demo-sharding-jdbc/src/main/java/com/xkcoding/sharding/jdbc/config/DataSourceShardingConfig.java
+++ b/spring-boot-demo-sharding-jdbc/src/main/java/com/xkcoding/sharding/jdbc/config/DataSourceShardingConfig.java
@@ -21,9 +21,17 @@ import java.util.Properties;
import java.util.concurrent.ConcurrentHashMap;
/**
- * datetime 2018/11/28 10:46
+ *
+ * sharding-jdbc 的数据源配置
+ *
*
- * @author sin5
+ * @package: com.xkcoding.sharding.jdbc.config
+ * @description: sharding-jdbc 的数据源配置
+ * @author: yangkai.shen
+ * @date: Created in 2019-03-26 16:47
+ * @copyright: Copyright (c) 2019
+ * @version: V1.0
+ * @modified: yangkai.shen
*/
@Configuration
public class DataSourceShardingConfig {
diff --git a/spring-boot-demo-sharding-jdbc/src/test/java/com/xkcoding/sharding/jdbc/SpringBootDemoShardingJdbcApplicationTests.java b/spring-boot-demo-sharding-jdbc/src/test/java/com/xkcoding/sharding/jdbc/SpringBootDemoShardingJdbcApplicationTests.java
index e9bbcfa..a74c199 100644
--- a/spring-boot-demo-sharding-jdbc/src/test/java/com/xkcoding/sharding/jdbc/SpringBootDemoShardingJdbcApplicationTests.java
+++ b/spring-boot-demo-sharding-jdbc/src/test/java/com/xkcoding/sharding/jdbc/SpringBootDemoShardingJdbcApplicationTests.java
@@ -75,6 +75,5 @@ public class SpringBootDemoShardingJdbcApplicationTests {
log.info("【orders】= {}", JSONUtil.toJsonStr(orders));
}
-
}