Springboot 整合 Sharding-JDBC快速入門

在這裏插入圖片描述

Sharding-JDBC介紹

Sharding-JDBC是噹噹網研發的開源分佈式數據庫中間件,從 3.0 開始Sharding-JDBC被包含在 Sharding-Sphere 中,之後該項目進入進入Apache孵化器,4.0版本之後的版本爲Apache版本。

ShardingSphere是一套開源的分佈式數據庫中間件解決方案組成的生態圈,它由Sharding-JDBC、Sharding- Proxy和Sharding-Sidecar(計劃中)這3款相互獨立的產品組成。 他們均提供標準化的數據分片、分佈式事務和 數據庫治理功能,可適用於如Java同構、異構語言、容器、雲原生等各種多樣化的應用場景。

咱們目前只需關注Sharding-JDBC,它定位爲輕量級Java框架,在Java的JDBC層提供的額外服務。 它使用客戶端 直連數據庫,以jar包形式提供服務,無需額外部署和依賴,可理解爲增強版的JDBC驅動,完全兼容JDBC和各種 ORM框架。

Sharding-JDBC的核心功能爲數據分片和讀寫分離,通過Sharding-JDBC,應用可以透明的使用jdbc訪問已經分庫 分表、讀寫分離的多個數據源,而不用關心數據源的數量以及數據如何分佈。

  • 適用於任何基於Java的ORM框架,如: Hibernate, Mybatis, Spring JDBC Template或直接使用JDBC。
  • 基於任何第三方的數據庫連接池,如:DBCP, C3P0, BoneCP, Druid, HikariCP等。
  • 支持任意實現JDBC規範的數據庫。目前支持MySQL,Oracle,SQLServer和PostgreSQL。

在這裏插入圖片描述

實戰

需求說明

使用Sharding-JDBC完成對訂單表的水平分表,通過快速入門程序的開發,快速體驗Sharding-JDBC的使用 方法。 人工創建兩張表,t_order_1和t_order_2,這兩張表是訂單表拆分後的表,通過Sharding-Jdbc向訂單表插入數據, 按照一定的分片規則,主鍵爲偶數的進入t_order_1,另一部分數據進入t_order_2,通過Sharding-Jdbc 查詢數 據,根據 SQL語句的內容從t_order_1或t_order_2查詢數據。

環境搭建

環境說明

  • 操作系統:Win10
  • 數據庫:MySQL-5.7.25
  • JDK:64位 jdk1.8.0_201
  • 應用框架:spring-boot-2.1.3.RELEASE,Mybatis3.5.0
  • Sharding-JDBC:sharding-jdbc-spring-boot-starter-4.0.0-RC1

創建數據庫

創建訂單庫order_db

CREATE DATABASE `order_db` CHARACTER SET 'utf8' COLLATE 'utf8_general_ci';

在order_db中創建t_order_1、t_order_2表

DROP TABLE IF EXISTS `t_order_1`;
CREATE TABLE `t_order_1` (
`order_id` bigint(20) NOT NULL COMMENT '訂單id',
`price` decimal(10, 2) NOT NULL COMMENT '訂單價格',
`user_id` bigint(20) NOT NULL COMMENT '下單用戶id',
`status` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '訂單狀態',
PRIMARY KEY (`order_id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

DROP TABLE IF EXISTS `t_order_2`;
CREATE TABLE `t_order_2` (
`order_id` bigint(20) NOT NULL COMMENT '訂單id',
`price` decimal(10, 2) NOT NULL COMMENT '訂單價格',
`user_id` bigint(20) NOT NULL COMMENT '下單用戶id',
`status` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '訂單狀態',
PRIMARY KEY (`order_id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

引入maven依賴

引入 sharding-jdbc和SpringBoot整合的Jar包:

<dependency>
	<groupId>org.apache.shardingsphere</groupId>
	<artifactId>sharding‐jdbc‐spring‐boot‐starter</artifactId>
	<version>4.0.0‐RC1</version>
</dependency>

編寫程序

分片規則配置

分片規則配置是sharding-jdbc進行對分庫分表操作的重要依據,配置內容包括:數據源、主鍵生成策略、分片策
略等。
在application.properties中配置

server.port=56081

spring.application.name = fast-common-sharding-simple-example

server.servlet.context-path = /fast-common-sharding-simple-example
spring.http.encoding.enabled = true
spring.http.encoding.charset = UTF-8
spring.http.encoding.force = true

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

mybatis.configuration.map-underscore-to-camel-case = true

#sharding-jdbc分片規則配置
#數據源
spring.shardingsphere.datasource.names = m1

spring.shardingsphere.datasource.m1.type = com.alibaba.druid.pool.DruidDataSource
spring.shardingsphere.datasource.m1.driver-class-name = com.mysql.cj.jdbc.Driver
spring.shardingsphere.datasource.m1.url = jdbc:mysql://192.168.56.121:33065/order_db?useUnicode=true
spring.shardingsphere.datasource.m1.username = root
spring.shardingsphere.datasource.m1.password = root

# 指定t_order表的數據分佈情況,配置數據節點 m1.t_order_1,m1.t_order_2
spring.shardingsphere.sharding.tables.t_order.actual-data-nodes = m1.t_order_$->{1..2}

# 指定t_order表的主鍵生成策略爲SNOWFLAKE
spring.shardingsphere.sharding.tables.t_order.key-generator.column=order_id
spring.shardingsphere.sharding.tables.t_order.key-generator.type=SNOWFLAKE

# 指定t_order表的分片策略,分片策略包括分片鍵和分片算法
spring.shardingsphere.sharding.tables.t_order.table-strategy.inline.sharding-column = order_id
spring.shardingsphere.sharding.tables.t_order.table-strategy.inline.algorithm-expression = t_order_$->{order_id % 2 + 1}

# 打開sql輸出日誌
spring.shardingsphere.props.sql.show = true

swagger.enable = true

logging.level.root = info
logging.level.org.springframework.web = info
fast.cloud.nacos.sharding.examples  = debug
logging.level.druid.sql = debug

  1. 首先定義數據源m1,並對m1進行實際的參數配置。
  2. 指定t_order表的數據分佈情況,他分佈在m1.t_order_1,m1.t_order_2
  3. 指定t_order表的主鍵生成策略爲SNOWFLAKE,SNOWFLAKE是一種分佈式自增算法,保證id全局唯一
  4. 定義t_order分片策略,order_id爲偶數的數據落在t_order_1,爲奇數的落在t_order_2,分表策略的表達式爲t_order_$->{order_id % 2 + 1}

數據操作

@Mapper
@Component
public interface OrderDao {
	/**
	* 新增訂單
	* @param price 訂單價格
	* @param userId 用戶id
	* @param status 訂單狀態
	* @return
	*/
	@Insert("insert into t_order(price,user_id,status) value(#{price},#{userId},#{status})")
	int insertOrder(@Param("price") BigDecimal price, @Param("userId")Long userId,
	@Param("status")String status);
	/**
	* 根據id列表查詢多個訂單
	* @param orderIds 訂單id列表
	* @return
	*/
	@Select({"<script>" +
	"select " +
	" * " +
	" from t_order t" +
	" where t.order_id in " +
	"<foreach collection='orderIds' item='id' open='(' separator=',' close=')'>" +
	" #{id} " +
	"</foreach>"+
	"</script>"})
	List<Map> selectOrderbyIds(@Param("orderIds")List<Long> orderIds);
}

測試

編寫單元測試:

@Test
    public void testInsertOrder(){
        for(int i=1;i<20;i++){
            orderDao.insertOrder(new BigDecimal(i),1L,"SUCCESS");
        }
    }

    @Test
    public void testSelectOrderbyIds(){
        List<Long> ids = new ArrayList<>();
        ids.add(447039983417556993L);
        ids.add(447039983463694336L);

        List<Map> maps = orderDao.selectOrderbyIds(ids);
        System.out.println(maps);
    }

執行testInsertOrder:
在這裏插入圖片描述
通過日誌可以發現order_id爲奇數的被插入到t_order_2表,爲偶數的被插入到t_order_1表,達到預期目標。
執行testSelectOrderbyIds:
在這裏插入圖片描述
通過日誌可以發現,根據傳入order_id的奇偶不同,sharding-jdbc分別去不同的表檢索數據,達到預期目標。

流程分析

通過日誌分析,Sharding-JDBC在拿到用戶要執行的sql之後幹了哪些事兒:
(1)解析sql,獲取片鍵值,在本例中是order_id
(2)Sharding-JDBC通過規則配置 t_order_$->{order_id % 2 + 1},知道了當order_id爲偶數時,應該往
t_order_1表插數據,爲奇數時,往t_order_2插數據。
(3)於是Sharding-JDBC根據order_id的值改寫sql語句,改寫後的SQL語句是真實所要執行的SQL語句。
(4)執行改寫後的真實sql語句
(5)將所有真正執行sql的結果進行彙總合併,返回。

其他集成方式

Sharding-JDBC不僅可以與spring boot良好集成,它還支持其他配置方式

Spring Boot Yaml 配置

定義application.yml,內容如下

server:
  port: 56081
  servlet:
    context-path: /fast-common-sharding-simple-example
spring:
  application:
    name: fast-common-sharding-simple-example
  http:
    encoding:
      enabled: true
      charset: utf-8
      force: true
  main:
    allow-bean-definition-overriding: true
  shardingsphere:
    datasource:
      names: m1
      m1:
        type: com.alibaba.druid.pool.DruidDataSource
        driverClassName: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://192.168.56.121:3306/order_db?useUnicode=true
        username: root
        password: root
    sharding:
      tables:
        t_order:
          actualDataNodes: m1.t_order_$->{1..2}
          tableStrategy:
            inline:
              shardingColumn: order_id
              algorithmExpression: t_order_$->{order_id % 2 + 1}
          keyGenerator:
            type: SNOWFLAKE
            column: order_id
    props:
      sql:
        show: true
mybatis:
  configuration:
    map-underscore-to-camel-case: true
swagger:
  enable: true
logging:
  level:
    root: info
    org.springframework.web: info
    fast.cloud:.nacos.sharding:.examples: debug
    druid.sql: debug

Java 配置

添加配置類:

public class ShardingJdbcConfig {

    //配置分片規則
    // 定義數據源
    Map<String, DataSource> createDataSourceMap() {
        DruidDataSource dataSource1 = new DruidDataSource();
        dataSource1.setDriverClassName("com.mysql.jdbc.Driver");
        dataSource1.setUrl("jdbc:mysql://192.168.56.121:3306/order_db?useUnicode=true");
        dataSource1.setUsername("root");
        dataSource1.setPassword("root");
        Map<String, DataSource> result = new HashMap<>();
        result.put("m1", dataSource1);
        return result;
    }
    // 定義主鍵生成策略
    private static KeyGeneratorConfiguration getKeyGeneratorConfiguration() {
        KeyGeneratorConfiguration result = new KeyGeneratorConfiguration("SNOWFLAKE","order_id");
        return result;
    }

    // 定義t_order表的分片策略
    TableRuleConfiguration getOrderTableRuleConfiguration() {
        TableRuleConfiguration result = new TableRuleConfiguration("t_order","m1.t_order_$->{1..2}");
        result.setTableShardingStrategyConfig(new InlineShardingStrategyConfiguration("order_id", "t_order_$->{order_id % 2 + 1}"));
        result.setKeyGeneratorConfig(getKeyGeneratorConfiguration());

        return result;
    }
    // 定義sharding-Jdbc數據源
    @Bean
    DataSource getShardingDataSource() throws SQLException {
        ShardingRuleConfiguration shardingRuleConfig = new ShardingRuleConfiguration();
        shardingRuleConfig.getTableRuleConfigs().add(getOrderTableRuleConfiguration());
        //spring.shardingsphere.props.sql.show = true
        Properties properties = new Properties();
        properties.put("sql.show","true");
        return ShardingDataSourceFactory.createDataSource(createDataSourceMap(), shardingRuleConfig,properties);
    }

}

github地址:https://github.com/fafeidou/fast-cloud-nacos/tree/master/fast-common-examples/fast-common-sharding-simple-example

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章