对于一些用户申请,在某些状况下是可能反复发送的,如果是查问类操作并无大碍,但其中有些是波及写入操作的,一旦反复了,可能会导致很重大的结果,例如交易的接口如果反复申请可能会反复下单。
反复的场景有可能是:
- 黑客拦挡了申请,重放
- 前端 / 客户端因为某些起因申请反复发送了,或者用户在很短的工夫内反复点击了。
- 网关重发
- ….
本文探讨的是如果在服务端优雅地对立解决这种状况,如何禁止用户反复点击等客户端操作不在本文的探讨领域。
利用惟一申请编号去重
你可能会想到的是,只有申请有惟一的申请编号,那么就能借用 Redis 做这个去重——只有这个惟一申请编号在 redis 存在,证实解决过,那么就认为是反复的
代码大略如下:
String KEY = "REQ12343456788";// 申请惟一编号
long expireTime = 1000;// 1000 毫秒过期,1000ms 内的反复申请会认为反复
long expireAt = System.currentTimeMillis() + expireTime;
String val = "expireAt@" + expireAt;
//redis key 还存在的话要就认为申请是反复的
Boolean firstSet = stringRedisTemplate.execute((RedisCallback<Boolean>) connection -> connection.set(KEY.getBytes(), val.getBytes(), Expiration.milliseconds(expireTime), RedisStringCommands.SetOption.SET_IF_ABSENT));
final boolean isConsiderDup;
if (firstSet != null && firstSet) {// 第一次拜访
isConsiderDup = false;
} else {// redis 值已存在,认为是反复了
isConsiderDup = true;
}
业务参数去重
下面的计划能解决具备惟一申请编号的场景,例如每次写申请之前都是服务端返回一个惟一编号给客户端,客户端带着这个申请号做申请,服务端即可实现去重拦挡。
然而,很多的场景下,申请并不会带这样的惟一编号!那么咱们是否针对申请的参数作为一个申请的标识呢?
先思考简略的场景,假如申请参数只有一个字段 reqParam,咱们能够利用以下标识去判断这个申请是否反复。 用户 ID: 接口名: 申请参数
String KEY = "dedup:U="+userId + "M=" + method + "P=" + reqParam;
那么当同一个用户拜访同一个接口,带着同样的 reqParam 过去,咱们就能定位到他是反复的了。
然而问题是,咱们的接口通常不是这么简略,以目前的支流,咱们的参数通常是一个 JSON。那么针对这种场景,咱们怎么去重呢?
计算申请参数的摘要作为参数标识
假如咱们把申请参数(JSON)按 KEY 做升序排序,排序后拼成一个字符串,作为 KEY 值呢?但这可能十分的长,所以咱们能够思考对这个字符串求一个 MD5 作为参数的摘要,以这个摘要去取代 reqParam 的地位。
String KEY = "dedup:U="+userId + "M=" + method + "P=" + reqParamMD5;
这样,申请的惟一标识就打上了!
注:MD5 实践上可能会反复,然而去重通常是短时间窗口内的去重(例如一秒),一个短时间内同一个用户同样的接口能拼出不同的参数导致一样的 MD5 简直是不可能的。
持续优化,思考剔除局部工夫因子
下面的问题其实曾经是一个很不错的解决方案了,然而理论投入使用的时候可能发现有些问题:某些申请用户短时间内反复的点击了(例如 1000 毫秒发送了三次申请),但绕过了下面的去重判断(不同的 KEY 值)。
起因是这些申请参数的字段外面, 是带工夫字段的 ,这个字段标记用户申请的工夫,服务端能够借此抛弃掉一些老的申请(例如 5 秒前)。如上面的例子,申请的其余参数是一样的,除了申请工夫相差了一秒:
// 两个申请一样,然而申请时间差一秒
String req = "{\n" +
"\"requestTime\":\"20190101120001\",\n" +
"\"requestValue\":\"1000\",\n" +
"\"requestKey\":\"key\"\n" +
"}";
String req2 = "{\n" +
"\"requestTime\":\"20190101120002\",\n" +
"\"requestValue\":\"1000\",\n" +
"\"requestKey\":\"key\"\n" +
"}";
这种申请,咱们也很可能须要挡住前面的反复申请。所以求业务参数摘要之前,须要剔除这类工夫字段。还有相似的字段可能是 GPS 的经纬度字段(反复申请间可能有极小的差异)。
申请去重工具类,Java 实现
public class ReqDedupHelper {
/**
*
* @param reqJSON 申请的参数,这里通常是 JSON
* @param excludeKeys 申请参数外面要去除哪些字段再求摘要
* @return 去除参数的 MD5 摘要
*/
public String dedupParamMD5(final String reqJSON, String... excludeKeys) {
String decreptParam = reqJSON;
TreeMap paramTreeMap = JSON.parseObject(decreptParam, TreeMap.class);
if (excludeKeys!=null) {List<String> dedupExcludeKeys = Arrays.asList(excludeKeys);
if (!dedupExcludeKeys.isEmpty()) {for (String dedupExcludeKey : dedupExcludeKeys) {paramTreeMap.remove(dedupExcludeKey);
}
}
}
String paramTreeMapJSON = JSON.toJSONString(paramTreeMap);
String md5deDupParam = jdkMD5(paramTreeMapJSON);
log.debug("md5deDupParam = {}, excludeKeys = {} {}", md5deDupParam, Arrays.deepToString(excludeKeys), paramTreeMapJSON);
return md5deDupParam;
}
private static String jdkMD5(String src) {
String res = null;
try {MessageDigest messageDigest = MessageDigest.getInstance("MD5");
byte[] mdBytes = messageDigest.digest(src.getBytes());
res = DatatypeConverter.printHexBinary(mdBytes);
} catch (Exception e) {log.error("",e);
}
return res;
}
}
上面是一些测试日志:
public static void main(String[] args) {
// 两个申请一样,然而申请时间差一秒
String req = "{\n" +
"\"requestTime\":\"20190101120001\",\n" +
"\"requestValue\":\"1000\",\n" +
"\"requestKey\":\"key\"\n" +
"}";
String req2 = "{\n" +
"\"requestTime\":\"20190101120002\",\n" +
"\"requestValue\":\"1000\",\n" +
"\"requestKey\":\"key\"\n" +
"}";
// 全参数比对,所以两个参数 MD5 不同
String dedupMD5 = new ReqDedupHelper().dedupParamMD5(req);
String dedupMD52 = new ReqDedupHelper().dedupParamMD5(req2);
System.out.println("req1MD5 ="+ dedupMD5+", req2MD5="+dedupMD52);
// 去除工夫参数比对,MD5 雷同
String dedupMD53 = new ReqDedupHelper().dedupParamMD5(req,"requestTime");
String dedupMD54 = new ReqDedupHelper().dedupParamMD5(req2,"requestTime");
System.out.println("req1MD5 ="+ dedupMD53+", req2MD5="+dedupMD54);
}
日志输入:
req1MD5 = 9E054D36439EBDD0604C5E65EB5C8267 , req2MD5=A2D20BAC78551C4CA09BEF97FE468A3F req1MD5 = C2A36FED15128E9E878583CAAAFEFDE9 , req2MD5=C2A36FED15128E9E878583CAAAFEFDE9
日志阐明:
- 一开始两个参数因为 requestTime 是不同的,所以求去重参数摘要的时候能够发现两个值是不一样的
- 第二次调用的时候,去除了 requestTime 再求摘要(第二个参数中传入了”requestTime”),则发现两个摘要是一样的,合乎预期。
总结
至此,咱们能够失去残缺的去重解决方案,如下:
String userId= "12345678";// 用户
String method = "pay";// 接口名
String dedupMD5 = new ReqDedupHelper().dedupParamMD5(req,"requestTime");// 计算申请参数摘要,其中剔除外面申请工夫的烦扰
String KEY = "dedup:U=" + userId + "M=" + method + "P=" + dedupMD5;
long expireTime = 1000;// 1000 毫秒过期,1000ms 内的反复申请会认为反复
long expireAt = System.currentTimeMillis() + expireTime;
String val = "expireAt@" + expireAt;
// NOTE: 间接 SETNX 不反对带过期工夫,所以设置 + 过期不是原子操作,极其状况下可能设置了就不过期了,前面雷同申请可能会误以为须要去重,所以这里应用底层 API,保障 SETNX+ 过期工夫是原子操作
Boolean firstSet = stringRedisTemplate.execute((RedisCallback<Boolean>) connection -> connection.set(KEY.getBytes(), val.getBytes(), Expiration.milliseconds(expireTime),
RedisStringCommands.SetOption.SET_IF_ABSENT));
final boolean isConsiderDup;
if (firstSet != null && firstSet) {isConsiderDup = false;} else {isConsiderDup = true;}
最初,大家能够关注下公众号 Java 技术栈,在后盾回复:面试,能够获取我整顿的 Java 系列面试题和答案,十分齐全。
作者:Jaskey Lam,软件工程师 \
出处:https://jaskey.github.io/blog…
近期热文举荐:
1.600+ 道 Java 面试题及答案整顿 (2021 最新版)
2. 终于靠开源我的项目弄到 IntelliJ IDEA 激活码了,真香!
3. 阿里 Mock 工具正式开源,干掉市面上所有 Mock 工具!
4.Spring Cloud 2020.0.0 正式公布,全新颠覆性版本!
5.《Java 开发手册(嵩山版)》最新公布,速速下载!
感觉不错,别忘了顺手点赞 + 转发哦!