一、引言
在項目開發中，一般會出現前端在短時間內進行重複提交的問題，導致數據重複。同一條數據在數據庫是兩條記錄，這樣如果不是通過唯一鍵進行查詢的數據會出現兩條相同的數據。
因此在插入數據的時候防止數據的重複是非常重要的，通過防止重複點擊可以減少數據的冗餘，而且能夠有效防止在獲取數據的時候報錯。
二、實現方案
通過AOP自定義註解的方式來實現。具體流程見圖：
- 建立一張帶唯一鍵
md5_string的表，將訪問的數據使用MD5加密，並將相關字段以及md5加密後的字段存放到表中。 - 利用數據庫的唯一鍵不允許重複數據的性質，在插入數據的時候進行捕捉異常，這樣就不會再次插入相同的md5字符串。
- 利用AOP，在執行插入之前先進行判斷相關數據在md5加密後是否重複，只有在不重複的情況下才進行數據的插入。
- 在插入數據的時候，添加時間戳去進行加密判斷，可以控制在特定的時間內進行數據插入。
三、具體實現
1. 建立表結構
將請求數據轉化爲字符串存入數據庫，並且存放相應要加密的字段：ip地址，token訪問者，url訪問路徑以及create_time訪問時間，這裏的md_string設置爲唯一鍵。
SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;
-- ----------------------------
-- Table structure for sys_repeat
-- ----------------------------
DROP TABLE IF EXISTS `sys_repeat`;
CREATE TABLE `sys_repeat` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`name` text CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL COMMENT '名稱',
`create_ip` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL DEFAULT NULL COMMENT '創建者IP',
`md_string` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'md5加密字符串（判斷重複）',
`token` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL DEFAULT NULL COMMENT '用戶token',
`url` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL DEFAULT '0' COMMENT '請求url',
`create_time` datetime(0) NULL DEFAULT NULL COMMENT '創建時間',
`update_time` datetime(0) NULL DEFAULT NULL COMMENT '更新時間',
`create_user` bigint(20) NULL DEFAULT NULL COMMENT '創建者',
`update_user` bigint(20) NULL DEFAULT NULL COMMENT '更新者',
PRIMARY KEY (`id`) USING BTREE,
UNIQUE INDEX `md_string`(`md_string`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 241 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci COMMENT = '防重複提交表' ROW_FORMAT = Dynamic;
SET FOREIGN_KEY_CHECKS = 1;
2. 代碼實現
/**
* @author: lxw
* @Date: 2019/4/21 16:30
* @email:
* @Description: 防重複時間枚舉
*/
public enum DateEnum {
//這邊主要是做分鐘級別的控制以及秒級別的控制
seconds("yyyy-MM-dd HH:mm:ss"), minutes("yyyy-MM-dd HH:mm");
private String value;
DateEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
}
/**
* @author: lxw
* @Date: 2019/4/21 16:30
* @email:
* @Description: 防止重複提交自定義註解
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NoRepeat {
//這邊是默認秒級別的控制
DateEnum value() default DateEnum.seconds;
}
/**
* @author: lxw
* @Date: 2019/4/21 16:30
* @email:
* @Description: 自定義註解的處理
*/
@Component
@Slf4j
@Aspect
public class NoRepeatAspect {
@Autowired
private RepeatService repeatService;
@Pointcut("@within(com.modules.common.annotation.NoRepeat) || @annotation(com.modules.common.annotation.NoRepeat)")
public void noRepeatCut() {
}
/**
* 判斷是否已經進行提交，沒有就進行插入數據，有就進行判斷並且直接返回
*/
@Before("noRepeatCut() && @annotation(noRepeat)")
public void noRepeat(JoinPoint point, NoRepeat noRepeat) {
String formatStr = noRepeat.value().getValue();
//獲取request
HttpServletRequest request = HttpUtils.getHttpServletRequest();
//獲取IP地址
String ipAddr = HttpUtils.getIpAddr(request);
String url = request.getServletPath();
RepeatEntity repeatEntity = new RepeatEntity();
//獲取參數並轉化爲json字符串
Object params = point.getArgs()[0];
if (params != null) {
String names = JSONUtil.getJSONString(params);
repeatEntity.setName(names);
}
repeatEntity.setToken(request.getHeader("token") == null ? "" : request.getHeader("token"));
//這邊的token主要是通過頭文件進行獲取，一般是當前用戶的標識符
String dataStr = MD5.getMessageDigest(ipAddr + url + repeatEntity.getName() + repeatEntity.getToken() + DateUtils.format(new Date(), formatStr));
repeatEntity.setCreateIp(ipAddr);
repeatEntity.setUrl(url);
repeatEntity.setCreateTime(new Date());
repeatEntity.setUpdateTime(new Date());
repeatEntity.setMdString(dataStr);
try {
repeatService.save(repeatEntity);
} catch (Exception e) {
throw new ExceptionUtils(989, "");
}
}
}
3. 相關工具類
- MD5加密工具類
/**
* @author: lxw
* @Date: 2019/4/19 11:19
* @email:
* @Description: MD5工具類
*/
public class MD5 {
/**
* 生成 MD5
*
* @param data 待處理數據
* @return MD5結果
*/
public static String getMessageDigest(String data) {
StringBuilder sb = new StringBuilder();
try {
MessageDigest md = MessageDigest.getInstance("MD5");
byte[] array = md.digest(data.getBytes("UTF-8"));
for (byte item : array) {
sb.append(Integer.toHexString((item & 0xFF) | 0x100).substring(1, 3));
}
} catch (Exception e) {
return null;
}
return sb.toString().toUpperCase();
}
}
- json工具類
package com.modules.common.utils;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.io.InputStream;
/**
* @author: lxw
* @Date: 2019/4/19 11:19
* @email:
* @Description: json工具類
*/
public class JSONUtil {
private final static ObjectMapper objectMapper = new ObjectMapper();
/**
* 獲取json字符串
*/
public static String getJSONString(Object o) {
if (o == null) {
return "";
}
try {
return objectMapper.writeValueAsString(o);
} catch (JsonProcessingException e) {
return "";
}
}
}
- 時間工具類
/**
* @author: lxw
* @Date: 2018/12/25 14:36
* @email: [email protected]
* @Description: 時間工具類
*/
public class DateUtils {
/**
* 常用時間格式
*/
public final static String DATE_TIME_PATTERN = "yyyy-MM-dd HH:mm:ss";
public final static String DATE_TIME_PATTERN_SSS = "yyyy-MM-dd HH:mm:ss.SSS";
public final static String DATE_PATTERN_YYYY_MM_DD_HH_MM = "yyyy-MM-dd HH:mm";
/**
* 日期轉換爲String類型
*
* @param date 日期
* @param pattern 獲取格式
* @return String
*/
public static String format(Date date, String pattern) {
if (date != null) {
SimpleDateFormat df = new SimpleDateFormat(pattern);
return df.format(date);
}
return null;
}
四、使用方式
在插入數據的方法上進行添加註解@NoRepeat，如果沒有帶後面的枚舉字符串表示默認爲秒級，表示禁止一秒內進行重複點擊。過了一秒後數據還是會插入相應的數據，因爲md5加密後的字符串是不一樣的。如果要使用一分鐘內限制重複插入，可以使用@NoRepeat(DateEnum.minutes)。具體結果需要去嘗試一下。
GitHub地址： https://github.com/HardProgrammer/springbootRoad.git