一、引言
在项目开发中,一般会出现前端在短时间内进行重复提交的问题,导致数据重复。同一条数据在数据库是两条记录,这样如果不是通过唯一键进行查询的数据会出现两条相同的数据。
因此在插入数据的时候防止数据的重复是非常重要的,通过防止重复点击可以减少数据的冗余,而且能够有效防止在获取数据的时候报错。
二、实现方案
通过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: 1229703575@qq.com
* @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