本文介紹一種極簡(jiǎn)潔、靈活通用接口防刷實(shí)現(xiàn)方式、通過在需要防刷的方法加上@Prevent 注解即可實(shí)現(xiàn)短信防刷；
使用方式大致如下：
/**
* 測(cè)試防刷
*
* @param request
* @return
*/
@ResponseBody
@GetMapping(value = "/testPrevent")
@Prevent //加上該注解即可實(shí)現(xiàn)短信防刷(默認(rèn)一分鐘內(nèi)不允許重復(fù)調(diào)用，支持?jǐn)U展、配置）
public Response testPrevent(TestRequest request) {
return Response.success("調(diào)用成功");
}
目錄
- 1、實(shí)現(xiàn)防刷切面PreventAop.java
- 2、使用防刷切面
- 3、演示
1、實(shí)現(xiàn)防刷切面PreventAop.java
大致邏輯為：定義一切面，通過@Prevent注解作為切入點(diǎn)、在該切面的前置通知獲取該方法的所有入?yún)⒉⑵銪ase64編碼，將入?yún)ase64編碼+完整方法名作為redis的key，入?yún)⒆鳛閞eids的value，@Prevent的value作為redis的expire，存入redis；每次進(jìn)來這個(gè)切面根據(jù)入?yún)ase64編碼+完整方法名判斷redis值是否存在，存在則攔截防刷，不存在則允許調(diào)用；
1.1 定義注解Prevent
package com.zetting.aop;
import java.lang.annotation.*;
/**
* 接口防刷注解
* 使用：
* 在相應(yīng)需要防刷的方法上加上
* 該注解，即可
*
* @author: zetting
* @date:2018/12/29
*/
@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Prevent {
/**
* 限制的時(shí)間值（秒）
*
* @return
*/
String value() default "60";
/**
* 提示
*/
String message() default "";
/**
* 策略
*
* @return
*/
PreventStrategy strategy() default PreventStrategy.DEFAULT;
}
1.2 實(shí)現(xiàn)防刷切面PreventAop
package com.zetting.aop;
import com.alibaba.fastjson.JSON;
import com.zetting.common.BusinessException;
import com.zetting.util.RedisUtil;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import java.lang.reflect.Method;
import java.util.Base64;
/**
* 防刷切面實(shí)現(xiàn)類
*
* @author: zetting
* @date: 2018/12/29 20:27
*/
@Aspect
@Component
public class PreventAop {
private static Logger log = LoggerFactory.getLogger(PreventAop.class);
@Autowired
private RedisUtil redisUtil;
/**
* 切入點(diǎn)
*/
@Pointcut("@annotation(com.zetting.aop.Prevent)")
public void pointcut() {
}
/**
* 處理前
*
* @return
*/
@Before("pointcut()")
public void joinPoint(JoinPoint joinPoint) throws Exception {
String requestStr = JSON.toJSONString(joinPoint.getArgs()[0]);
if (StringUtils.isEmpty(requestStr) || requestStr.equalsIgnoreCase("{}")) {
throw new BusinessException("[防刷]入?yún)⒉辉试S為空");
}
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
Method method = joinPoint.getTarget().getClass().getMethod(methodSignature.getName(),
methodSignature.getParameterTypes());
Prevent preventAnnotation = method.getAnnotation(Prevent.class);
String methodFullName = method.getDeclaringClass().getName() + method.getName();
entrance(preventAnnotation, requestStr,methodFullName);
return;
}
/**
* 入口
*
* @param prevent
* @param requestStr
*/
private void entrance(Prevent prevent, String requestStr,String methodFullName) throws Exception {
PreventStrategy strategy = prevent.strategy();
switch (strategy) {
case DEFAULT:
defaultHandle(requestStr, prevent,methodFullName);
break;
default:
throw new BusinessException("無效的策略");
}
}
/**
* 默認(rèn)處理方式
*
* @param requestStr
* @param prevent
*/
private void defaultHandle(String requestStr, Prevent prevent,String methodFullName) throws Exception {
String base64Str = toBase64String(requestStr);
long expire = Long.parseLong(prevent.value());
String resp = redisUtil.get(methodFullName+base64Str);
if (StringUtils.isEmpty(resp)) {
redisUtil.set(methodFullName+base64Str, requestStr, expire);
} else {
String message = !StringUtils.isEmpty(prevent.message()) ? prevent.message() :
expire + "秒內(nèi)不允許重復(fù)請(qǐng)求";
throw new BusinessException(message);
}
}
/**
* 對(duì)象轉(zhuǎn)換為base64字符串
*
* @param obj 對(duì)象值
* @return base64字符串
*/
private String toBase64String(String obj) throws Exception {
if (StringUtils.isEmpty(obj)) {
return null;
}
Base64.Encoder encoder = Base64.getEncoder();
byte[] bytes = obj.getBytes("UTF-8");
return encoder.encodeToString(bytes);
}
}
注：
以上只展示核心代碼、其他次要代碼（例如redis配置、redis工具類等）可下載源碼查閱
2、使用防刷切面
在MyController 使用防刷
package com.zetting.modules.controller;
import com.zetting.aop.Prevent;
import com.zetting.common.Response;
import com.zetting.modules.dto.TestRequest;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
/**
* 切面實(shí)現(xiàn)入?yún)⑿ｒ?yàn)
*/
@RestController
public class MyController {
/**
* 測(cè)試防刷
*
* @param request
* @return
*/
@ResponseBody
@GetMapping(value = "/testPrevent")
@Prevent
public Response testPrevent(TestRequest request) {
return Response.success("調(diào)用成功");
}
/**
* 測(cè)試防刷
*
* @param request
* @return
*/
@ResponseBody
@GetMapping(value = "/testPreventIncludeMessage")
@Prevent(message = "10秒內(nèi)不允許重復(fù)調(diào)多次", value = "10")//value 表示10表示10秒
public Response testPreventIncludeMessage(TestRequest request) {
return Response.success("調(diào)用成功");
}
}
3、演示
GIF.gif
gitee 源碼：https://gitee.com/Zetting/my-gather/tree/master/springboot-aop-prevent
推薦閱讀：
- 【Springboot之切面編程】注解實(shí)現(xiàn)敏感字段加解密
- 【Springboot之搜索日志妙招】在日志上打印請(qǐng)求唯一log標(biāo)識(shí)
- 【Springboot之切面編程】通過切面AOP實(shí)現(xiàn)入?yún)⑿ｒ?yàn)
- 【Springboot之切面編程】自定義注解實(shí)現(xiàn)入?yún)⒅付杜e值校驗(yàn)
