基于Redis实现分布式单号,分布式ID(自定义规则生成)

背景

一些业务背景下,业务要求单号需要有区分不同的前缀,那么在分布式的架构下如何自定义单号而且还能保证唯一呢?

注:分布式ID也可以此方式

Redis实现方式

Redis的所有命令操作都是单线程的,本身提供像 incr 和 increby 这样的自增原子命令,所以能保证生成的 ID 肯定是唯一有序的。

优点:不依赖于数据库,灵活方便,且性能优于数据库;数字ID天然排序,对分页或者需要排序的结果很有帮助。

缺点:如果系统中没有Redis,还需要引入新的组件,增加系统复杂度;需要编码和配置的工作量比较大。

考虑到单节点的性能瓶颈,可以使用 Redis 集群来获取更高的吞吐量。
使用 Redis 集群也可以方式单点故障的问题。

代码实例

创建常量类

1/** 2 * 单号生成常量 3 * 4 * @author mq 5 */ 6public class FormNoConstants { 7 /** 8 * 单号流水号缓存Key前缀 9 */ 10 public static final String SERIAL_CACHE_PREFIX = "FORM_NO_CACHE_"; 11 12 /** 13 * 单号流水号yyMMdd前缀 14 */ 15 public static final String SERIAL_YYMMDD_PREFIX = "yyMMdd"; 16 17 /** 18 * 单号流水号yyyyMMdd前缀 19 */ 20 public static final String SERIAL_YYYYMMDD_PREFIX = "yyyyMMdd"; 21 22 /** 23 * 默认缓存天数 24 */ 25 public static final int DEFAULT_CACHE_DAYS = 7; 26} 27 28

单号生成枚举

注:为了方便扩展,方便复用,使用枚举方式,可以自定义枚举值来生成不同的单号

1/** 2 * 单号生成类型枚举 3 * 4 * @author mq 5 * 注:随机号位于流水号之后,流水号使用redis计数据,每天都是一个新的key,长度不足时则自动补0 6 * <p> 7 * 生成规则 =固定前缀+当天日期串+流水号(redis自增,不足长度则补0)+随机数 8 */ 9public enum FormNoTypeEnum { 10 11 /** 12 * 应付单单号: 13 * 固定前缀:YF 14 * 时间格式:yyyyMMdd 15 * 流水号长度:7(当单日单据较多时可根据业务适当增加流水号长度) 16 * 随机数长度:3 17 * 总长度:20 18 */ 19 YF_ORDER("YF", FormNoConstants.SERIAL_YYYYMMDD_PREFIX, 7, 3, 20), 20 21 /** 22 * 付款单单号: 23 * 固定前缀:FK 24 * 时间格式:yyyyMMdd 25 * 流水号长度:7 26 * 随机数长度:3 27 * 总长度:20 28 */ 29 FK_ORDER("FK", FormNoConstants.SERIAL_YYYYMMDD_PREFIX, 7, 3, 20), 30 31 /** 32 * 测试单单号: 33 * 固定前缀:"" 34 * 时间格式:yyyyMMdd 35 * 流水号长度:10 36 * 随机数长度:0 37 * 总长度:20 38 */ 39 TEST_ORDER("te", FormNoConstants.SERIAL_YYYYMMDD_PREFIX, 10, 0, 20), 40 ; 41 42 /** 43 * 单号前缀 44 * 为空时填"" 45 */ 46 private String prefix; 47 48 /** 49 * 时间格式表达式 50 * 例如:yyyyMMdd 51 */ 52 private String datePattern; 53 54 /** 55 * 流水号长度 56 */ 57 private Integer serialLength; 58 /** 59 * 随机数长度 60 */ 61 private Integer randomLength; 62 63 /** 64 * 总长度 65 */ 66 private Integer totalLength; 67 68 69 FormNoTypeEnum(String prefix, String datePattern, Integer serialLength, Integer randomLength, Integer totalLength) { 70 this.prefix = prefix; 71 this.datePattern = datePattern; 72 this.serialLength = serialLength; 73 this.randomLength = randomLength; 74 this.totalLength = totalLength; 75 } 76 //省略 get 方法 77} 78 79

单号生成工具类

1/** 2 * 单号生成工具类 3 * 4 * @author mq 5 */ 6public class FormNoSerialUtil { 7 8 /** 9 * 生成单号前缀 10 */ 11 public static String getFormNoPrefix(FormNoTypeEnum formNoTypeEnum) { 12 //格式化时间 13 DateTimeFormatter formatter = DateTimeFormatter.ofPattern(formNoTypeEnum.getDatePattern()); 14 StringBuffer sb = new StringBuffer(); 15 sb.append(formNoTypeEnum.getPrefix()); 16 sb.append(formatter.format(LocalDateTime.now())); 17 return sb.toString(); 18 } 19 20 /** 21 * 构建流水号缓存Key 22 * 23 * @param serialPrefix 流水号前缀 24 * @return 流水号缓存Key 25 */ 26 public static String getCacheKey(String serialPrefix) { 27 return FormNoConstants.SERIAL_CACHE_PREFIX.concat(serialPrefix); 28 } 29 30 /** 31 * 补全流水号 32 * 33 * @param serialPrefix 单号前缀 34 * @param incrementalSerial 当天自增流水号 35 * @author mengqiang 36 * @date 2019/1/1 37 */ 38 public static String completionSerial(String serialPrefix, Long incrementalSerial, 39 FormNoTypeEnum formNoTypeEnum) { 40 StringBuffer sb = new StringBuffer(serialPrefix); 41 42 //需要补0的长度=流水号长度 -当日自增计数长度 43 int length = formNoTypeEnum.getSerialLength() - String.valueOf(incrementalSerial).length(); 44 //补零 45 for (int i = 0; i < length; i++) { 46 sb.append("0"); 47 } 48 //redis当日自增数 49 sb.append(incrementalSerial); 50 return sb.toString(); 51 } 52 53 54 /** 55 * 补全随机数 56 * 57 * @param serialWithPrefix 当前单号 58 * @param formNoTypeEnum 单号生成枚举 59 * @author mengqiang 60 * @date 2019/1/1 61 */ 62 public static String completionRandom(String serialWithPrefix, FormNoTypeEnum formNoTypeEnum) { 63 StringBuffer sb = new StringBuffer(serialWithPrefix); 64 //随机数长度 65 int length = formNoTypeEnum.getRandomLength(); 66 if (length > 0) { 67 Random random = new Random(); 68 for (int i = 0; i < length; i++) { 69 //十以内随机数补全 70 sb.append(random.nextInt(10)); 71 } 72 } 73 return sb.toString(); 74 } 75} 76 77

单号生成接口

1/** 2 * 单号生成接口 3 * 4 * @author mq 5 */ 6public interface FormNoGenerateService { 7 8 /** 9 * 根据单据编号类型 生成单据编号 10 * 11 * @param formNoTypeEnum 单据编号类型 12 * @author mengqiang 13 * @date 2019/1/1 14 */ 15 String generateFormNo(FormNoTypeEnum formNoTypeEnum); 16} 17 18

单号生成接口实现

1/** 2 * 单号生成接口实现 3 * 4 * @author mengqiang 5 * @version FormNoGenerateServiceImpl.java, v 1.0 2019-01-01 18:10 6 */ 7@Service 8public class FormNoGenerateServiceImpl implements FormNoGenerateService { 9 /** 10 * redis 服务 11 * demo 项目没有加redis相关,若有需要请参考,redis的博客 12 */ 13 @Autowired 14 private RedisCache redisCache; 15 /** 16 * 根据单据编号类型 生成单据编号 17 * 18 * @param formNoTypeEnum 单据编号类型 19 * @author mengqiang 20 * @date 2019/1/1 21 */ 22 @Override 23 public String generateFormNo(FormNoTypeEnum formNoTypeEnum) { 24 //获得单号前缀 25 //格式 固定前缀 +时间前缀 示例 :YF20190101 26 String formNoPrefix = FormNoSerialUtil.getFormNoPrefix(formNoTypeEnum); 27 //获得缓存key 28 String cacheKey = FormNoSerialUtil.getCacheKey(formNoPrefix); 29 //获得当日自增数 30 Long incrementalSerial = redisCache.incr(cacheKey); 31 //设置失效时间 7天 32 redisCache.expire(cacheKey, FormNoConstants.DEFAULT_CACHE_DAYS, TimeUnit.DAYS); 33 //组合单号并补全流水号 34 String serialWithPrefix = FormNoSerialUtil 35 .completionSerial(formNoPrefix, incrementalSerial, formNoTypeEnum); 36 //补全随机数 37 return FormNoSerialUtil.completionRandom(serialWithPrefix, formNoTypeEnum); 38 } 39} 40 41

使用测试

在这里插入图片描述

redis截图
在这里插入图片描述
总结
以上还不是最优雅的方式,最好是能做成jar包方式,做成通用的服务

代码交流 2021