update 新增发号器工具类方法

This commit is contained in:
AprilWind 2025-05-22 17:52:23 +08:00
parent 05d5d9be2c
commit b726a91cdb

View File

@ -1,165 +1,180 @@
package org.dromara.common.redis.utils; package org.dromara.common.redis.utils;
import cn.hutool.core.date.DatePattern; import cn.hutool.core.date.DatePattern;
import cn.hutool.core.date.DateUtil; import cn.hutool.core.date.DateUtil;
import org.dromara.common.core.utils.SpringUtils; import lombok.AccessLevel;
import org.dromara.common.core.utils.StringUtils; import lombok.NoArgsConstructor;
import lombok.AccessLevel; import org.dromara.common.core.utils.SpringUtils;
import lombok.NoArgsConstructor; import org.dromara.common.core.utils.StringUtils;
import org.redisson.api.RIdGenerator; import org.redisson.api.RIdGenerator;
import org.redisson.api.RedissonClient; import org.redisson.api.RedissonClient;
import java.time.Duration; import java.time.Duration;
/** /**
* 发号器工具类 * 发号器工具类
* *
* @author 秋辞未寒 * @author 秋辞未寒
* @date 2024-12-10 * @date 2024-12-10
*/ */
@NoArgsConstructor(access = AccessLevel.PRIVATE) @NoArgsConstructor(access = AccessLevel.PRIVATE)
public class SequenceUtils { public class SequenceUtils {
/** /**
* 默认初始值 * 默认初始值
*/ */
public static final Long DEFAULT_INIT_VALUE = 1L; public static final Long DEFAULT_INIT_VALUE = 1L;
/**
* 默认步长 /**
*/ * 默认步长
public static final Long DEFAULT_STEP_VALUE = 1L; */
/** public static final Long DEFAULT_STEP_VALUE = 1L;
* 默认过期时间-
*/ /**
public static final Duration DEFAULT_EXPIRE_TIME_DAY = Duration.ofDays(1); * 默认过期时间-
/** */
* 默认过期时间-分钟 public static final Duration DEFAULT_EXPIRE_TIME_DAY = Duration.ofDays(1);
*/
public static final Duration DEFAULT_EXPIRE_TIME_MINUTE = Duration.ofMinutes(1); /**
* 默认过期时间-分钟
/** */
* 获取Redisson客户端实例 public static final Duration DEFAULT_EXPIRE_TIME_MINUTE = Duration.ofMinutes(1);
*/
private static final RedissonClient REDISSON_CLIENT = SpringUtils.getBean(RedissonClient.class); /**
* 获取Redisson客户端实例
/** */
* 获取ID生成器 private static final RedissonClient REDISSON_CLIENT = SpringUtils.getBean(RedissonClient.class);
*
* @param key 业务key /**
* @param expireTime 过期时间 * 获取ID生成器
* @param initValue ID初始值 *
* @param stepValue ID步长 * @param key 业务key
* @return ID生成器 * @param expireTime 过期时间
*/ * @param initValue ID初始值
private static RIdGenerator getIdGenerator(String key, Duration expireTime, Long initValue, Long stepValue) { * @param stepValue ID步长
if (initValue == null || initValue <= 0) { * @return ID生成器
initValue = DEFAULT_INIT_VALUE; */
} private static RIdGenerator getIdGenerator(String key, Duration expireTime, Long initValue, Long stepValue) {
if (stepValue == null || stepValue <= 0) { if (initValue == null || initValue <= 0) {
stepValue = DEFAULT_STEP_VALUE; initValue = DEFAULT_INIT_VALUE;
} }
RIdGenerator idGenerator = REDISSON_CLIENT.getIdGenerator(key); if (stepValue == null || stepValue <= 0) {
// 设置初始值和步长 stepValue = DEFAULT_STEP_VALUE;
idGenerator.tryInit(initValue, stepValue); }
// 设置过期时间 RIdGenerator idGenerator = REDISSON_CLIENT.getIdGenerator(key);
idGenerator.expire(expireTime); // 设置初始值和步长
return idGenerator; idGenerator.tryInit(initValue, stepValue);
} // 设置过期时间
idGenerator.expire(expireTime);
/** return idGenerator;
* 获取指定业务key的唯一id }
*
* @param key 业务key /**
* @param expireTime 过期时间 * 获取指定业务key的唯一id
* @param initValue ID初始值 *
* @param stepValue ID步长 * @param key 业务key
* @return 唯一id * @param expireTime 过期时间
*/ * @param initValue ID初始值
public static long nextId(String key, Duration expireTime, Long initValue, Long stepValue) { * @param stepValue ID步长
return getIdGenerator(key, expireTime, initValue, stepValue).nextId(); * @return 唯一id
} */
public static long nextId(String key, Duration expireTime, Long initValue, Long stepValue) {
/** return getIdGenerator(key, expireTime, initValue, stepValue).nextId();
* 获取指定业务key的唯一id字符串 }
*
* @param key 业务key /**
* @param expireTime 过期时间 * 获取指定业务key的唯一id字符串
* @param initValue ID初始值 *
* @param stepValue ID步长 * @param key 业务key
* @return 唯一id * @param expireTime 过期时间
*/ * @param initValue ID初始值
public static String nextIdStr(String key, Duration expireTime, Long initValue, Long stepValue) { * @param stepValue ID步长
return String.valueOf(nextId(key, expireTime, initValue, stepValue)); * @return 唯一id
} */
public static String nextIdStr(String key, Duration expireTime, Long initValue, Long stepValue) {
/** return String.valueOf(nextId(key, expireTime, initValue, stepValue));
* 获取指定业务key的唯一id (ID初始值=1,ID步长=1) }
*
* @param key 业务key /**
* @param expireTime 过期时间 * 获取指定业务key的唯一id (ID初始值=1,ID步长=1)
* @return 唯一id *
*/ * @param key 业务key
public static long nextId(String key, Duration expireTime) { * @param expireTime 过期时间
return getIdGenerator(key, expireTime, DEFAULT_INIT_VALUE, DEFAULT_STEP_VALUE).nextId(); * @return 唯一id
} */
public static long nextId(String key, Duration expireTime) {
/** return getIdGenerator(key, expireTime, DEFAULT_INIT_VALUE, DEFAULT_STEP_VALUE).nextId();
* 获取指定业务key的唯一id字符串 (ID初始值=1,ID步长=1) }
*
* @param key 业务key /**
* @param expireTime 过期时间 * 获取指定业务key的唯一id字符串 (ID初始值=1,ID步长=1)
* @return 唯一id *
*/ * @param key 业务key
public static String nextIdStr(String key, Duration expireTime) { * @param expireTime 过期时间
return String.valueOf(nextId(key, expireTime)); * @return 唯一id
} */
public static String nextIdStr(String key, Duration expireTime) {
/** return String.valueOf(nextId(key, expireTime));
* 获取 yyyyMMdd 开头的唯一id }
*
* @return 唯一id /**
*/ * 获取指定业务key的唯一id字符串 (ID初始值=1,ID步长=1)不足位数自动补零
public static String nextIdDate() { *
return nextIdDate(""); * @param key 业务key
} * @param expireTime 过期时间
* @param width 位数不足左补0
/** * @return 补零后的唯一id字符串
* 获取 prefix + yyyyMMdd 开头的唯一id */
* public static String nextPaddedIdStr(String key, Duration expireTime, Integer width) {
* @param prefix 业务前缀 return StringUtils.leftPad(nextIdStr(key, expireTime), width, '0');
* @return 唯一id }
*/
public static String nextIdDate(String prefix) { /**
// 前缀+日期 构建 prefixKey * 获取 yyyyMMdd 开头的唯一id
String prefixKey = StringUtils.format("{}{}", StringUtils.blankToDefault(prefix, ""), DateUtil.format(DateUtil.date(), DatePattern.PURE_DATE_FORMATTER)); *
// 获取下一个id * @return 唯一id
long nextId = getIdGenerator(prefixKey, DEFAULT_EXPIRE_TIME_DAY, DEFAULT_INIT_VALUE, DEFAULT_STEP_VALUE).nextId(); */
// 返回完整id public static String nextIdDate() {
return StringUtils.format("{}{}", prefixKey, nextId); return nextIdDate("");
} }
/** /**
* 获取 yyyyMMddHHmmss 开头的唯一id * 获取 prefix + yyyyMMdd 开头的唯一id
* *
* @return 唯一id * @param prefix 业务前缀
*/ * @return 唯一id
public static String nextIdDateTime() { */
return nextIdDateTime(""); public static String nextIdDate(String prefix) {
} // 前缀+日期 构建 prefixKey
String prefixKey = StringUtils.format("{}{}", StringUtils.blankToDefault(prefix, ""), DateUtil.format(DateUtil.date(), DatePattern.PURE_DATE_FORMATTER));
/** // 获取下一个id
* 获取 prefix + yyyyMMddHHmmss 开头的唯一id long nextId = getIdGenerator(prefixKey, DEFAULT_EXPIRE_TIME_DAY, DEFAULT_INIT_VALUE, DEFAULT_STEP_VALUE).nextId();
* // 返回完整id
* @param prefix 业务前缀 return StringUtils.format("{}{}", prefixKey, nextId);
* @return 唯一id }
*/
public static String nextIdDateTime(String prefix) { /**
// 前缀+日期时间 构建 prefixKey * 获取 yyyyMMddHHmmss 开头的唯一id
String prefixKey = StringUtils.format("{}{}", StringUtils.blankToDefault(prefix, ""), DateUtil.format(DateUtil.date(), DatePattern.PURE_DATETIME_FORMATTER)); *
// 获取下一个id * @return 唯一id
long nextId = getIdGenerator(prefixKey, DEFAULT_EXPIRE_TIME_MINUTE, DEFAULT_INIT_VALUE, DEFAULT_STEP_VALUE).nextId(); */
// 返回完整id public static String nextIdDateTime() {
return StringUtils.format("{}{}", prefixKey, nextId); return nextIdDateTime("");
} }
} /**
* 获取 prefix + yyyyMMddHHmmss 开头的唯一id
*
* @param prefix 业务前缀
* @return 唯一id
*/
public static String nextIdDateTime(String prefix) {
// 前缀+日期时间 构建 prefixKey
String prefixKey = StringUtils.format("{}{}", StringUtils.blankToDefault(prefix, ""), DateUtil.format(DateUtil.date(), DatePattern.PURE_DATETIME_FORMATTER));
// 获取下一个id
long nextId = getIdGenerator(prefixKey, DEFAULT_EXPIRE_TIME_MINUTE, DEFAULT_INIT_VALUE, DEFAULT_STEP_VALUE).nextId();
// 返回完整id
return StringUtils.format("{}{}", prefixKey, nextId);
}
}