com.relaxed.common.idempotent.annotation

注释类型 Idempotent

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface Idempotent

幂等控制注解。 用于标记需要保证幂等性的方法，防止重复请求，主要功能包括： 1. 自定义幂等键前缀 2. 支持 SpEL 表达式提取唯一标识 3. 可配置幂等控制时长 4. 支持自定义提示信息 5. 可配置幂等键清理策略

从以下版本开始:

1.0

作者:

Yakir

字段概要

字段

限定符和类型	字段和说明
static String	KEY_PREFIX 幂等键前缀常量

可选元素概要

可选元素

限定符和类型	可选元素和说明
long	duration 幂等的控制时长，必须大于业务的处理耗时。
String	message 重复请求时的提示信息。
String	prefix 幂等标识的前缀，可用于区分服务和业务，防止 key 冲突。
boolean	removeKeyWhenError 是否在业务执行异常时立刻清除幂等 key。
boolean	removeKeyWhenFinished 是否在业务完成后立刻清除幂等 key。
TimeUnit	timeUnit 控制时长单位。
String	uniqueExpression SpEL 表达式，用于从上下文中提取幂等的唯一性标识。

字段详细资料

KEY_PREFIX

public static final String KEY_PREFIX

幂等键前缀常量

元素详细资料

prefix

public abstract String prefix

幂等标识的前缀，可用于区分服务和业务，防止 key 冲突。 完整的幂等标识格式为：{prefix}:{uniqueExpression.value}

返回:

业务标识前缀

默认值:

"idem"

uniqueExpression

public abstract String uniqueExpression

SpEL 表达式，用于从上下文中提取幂等的唯一性标识。

返回:

Spring-EL 表达式

默认值:

""

duration

public abstract long duration

幂等的控制时长，必须大于业务的处理耗时。 其值为幂等 key 的标记时长，超过标记时间，则幂等 key 可再次使用。

返回:

标记时长，默认 10 分钟

默认值:

600L

timeUnit

public abstract TimeUnit timeUnit

控制时长单位。

返回:

时间单位，默认为秒

默认值:

java.util.concurrent.TimeUnit.SECONDS

message

public abstract String message

重复请求时的提示信息。

返回:

提示信息

默认值:

"\u91cd\u590d\u8bf7\u6c42\uff0c\u8bf7\u7a0d\u540e\u91cd\u8bd5"

removeKeyWhenFinished

public abstract boolean removeKeyWhenFinished

是否在业务完成后立刻清除幂等 key。

返回:

true 表示立刻清除，false 表示不处理

默认值:

false

removeKeyWhenError

public abstract boolean removeKeyWhenError

是否在业务执行异常时立刻清除幂等 key。

返回:

true 表示立刻清除，false 表示不处理

默认值:

false