ShardingSphere 分库分表实战

一. 简介 sharding-sphere

官网地址: https://shardingsphere.apache.org/

ShardingSphere 是一套开源的分布式数据库中间件解决方案组成的生态圈，它由 Sharding-JDBC、Sharding-Proxy 和 Sharding-Sidecar（计划中）这 3 款相互独立的产品组成。他们均提供标准化的数据分片、分布式事务和数据库治理功能，可适用于如 Java 同构、异构语言、容器、云原生等各种多样化的应用场景。
ShardingSphere 定位为关系型数据库中间件，旨在充分合理地在分布式的场景下利用关系型数据库的计算和存储能力，而并非实现一个全新的关系型数据库。它与 NoSQL 和 NewSQL 是并存而非互斥的关系。NoSQL 和 NewSQL 作为新技术探索的前沿，放眼未来，拥抱变化，是非常值得推荐的。反之，也可以用另一种思路看待问题，放眼未来，关注不变的东西，进而抓住事物本质。关系型数据库当今依然占有巨大市场，是各个公司核心业务的基石，未来也难于撼动，我们目前阶段更加关注在原有基础上的增量，而非颠覆。

sharding-jdbc 定位为轻量级 Java 框架，在 Java 的 JDBC 层提供的额外服务。它使用客户端直连数据库，以 jar 包形式提供服务，无需额外部署和依赖，可理解为增强版的 JDBC 驱动，完全兼容 JDBC 和各种 ORM 框架。
适用于任何基于 Java 的 ORM 框架，如：JPA, Hibernate, Mybatis, Spring JDBC Template 或直接使用 JDBC。基于任何第三方的数据库连接池，如：DBCP, C3P0, BoneCP, Druid, HikariCP 等。支持任意实现 JDBC 规范的数据库。目前支持 MySQL，Oracle，SQLServer 和 PostgreSQL。

三. 项目实战

本项目基于 Spring Boot 2.1.5 使用 sharding-sphere + Mybatis-Plus 实现分库分表

1. pom.xml 引入依赖

1.  ``

2.  ``

4.  `4.0.0`

5.  ``

6.  `org.springframework.boot`

7.  `spring-boot-starter-parent`

8.  `2.1.5.RELEASE`

9.  ``

10.  ``

11.  `com.xd`

12.  `spring-boot-sharding-table`

13.  `0.0.1-SNAPSHOT`

14.  `spring-boot-sharding-table`

15.  `基于 Spring Boot 2.1.5 使用sharding-sphere + Mybatis-Plus 实现分库分表`

17.  ``

18.  `1.8`

19.  ``

21.  ``

22.  ``

23.  `org.springframework.boot`

24.  `spring-boot-starter-web`

25.  ``

27.  ``

28.  `org.springframework.boot`

29.  `spring-boot-starter-test`

30.  `test`

31.  ``

32.  ``

33.  ``

34.  `mysql`

35.  `mysql-connector-java`

36.  `runtime`

37.  ``

38.  ``

39.  ``

40.  `com.baomidou`

41.  `mybatis-plus-boot-starter`

42.  `3.1.1`

43.  ``

44.  ``

45.  ``

46.  ``

47.  `io.shardingsphere`

48.  `sharding-jdbc-spring-boot-starter`

49.  `3.1.0`

50.  ``

51.  ``

52.  ``

53.  `io.shardingsphere`

54.  `sharding-jdbc-spring-namespace`

55.  `3.1.0`

56.  ``

57.  ``

58.  ``

59.  ``

60.  `org.projectlombok`

61.  `lombok`

62.  `1.18.8`

63.  ``

64.  ``

66.  ``

67.  ``

68.  ``

69.  `org.springframework.boot`

70.  `spring-boot-maven-plugin`

71.  ``

72.  ``

73.  ``

75.  ``

2. 创建数据库和表

1.  `ds0`

2.  `├── user_0` 

3.  `└── user_1` 

4.  `ds1`

5.  `├── user_0` 

6.  `└── user_1`

既然是分库分表库结构与表结构一定是一致的数据库: ds0

1.  `CREATE DATABASE IF NOT EXISTS `ds0` /*!40100 DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci */;`

2.  `USE `ds0`;`

4.  `SET NAMES utf8mb4;`

5.  `SET FOREIGN_KEY_CHECKS = 0;`

7.  `-- ----------------------------`

8.  `-- Table structure for user_0`

9.  `-- ----------------------------`

10.  `DROP TABLE IF EXISTS `user_0`;`

11.  `CREATE TABLE `user_0` (`

12.  ``id` int(11) NOT NULL,`

13.  ``name` varchar(255) DEFAULT NULL,`

14.  ``age` int(11) DEFAULT NULL,`

15.  `PRIMARY KEY (`id`)`

16.  `) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;`

18.  `-- ----------------------------`

19.  `-- Table structure for user_1`

20.  `-- ----------------------------`

21.  `DROP TABLE IF EXISTS `user_1`;`

22.  `CREATE TABLE `user_1` (`

23.  ``id` int(11) NOT NULL,`

24.  ``name` varchar(255) DEFAULT NULL,`

25.  ``age` int(11) DEFAULT NULL,`

26.  `PRIMARY KEY (`id`)`

27.  `) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;`

29.  `SET FOREIGN_KEY_CHECKS = 1;`

数据库: ds1

1.  `CREATE DATABASE IF NOT EXISTS `ds1` /*!40100 DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci */;`

2.  `USE `ds1`;`

4.  `SET NAMES utf8mb4;`

5.  `SET FOREIGN_KEY_CHECKS = 0;`

7.  `-- ----------------------------`

8.  `-- Table structure for user_0`

9.  `-- ----------------------------`

10.  `DROP TABLE IF EXISTS `user_0`;`

11.  `CREATE TABLE `user_0` (`

12.  ``id` int(11) NOT NULL,`

13.  ``name` varchar(255) DEFAULT NULL,`

14.  ``age` int(11) DEFAULT NULL,`

15.  `PRIMARY KEY (`id`)`

16.  `) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;`

18.  `-- ----------------------------`

19.  `-- Table structure for user_1`

20.  `-- ----------------------------`

21.  `DROP TABLE IF EXISTS `user_1`;`

22.  `CREATE TABLE `user_1` (`

23.  ``id` int(11) NOT NULL,`

24.  ``name` varchar(255) DEFAULT NULL,`

25.  ``age` int(11) DEFAULT NULL,`

26.  `PRIMARY KEY (`id`)`

27.  `) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;`

29.  `SET FOREIGN_KEY_CHECKS = 1;`

3. application.properties (重点)

1.  `# 数据源 ds0,ds1`

2.  `sharding.jdbc.datasource.names=ds0,ds1`

3.  `# 第一个数据库`

4.  `sharding.jdbc.datasource.ds0.type=com.zaxxer.hikari.HikariDataSource`

5.  `sharding.jdbc.datasource.ds0.driver-class-name=com.mysql.jdbc.Driver`

6.  `sharding.jdbc.datasource.ds0.jdbc-url=jdbc:mysql://localhost:3306/ds0?characterEncoding=utf-8`

7.  `sharding.jdbc.datasource.ds0.username=root`

8.  `sharding.jdbc.datasource.ds0.password=root`

10.  `# 第二个数据库`

11.  `sharding.jdbc.datasource.ds1.type=com.zaxxer.hikari.HikariDataSource`

12.  `sharding.jdbc.datasource.ds1.driver-class-name=com.mysql.jdbc.Driver`

13.  `sharding.jdbc.datasource.ds1.jdbc-url=jdbc:mysql://localhost:3306/ds1?characterEncoding=utf-8`

14.  `sharding.jdbc.datasource.ds1.username=root`

15.  `sharding.jdbc.datasource.ds1.password=root`

17.  `# 水平拆分的数据库（表） 配置分库 + 分表策略 行表达式分片策略`

18.  `# 分库策略`

19.  `sharding.jdbc.config.sharding.default-database-strategy.inline.sharding-column=id`

20.  `sharding.jdbc.config.sharding.default-database-strategy.inline.algorithm-expression=ds$->{id % 2}`

22.  `# 分表策略 其中user为逻辑表 分表主要取决于age行`

23.  `sharding.jdbc.config.sharding.tables.user.actual-data-nodes=ds$->{0..1}.user_$->{0..1}`

24.  `sharding.jdbc.config.sharding.tables.user.table-strategy.inline.sharding-column=age`

25.  `# 分片算法表达式`

26.  `sharding.jdbc.config.sharding.tables.user.table-strategy.inline.algorithm-expression=user_$->{age % 2}`

28.  `# 主键 UUID 18位数 如果是分布式还要进行一个设置 防止主键重复`

29.  `#sharding.jdbc.config.sharding.tables.user.key-generator-column-name=id`

31.  `# 打印执行的数据库以及语句`

32.  `sharding.jdbc.config.props..sql.show=true`

33.  `spring.main.allow-bean-definition-overriding=true`

我这次使用配置文件方式实现分库以及分表
以上配置说明:

逻辑表 user

水平拆分的数据库（表）的相同逻辑和数据结构表的总称。例：用户数据根据主键尾数拆分为 2 张表，分别是 user0 到 user1，他们的逻辑表名为 user。

真实表

在分片的数据库中真实存在的物理表。即上个示例中的 user0 到 user1

分片算法:

Hint 分片算法
对应 HintShardingAlgorithm，用于处理使用 Hint 行分片的场景。需要配合 HintShardingStrategy 使用。

分片策略:

行表达式分片策略对应 InlineShardingStrategy。使用 Groovy 的表达式，提供对 SQL 语句中的 = 和 IN 的分片操作支持，只支持单分片键。对于简单的分片算法，可以通过简单的配置使用，从而避免繁琐的 Java 代码开发，如: user$->{id % 2} 表示 user 表根据 id 模 2，而分成 2 张表，表名称为 user0 到 user_1。

自增主键生成策略

通过在客户端生成自增主键替换以数据库原生自增主键的方式，做到分布式主键无重复。采用 UUID.randomUUID() 的方式产生分布式主键。或者 SNOWFLAKE

4. 实体类

1.  `package com.xd.springbootshardingtable.entity;`

3.  `import com.baomidou.mybatisplus.annotation.TableName;`

4.  `import com.baomidou.mybatisplus.extension.activerecord.Model;`

5.  `import groovy.transform.EqualsAndHashCode;`

6.  `import lombok.Data;`

7.  `import lombok.experimental.Accessors;`

9.  `/**`

10.  `* @Classname User`

11.  `* @Description 用户实体类`

12.  `* @Author 李号东 [email protected]`

13.  `* @Date 2019-05-26 17:24`

14.  `* @Version 1.0`

15.  `*/`

16.  `@Data`

17.  `@EqualsAndHashCode(callSuper = true)`

18.  `@Accessors(chain = true)`

19.  `@TableName("user")`

20.  `public class User extends Model {`

22.  `/**`

23.  `* 主键Id`

24.  `*/`

25.  `private int id;`

27.  `/**`

28.  `* 名称`

29.  `*/`

30.  `private String name;`

32.  `/**`

33.  `* 年龄`

34.  `*/`

35.  `private int age;`

36.  `}`

5. dao 层

1.  `package com.xd.springbootshardingtable.mapper;`

3.  `import com.baomidou.mybatisplus.core.mapper.BaseMapper;`

4.  `import com.xd.springbootshardingtable.entity.User;`

6.  `/**`

7.  `* user dao层`

8.  `* @author lihaodong`

9.  `*/`

10.  `public interface UserMapper extends BaseMapper {`

12.  `}`

6. service 层以及实现类

UserService

1.  `package com.xd.springbootshardingtable.service;`

3.  `import com.baomidou.mybatisplus.extension.service.IService;`

4.  `import com.xd.springbootshardingtable.entity.User;`

6.  `import java.util.List;`

8.  `/**`

9.  `* @Classname UserService`

10.  `* @Description 用户服务类`

11.  `* @Author 李号东 [email protected]`

12.  `* @Date 2019-05-26 17:31`

13.  `* @Version 1.0`

14.  `*/`

15.  `public interface UserService extends IService {`

17.  `/**`

18.  `* 保存用户信息`

19.  `* @param entity`

20.  `* @return`

21.  `*/`

22.  `@Override`

23.  `boolean save(User entity);`

25.  `/**`

26.  `* 查询全部用户信息`

27.  `* @return`

28.  `*/`

29.  `List getUserList();`

30.  `}`

UserServiceImpl


1.  `package com.xd.springbootshardingtable.service.Impl;`

3.  `import com.baomidou.mybatisplus.core.toolkit.Wrappers;`

4.  `import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;`

5.  `import com.xd.springbootshardingtable.entity.User;`

6.  `import com.xd.springbootshardingtable.mapper.UserMapper;`

7.  `import com.xd.springbootshardingtable.service.UserService;`

8.  `import org.springframework.stereotype.Service;`

10.  `import java.util.List;`

12.  `/**`

13.  `* @Classname UserServiceImpl`

14.  `* @Description 用户服务实现类`

15.  `* @Author 李号东 [email protected]`

16.  `* @Date 2019-05-26 17:32`

17.  `* @Version 1.0`

18.  `*/`

19.  `@Service`

20.  `public class UserServiceImpl extends ServiceImpl implements UserService {`

21.  `@Override`

22.  `public boolean save(User entity) {`

23.  `return super.save(entity);`

24.  `}`

26.  `@Override`

27.  `public List getUserList() {`

28.  `return baseMapper.selectList(Wrappers.lambdaQuery());`

29.  `}`

31.  `}`

7. 测试控制类



1.  `package com.xd.springbootshardingtable.controller;`

3.  `import com.xd.springbootshardingtable.entity.User;`

4.  `import com.xd.springbootshardingtable.service.UserService;`

5.  `import org.springframework.beans.factory.annotation.Autowired;`

6.  `import org.springframework.web.bind.annotation.GetMapping;`

7.  `import org.springframework.web.bind.annotation.RestController;`

9.  `import java.util.List;`

11.  `/**`

12.  `* @Classname UserController`

13.  `* @Description 用户测试控制类`

14.  `* @Author 李号东 [email protected]`

15.  `* @Date 2019-05-26 17:36`

16.  `* @Version 1.0`

17.  `*/`

18.  `@RestController`

19.  `public class UserController {`

21.  `@Autowired`

22.  `private UserService userService;`

24.  `@GetMapping("/select")`

25.  `public List select() {`

26.  `return userService.getUserList();`

27.  `}`

29.  `@GetMapping("/insert")`

30.  `public Boolean insert(User user) {`

31.  `return userService.save(user);`

32.  `}`

34.  `}`

四. 测试

启动项目
打开浏览器分别访问:

http://localhost:8080/insert?id=1&name=lhd&age=12
http://localhost:8080/insert?id=2&name=lhd&age=13
http://localhost:8080/insert?id=3&name=lhd&age=14
http://localhost:8080/insert?id=4&name=lhd&age=15

则执行插数据然后查看控制台日志:

根据分片算法和分片策略不同的 id 以及 age 取模落入不同的库表达到了分库分表的结果

有的人说查询的话该怎么做呢其实也帮我们做好了打开浏览器访问:
http://localhost:8080/select

控制台打印:

分别从 ds0 数据库两张表和 ds1 两张表查询结果然后汇总结果返回

之前有人问我单表数据量达千万, 想做水平分割, 不分库, 也可以的吧?
是完全可以的只要修改配置文件的配置即可非常灵活

通过代码大家也可以看到, 我的业务层代码和平时单表操作是一样的, 只需要引入 sh 配置和逻辑表保持现有的不便即可, 使用无侵入我们的代码可以在原有的基础上改动即可可以说是非常方便

以上为转载博客