ShardingSphere-Proxy5自定义算法

ShardingSphere-Proxy5自定义算法

ShardingSphere 支持两种方式来扩展自定义算法：SPI 和 ClassBased。CLASS_BASE实际上是已经实现了的SPI。
ClassBased实现自定义分片

ClassBased需要我们实现StandardShardingAlgorithm接口。
创建springboot工程

首先创建一个springboot工程，并添加sharding-sphere依赖

1. <dependency>  
2.     <groupId>org.apache.shardingsphere</groupId>  
3.     <artifactId>shardingsphere-jdbc-core-spring-boot-starter</artifactId>  
4.     <version>5.2.0</version>  
5. </dependency>

复制代码

新建自定义算法类

新建一个类DemoAlgortihm并实现StandardShardingAlgorithm接口。

1. public class DemoAlgortihm implements StandardShardingAlgorithm<Integer> {  
2.   
3.     /**  
4.      * 精确查询分片执行接口  
5.      * @param availableTargetNames: 可用的分片名集合(分库就是库名，分表就是表名)  
6.      * @param preciseShardingValue: 分片键  
7.      * @return 分片名  
8.      */  
9.     @Override  
10.     public String doSharding(Collection<String> availableTargetNames, PreciseShardingValue<Integer> preciseShardingValue) {  
11.         // availableTargetNames: 分片集合  
12.         // preciseShardingValue: 分片键值  
13.         String logicTableName = preciseShardingValue.getLogicTableName();  
14.         // 获取分片键value  
15.         Integer userIdL = preciseShardingValue.getValue();  
16.   
17.         // 实现 t_order$->{user_id % 2}        BigInteger userId = BigInteger.valueOf(userIdL);  
18.   
19.         BigInteger result = userId.mod(new BigInteger("2"));  
20.         String key = logicTableName+""+result;  
21.   
22.         if (availableTargetNames.contains(key)) {  
23.             return key;  
24.         }  
25.   
26.         throw new UnsupportedOperationException("route: " + key + " is not supported, please check your config");  
27.     }  
28.   
29.     /**  
30.      * 范围查询分片算法（分片键涉及区间查询时会进入该方法进行分片计算）  
31.      * @param availableTargetNames  
32.      * @param rangeShardingValue  
33.      * @return 返回多个分片名  
34.      */  
35.     @Override  
36.     public Collection<String> doSharding(Collection<String> availableTargetNames, RangeShardingValue<Integer> rangeShardingValue) {  
37.         // 对于取模算法分片，无法确定查询区间里涉及的分片，因此直接返回所有路由  
38.         return availableTargetNames;  
39.     }  
41.         // 自定义算法参数
42.         @Getter  
43.         private Properties props;
44.        
45.     @Override  
46.     public void init(Properties properties) {  
47.     }  
48. }

复制代码

打包

打包放在sharding-proxy的lib目录。注意打包时不能使用springboot插件进行打包，打包后包结构一定要如下所示，否则无法正确找到自定义算法。这种形式的打包并不会引入依赖，因此如果自定义算法需要引入其他jar包时，我们要手动把依赖的包也一并放到sharding-proxy的lib目录。
![[Pasted image 20221011113051.png]]
配置分片规则

修改config-sharding.yaml文件添加数据分片规则

1.     alg_hash_mod:
2.       # type: HASH_MOD
3.       # props:
4.       #   sharding-count: 2
5.       type: CLASS_BASED
6.       props:
7.         strategy: standard # 我们实现的是StandardShardingAlgorithm接口，因此属于standard策略
8.         # 自定义算法全限定类名
9.         algorithmClassName: com.sharding.algortihm.DemoAlgortihm

复制代码

完整配置文件

1. databaseName: sharding_db
3. dataSources:
4.   ds_0:
5.     url: jdbc:mysql://127.0.0.1:13307/demo_ds_0?serverTimezone=UTC&useSSL=false
6.     username: root
7.     password: sunday
8.     connectionTimeoutMilliseconds: 30000
9.     idleTimeoutMilliseconds: 60000
10.     maxLifetimeMilliseconds: 1800000
11.     maxPoolSize: 50
12.     minPoolSize: 1
13.   ds_1:
14.     url: jdbc:mysql://127.0.0.1:3306/demo_ds_1?serverTimezone=UTC&useSSL=false
15.     username: root
16.     password: sunday
17.     connectionTimeoutMilliseconds: 30000
18.     idleTimeoutMilliseconds: 60000
19.     maxLifetimeMilliseconds: 1800000
20.     maxPoolSize: 50
21.     minPoolSize: 1
23. rules:
24. - !SHARDING
25.   tables:
26.     t_order:
27.       actualDataNodes: ds_${0..1}.t_order${0..1}
28.       databaseStrategy:
29.         standard:
30.           shardingColumn: user_id
31.           shardingAlgorithmName: alg_mod
32.       tableStrategy:
33.         standard:
34.           shardingColumn: order_no
35.           shardingAlgorithmName: alg_hash_mod
36.       keyGenerateStrategy:
37.         column: id
38.         keyGeneratorName: snowflake
40.   keyGenerators:
41.     snowflake:
42.       type: SNOWFLAKE
44.   shardingAlgorithms:
45.     alg_mod:
46.       type: MOD
47.       props:
48.         sharding-count: 2
49.     alg_hash_mod:
50.       # type: HASH_MOD
51.       # props:
52.       #   sharding-count: 2
53.       type: CLASS_BASED
54.       props: # 算法参数，可以在下面自定义自己的参数，获取时通过自定义算法中的props对象获取。参数值仅支持字符串和数字，不支持对象、map等参数，对于map等参数可以按照字符串形式传入程序，然后通过JSON工具反序列化。
55.         strategy: standard # 我们实现的是StandardShardingAlgorithm接口，因此属于standard策略
56.         # 自定义算法全限定类名
57.         algorithmClassName: com.sharding.algortihm.DemoAlgortihm

复制代码

连接proxy创建分片表

配置分片表后，并没有生成相应的分片表，需要连接上sharding-proxy，在proxy中执行建表语句，在创建逻辑表时分片表会被proxy自动按照配置的规则进行创建。

1. CREATE TABLE `t_order` (
2.   `id` bigint(20) NOT NULL AUTO_INCREMENT,
3.   `order_no` varchar(30) DEFAULT NULL,
4.   `user_id` bigint(20) DEFAULT NULL,
5.   `amount` decimal(10,2) DEFAULT NULL,
6.   PRIMARY KEY (`id`)
7. ) ENGINE=InnoDB AUTO_INCREMENT=779468255126355969 DEFAULT CHARSET=utf8mb4;

复制代码

插入测试数据

1. INSERT INTO `sharding_db`.`t_order`(`id`, `order_no`, `user_id`, `amount`) VALUES (779468213359476737, '22', 22, 22.00);
2. INSERT INTO `sharding_db`.`t_order`(`id`, `order_no`, `user_id`, `amount`) VALUES (779468285585391617, '44', 44, 44.00);
3. INSERT INTO `sharding_db`.`t_order`(`id`, `order_no`, `user_id`, `amount`) VALUES (779468168534949888, '11', 11, 11.00);
4. INSERT INTO `sharding_db`.`t_order`(`id`, `order_no`, `user_id`, `amount`) VALUES (779468255126355968, '33', 33, 33.00);

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！