不会用Redis做分布式流水号？ Redis生成分布式流水号

Redis生成分布式流水号

「这是我参与11月更文挑战的第2天，活动详情查看：2021最后一次更文挑战」

引言

最近做项目，需要做单据编号，格式固定为：单据类型固定前缀+年月日时间戳+4位流水号，要求是每个单据类型的流水号唯一，方便后续业务使用。之前项目中使用的是UUID作为其他业务的单据编号，和组长沟通了一下，项目中有使用Redis，正好使用Redis做更便捷并能解决分布式部署单号唯一问题。

分布式Id也可以用相同的方式处理

思路

例子：以特别单据为例，今天是2021年11月4日，今天的第一个单据的单据编号应该为：S202111040001

通过Redis实现的话，则需要以my-test:no:S20211104作为Redis缓存的key，1作为value做存储，同时每次获取一个value就让其自增计数，同时每次取key的时候更新失效时间，保证如果key自动失效，Redis中不会有大量的key堆积。

Redis实现

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

• 优点：不依赖于数据库，灵活方便，且性能优于数据库。
  根据业务特点，需要将Redis的key封装，单据类型封装，为了后续做扩展，将单据编号总长度，流水号长度等也做了封装。下面是代码实现：

常量类

常量中保存的是Redis的缓存key前缀，以及年月日时间戳的前缀格式

java复制代码/**
 * @className: FormNoConstant
 * @description: 单号生成常量
 * @author: hanHang
 * @create: 2021/9/28 9:41
 **/
public class FormNoConstant {
    /**
     * 单号流水号缓存Key前缀
     */
    public static final String SERIAL_CACHE_PREFIX = "my-test:no:";
    /**
     * 单号流水号yyyyMMdd前缀
     */
    public static final String SERIAL_YYYY_MM_DD_PREFIX = "yyyyMMdd";
}

枚举

枚举中保存的是单据类型前缀、日期时间戳格式化表达式、流水号长度、单据编号总长度等信息

java复制代码/**
 * @className: FormNoTypeEnum
 * @description: 编号生成类型枚举
 * @author: hanHang
 * @create: 2021/9/28 9:40
 **/
@Getter
public enum FormNoTypeEnum {
    /**
     * 特别单据单号：
     */
    SPECIAL_ORDER("S", FormNoConstants.SERIAL_YYYY_MM_DD_PREFIX, 3 , 12),

    /**
     * 正常单据单号：
     */
    NORMAL_ORDER("N", FormNoConstants.SERIAL_YYYY_MM_DD_PREFIX, 3 , 12);

    /**
     * 单号前缀 为空时填""
     */
    private final String prefix;

    /**
     * 时间格式表达式
     * 例如：yyyyMMdd
     */
    private final String datePattern;

    /**
     * 流水号长度
     */
    private final Integer serialLength;

    /**
     * 总长度
     */
    private final Integer totalLength;


    FormNoTypeEnum(String prefix, String datePattern, Integer serialLength, Integer totalLength) {
        this.prefix = prefix;
        this.datePattern = datePattern;
        this.serialLength = serialLength;
        this.totalLength = totalLength;
    }
}

工具类

工具类中包含了获取单号前缀、根据单号前缀获取缓存key、补全流水号生成完整流水号方法。

getCacheKey(String serialPrefix)：此方法是从Redis中获取对应单据类型-日期的key

java复制代码/**
 * @className: FormNoSerialUtil
 * @description: 单据编号工具类
 * @author: hanHang
 * @create: 2021/9/28 9:45
 **/
public class FormNoSerialUtil {
    /**
     * 根据单据类型获取单号前缀
	 * @param formNoTypeEnum
	 * @return 单号前缀
     */
    public static String getFormNoPrefix(FormNoTypeEnum formNoTypeEnum) {
        //格式化时间
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern(formNoTypeEnum.getDatePattern());
        return formNoTypeEnum.getPrefix() +
                formatter.format(LocalDateTime.now());
    }

    /**
     * 获取流水号缓存Key
     * @param serialPrefix 流水号前缀
     * @return 流水号缓存Key
     */
    public static String getCacheKey(String serialPrefix) {
        return FormNoConstants.SERIAL_CACHE_PREFIX.concat(serialPrefix);
    }

    /**
     * 补全流水号
     *
     * @param serialPrefix      单号前缀
     * @param incrementalSerial 当天自增流水号
	 * @param formNoTypeEnum    单据类型枚举
	 * @return 完整流水号
     */
    public static String completionSerial(String serialPrefix, Long incrementalSerial,
                                          FormNoTypeEnum formNoTypeEnum) {
        StringBuffer sb = new StringBuffer(serialPrefix);

        //需要补0的长度=流水号长度 -当日自增计数长度
        int length = formNoTypeEnum.getSerialLength() - String.valueOf(incrementalSerial).length();
        //补零
        for (int i = 0; i < length; i++) {
            sb.append("0");
        }
        //redis当日自增数
        sb.append(incrementalSerial);
        return sb.toString();
    }
}

Component

利用Component注解将此类交给Spring代理，暴露generateFormNo方法，根据单据类型枚举获得缓存key，在Redis中获取key对应的value，每次获取并自增1。

需要注意：如果是当天第一次调用，value取出来的是0，需要再进行一次自增，因为需要从1开始计数。

java复制代码/**
 * @className: FormNoGenerateComponent
 * @description: 单号生成
 * @author: hanHang
 * @create: 2021/9/28 9:52
 **/
@Component
public class FormNoGenerateComponent {
    @Resource
    RedisTemplate<String, Object> redisTemplate;

    /**
     * 根据单据编号类型 生成单据编号
     * @param formNoTypeEnum 单据编号类型
     * @return 单据编号
     */
    public String generateFormNo(FormNoTypeEnum formNoTypeEnum) {
        //获得单号前缀 格式 固定前缀 +时间前缀 示例 ：S20211104
        String formNoPrefix = FormNoSerialUtil.getFormNoPrefix(formNoTypeEnum);
        //获得缓存key
        String cacheKey = FormNoSerialUtil.getCacheKey(formNoPrefix);

        Long incrementalSerial = getIncr(cacheKey,getCurrent2TodayEndMillisTime());
        if (incrementalSerial==0){
            incrementalSerial = getIncr(cacheKey,getCurrent2TodayEndMillisTime());
        }

        //组合单号并补全流水号
        return FormNoSerialUtil
                .completionSerial(formNoPrefix, incrementalSerial, formNoTypeEnum);
    }

    /**
     * 获得当日自增数
     * @param key key
     * @param liveTime 存活时间
     * @return 当日自增数
     */
    private Long getIncr(String key, long liveTime) {
        RedisAtomicLong entityIdCounter = new RedisAtomicLong(key, Objects.requireNonNull(redisTemplate.getConnectionFactory()));
        long increment = entityIdCounter.getAndIncrement();

        //初始设置过期时间
        if (increment == 0 && liveTime > 0) {
            entityIdCounter.expire(liveTime, TimeUnit.MILLISECONDS);
        }
        return increment;
    }

    /**
     * @return 现在到今天结束的毫秒数
     */
    private Long getCurrent2TodayEndMillisTime() {
        Calendar todayEnd = Calendar.getInstance();
        todayEnd.set(Calendar.HOUR_OF_DAY, 23);
        todayEnd.set(Calendar.MINUTE, 59);
        todayEnd.set(Calendar.SECOND, 59);
        todayEnd.set(Calendar.MILLISECOND, 999);
        return todayEnd.getTimeInMillis() - System.currentTimeMillis();
    }
}

总结

使用Redis做分布式编号是目前工作中用到场景比较多的，也可以使用这种方法做分布式唯一主键，但是如果业务处理失败，此编号就被占用，会有一天之内的数据编号有断的场景，我没有想到很好的解决办法，需要大佬指教。

还有面试中有被问到用雪花算法处理分布式唯一主键的，还没有研究过，等研究好了，再写一篇文章。

本文转载自: 掘金

开发者博客 – 和开发相关的 这里全都有