| 提交 | 用户 | 时间 | ||
| e7c126 | 1 | package com.iailab.framework.idempotent.core.annotation; |
| H | 2 | |
| 3 | import com.iailab.framework.idempotent.core.keyresolver.impl.DefaultIdempotentKeyResolver; | |
| 4 | import com.iailab.framework.idempotent.core.keyresolver.IdempotentKeyResolver; | |
| 5 | import com.iailab.framework.idempotent.core.keyresolver.impl.ExpressionIdempotentKeyResolver; | |
| 6 | import com.iailab.framework.idempotent.core.keyresolver.impl.UserIdempotentKeyResolver; | |
| 7 | ||
| 8 | import java.lang.annotation.ElementType; | |
| 9 | import java.lang.annotation.Retention; | |
| 10 | import java.lang.annotation.RetentionPolicy; | |
| 11 | import java.lang.annotation.Target; | |
| 12 | import java.util.concurrent.TimeUnit; | |
| 13 | ||
| 14 | /** | |
| 15 | * 幂等注解 | |
| 16 | * | |
| 17 | * @author iailab | |
| 18 | */ | |
| 19 | @Target({ElementType.METHOD}) | |
| 20 | @Retention(RetentionPolicy.RUNTIME) | |
| 21 | public @interface Idempotent { | |
| 22 | ||
| 23 | /** | |
| 24 | * 幂等的超时时间，默认为 1 秒 | |
| 25 | * | |
| 26 | * 注意，如果执行时间超过它，请求还是会进来 | |
| 27 | */ | |
| 28 | int timeout() default 1; | |
| 29 | /** | |
| 30 | * 时间单位，默认为 SECONDS 秒 | |
| 31 | */ | |
| 32 | TimeUnit timeUnit() default TimeUnit.SECONDS; | |
| 33 | ||
| 34 | /** | |
| 35 | * 提示信息，正在执行中的提示 | |
| 36 | */ | |
| 37 | String message() default "重复请求，请稍后重试"; | |
| 38 | ||
| 39 | /** | |
| 40 | * 使用的 Key 解析器 | |
| 41 | * | |
| 42 | * @see DefaultIdempotentKeyResolver 全局级别 | |
| 43 | * @see UserIdempotentKeyResolver 用户级别 | |
| 44 | * @see ExpressionIdempotentKeyResolver 自定义表达式，通过 {@link #keyArg()} 计算 | |
| 45 | */ | |
| 46 | Class<? extends IdempotentKeyResolver> keyResolver() default DefaultIdempotentKeyResolver.class; | |
| 47 | /** | |
| 48 | * 使用的 Key 参数 | |
| 49 | */ | |
| 50 | String keyArg() default ""; | |
| 51 | ||
| 52 | /** | |
| 53 | * 删除 Key，当发生异常时候 | |
| 54 | * | |
| 55 | * 问题：为什么发生异常时，需要删除 Key 呢？ | |
| 56 | * 回答：发生异常时，说明业务发生错误，此时需要删除 Key，避免下次请求无法正常执行。 | |
| 57 | * | |
| 58 | * 问题：为什么不搞 deleteWhenSuccess 执行成功时，需要删除 Key 呢？ | |
| 59 | * 回答：这种情况下，本质上是分布式锁，推荐使用 @Lock4j 注解 | |
| 60 | */ | |
| 61 | boolean deleteKeyWhenException() default true; | |
| 62 | ||
| 63 | } | |
