JeecgBoot集成Sharding-JDBC

1. 環境描述

本次測試基於JeecgBoot 2.4.6，測試代碼在Jeecg-boot-module-system中編寫。

2. 引入座標

<dependency>
    <groupId>org.apache.shardingsphere</groupId>
    <artifactId>sharding-jdbc-spring-boot-starter</artifactId>
    <version>4.1.1</version>
</dependency>

3. 配置yml文件

datasource:
    druid:
      stat-view-servlet:
        enabled: true
        loginUsername: admin
        loginPassword: 123456
        allow:
      web-stat-filter:
        enabled: true
    dynamic:
      druid: # 全局druid參數，絕大部分值和默認保持一致。(現已支持的參數如下,不清楚含義不要亂設置)
        # 連接池的配置信息
        # 初始化大小，最小，最大
        initial-size: 5
        min-idle: 5
        maxActive: 20
        # 配置獲取連接等待超時的時間
        maxWait: 60000
        # 配置間隔多久才進行一次檢測，檢測需要關閉的空閒連接，單位是毫秒
        timeBetweenEvictionRunsMillis: 60000
        # 配置一個連接在池中最小生存的時間，單位是毫秒
        minEvictableIdleTimeMillis: 300000
        validationQuery: SELECT 1
        testWhileIdle: true
        testOnBorrow: false
        testOnReturn: false
        # 打開PSCache，並且指定每個連接上PSCache的大小
        poolPreparedStatements: true
        maxPoolPreparedStatementPerConnectionSize: 20
        # 配置監控統計攔截的filters，去掉後監控界面sql無法統計，'wall'用於防火牆
        filters: stat,wall,slf4j
        # 通過connectProperties屬性來打開mergeSql功能；慢SQL記錄
        connectionProperties: druid.stat.mergeSql\=true;druid.stat.slowSqlMillis\=5000
      primary: master # 設置默認的數據源或者數據源組,默認值即爲master
      strict: false   # 嚴格匹配數據源,默認false. true未匹配到指定數據源時拋異常,false使用默認數據源
      datasource:
        master:
          url: jdbc:mysql://127.0.0.1:3306/jeecg-boot?characterEncoding=UTF-8&useUnicode=true&useSSL=false&tinyInt1isBit=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai
          username: root
          password: root
          driver-class-name: com.mysql.cj.jdbc.Driver
          # 多數據源配置
          #multi-datasource1:
          #url: jdbc:mysql://localhost:3306/jeecg-boot2?useUnicode=true&characterEncoding=utf8&autoReconnect=true&zeroDateTimeBehavior=convertToNull&transformedBitIsBoolean=true&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai
          #username: root
          #password: root
          #driver-class-name: com.mysql.cj.jdbc.Driver
            # 指定默認數據源名稱
  shardingsphere:
    props:
      sql:
        show: true
    dataSource:
      names: ds0
      ds0:
        type: com.alibaba.druid.pool.DruidDataSource
        driverClassName: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/jeecg-boot?characterEncoding=UTF-8&useUnicode=true&useSSL=false&tinyInt1isBit=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai
        username: root
        password: root
    sharding:
      tables:
        sys_log:
          logicTable: sys_log
          actualDataNodes: ds0.sys_log$->{1..2}
          tableStrategy:
            inline:
              shardingColumn: id
              algorithmExpression: sys_log$->{id % 2 + 1}
          keyGenerator:
            type: SNOWFLAKE
            column: id
            worker:
            id: 1

注意：在jeecgboot原有數據源的基礎上，增加了primary節點，用來設置默認的數據源。

4. 建立數據表

在jeecgboot默認的數據庫中，將sys_log表複製兩份，分別命名爲sys_log1和sys_log2

5. 添加配置類

在config目錄下，添加配置類DataSourceConfiguration和DataSourceHealthConfig

其中DataSourceConfiguration.java配置類代碼如下：

package org.jeecg.config;
import com.baomidou.dynamic.datasource.DynamicRoutingDataSource;
import com.baomidou.dynamic.datasource.provider.AbstractDataSourceProvider;
import com.baomidou.dynamic.datasource.provider.DynamicDataSourceProvider;
import com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DataSourceProperty;
import com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DynamicDataSourceAutoConfiguration;
import com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DynamicDataSourceProperties;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Lazy;
import org.springframework.context.annotation.Primary;
import javax.annotation.Resource;
import javax.sql.DataSource;
import java.util.Map;
 
@Configuration
@AutoConfigureBefore({DynamicDataSourceAutoConfiguration.class, SpringBootConfiguration.class})
 
public class DataSourceConfiguration {
    /**
     * 分表數據源名稱
     */
    public static final String SHARDING_DATA_SOURCE_NAME = "sharding";
    /**
     * 動態數據源配置項
     */
    @Autowired
    private DynamicDataSourceProperties dynamicDataSourceProperties;
 
    @Lazy
    @Resource
    DataSource shardingDataSource;
 
    /**
     * 將shardingDataSource放到了多數據源（dataSourceMap）中
     * 注意有個版本的bug，3.1.1版本 不會進入loadDataSources 方法，這樣就一直造成數據源註冊失敗
     */
    @Bean
    public DynamicDataSourceProvider dynamicDataSourceProvider() {
        Map<String, DataSourceProperty> datasourceMap = dynamicDataSourceProperties.getDatasource();
        return new AbstractDataSourceProvider() {
            @Override
            public Map<String, DataSource> loadDataSources() {
                Map<String, DataSource> dataSourceMap = createDataSourceMap(datasourceMap);
                // 將 shardingjdbc 管理的數據源也交給動態數據源管理
                dataSourceMap.put(SHARDING_DATA_SOURCE_NAME, shardingDataSource);
                return dataSourceMap;
            }
        };
    }
 
    /**
     * 將動態數據源設置爲首選的
     * 當spring存在多個數據源時, 自動注入的是首選的對象
     * 設置爲主要的數據源之後，就可以支持shardingjdbc原生的配置方式了
     *
     * @return
     */
    @Primary
    @Bean
    public DataSource dataSource(DynamicDataSourceProvider dynamicDataSourceProvider) {
        DynamicRoutingDataSource dataSource = new DynamicRoutingDataSource();
        dataSource.setPrimary(dynamicDataSourceProperties.getPrimary());
        dataSource.setStrict(dynamicDataSourceProperties.getStrict());
        dataSource.setStrategy(dynamicDataSourceProperties.getStrategy());
        dataSource.setProvider(dynamicDataSourceProvider);
        dataSource.setP6spy(dynamicDataSourceProperties.getP6spy());
        dataSource.setSeata(dynamicDataSourceProperties.getSeata());
        return dataSource;
    }
}

DataSourceHealthConfig.java配置類代碼如下：

package org.jeecg.config;
 
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthContributorAutoConfiguration;
import org.springframework.boot.actuate.health.AbstractHealthIndicator;
import org.springframework.boot.actuate.jdbc.DataSourceHealthIndicator;
import org.springframework.boot.jdbc.metadata.DataSourcePoolMetadataProvider;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.StringUtils;
import javax.sql.DataSource;
import java.util.Map;
 
@Configuration
public class DataSourceHealthConfig extends DataSourceHealthContributorAutoConfiguration {
 
    @Value("${spring.datasource.dbcp2.validation-query:select 1}")
    private String defaultQuery;
 
 
    public DataSourceHealthConfig(Map<String, DataSource> dataSources, ObjectProvider<DataSourcePoolMetadataProvider> metadataProviders) {
        super(dataSources, metadataProviders);
    }
 
    @Override
    protected AbstractHealthIndicator createIndicator(DataSource source) {
        DataSourceHealthIndicator indicator = (DataSourceHealthIndicator) super.createIndicator(source);
        if (!StringUtils.hasText(indicator.getQuery())) {
            indicator.setQuery(defaultQuery);
        }
        return indicator;
    }
}

6. 接口編寫

Mapper

package org.jeecg.modules.shardingjdbc.mapper;
 
import com.baomidou.dynamic.datasource.annotation.DS;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;
import org.springframework.stereotype.Repository;
 
import java.util.List;
import java.util.Map;
 
/**
 * Created by sunh.
 */
@Mapper
@Repository
public interface SysLogShardingMapper {
 
    /**
     * 插入日誌
     * @param type
     * @param content
     * @param operateType
     * @return
     */
 
    @Insert("insert into sys_log(log_type,log_content,operate_type)values( #{type},#{content},#{operateType})")
    int insertLog( @Param("type") int type, @Param("content") String content, @Param("operateType") int operateType);
 
}

Service

package org.jeecg.modules.shardingjdbc.service;
 
public interface SysLogShardingService {
    int insertLog( int type, String content, int operateType);
}

ServiceImpl

package org.jeecg.modules.shardingjdbc.service.Impl;
 
import com.baomidou.dynamic.datasource.annotation.DS;
import lombok.extern.slf4j.Slf4j;
import org.jeecg.config.DataSourceConfiguration;
import org.jeecg.modules.shardingjdbc.mapper.SysLogShardingDao;
import org.jeecg.modules.shardingjdbc.service.SysLogShardingService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
 
@Slf4j
@Service
@DS(DataSourceConfiguration.SHARDING_DATA_SOURCE_NAME)
public class SysLogShardingServiceImpl implements SysLogShardingService {
    @Autowired
    private SysLogShardingDao sysLogShardingDao;
 
    @Override
    public int insertLog(int type, String content, int operateType) {
        int affectedRows = sysLogShardingDao.insertLog( type,content, operateType);
        return affectedRows;
    }
}

7. 測試用例

package org.jeecg.modules.shardingjdbc.controller;
import org.jeecg.common.api.vo.Result;
import org.jeecg.modules.shardingjdbc.mapper.SysLogShardingDao;
import org.jeecg.modules.shardingjdbc.service.SysLogShardingService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 測試sharding-jdbc
 */
@RestController
@RequestMapping("/sys_log")
public class SysLogShardingController {
    @Autowired
    private SysLogShardingService sysLogShardingService;
    @GetMapping("/test1")
    public Result<?> TestMongoDb(){
        for(int i=1;i<20;i++){
            sysLogShardingService.insertLog( i,"jeecgboot",i);
        }
        return Result.OK("存入成功");
    }
}

8. 測試結果