历史推荐
你写得API接口代码真是一坨"屎"，难道不能对返回格式统一处理一下吗？
瞬间几千次的重复提交，我用 SpringBoot+Redis 扛住了
点击“开发者技术前线”，选择“星标????”
html
在看|星标|留言, 真爱前端
做者 | 慕容千语web
来源 | http://suo.im/5PaEZI面试
在实际的开发项目中，一个对外暴露的接口每每会面临，瞬间大量的重复的请求提交，若是想过滤掉重复请求形成对业务的伤害，那就须要实现幂等！redis
咱们来解释一下幂等的概念：
任意屡次执行所产生的影响均与一次执行的影响相同。按照这个含义，最终的含义就是 对数据库的影响只能是一次性的，不能重复处理。算法
如何保证其幂等性，一般有如下手段：spring
一、数据库创建惟一性索引，能够保证最终插入数据库的只有一条数据
二、token机制，每次接口请求前先获取一个token，而后再下次请求的时候在请求的header体中加上这个token，后台进行验证，若是验证经过删除token，下次请求再次判断token
三、悲观锁或者乐观锁，悲观锁能够保证每次for update的时候其余sql没法update数据(在数据库引擎是innodb的时候,select的条件必须是惟一索引,防止锁全表)
四、先查询后判断，首先经过查询数据库是否存在数据，若是存在证实已经请求过了，直接拒绝该请求，若是没有存在，就证实是第一次进来，直接放行。sql
redis实现自动幂等的原理图：数据库
1、搭建redis的服务Api
一、首先是搭建redis服务器。json
二、引入springboot中到的redis的stater，或者Spring封装的jedis也能够，后面主要用到的api就是它的set方法和exists方法,这里咱们使用springboot的封装好的redisTemplate
/**
* redis工具类
*/
@Component
publicclassRedisService{
@Autowired
privateRedisTemplate redisTemplate;
/**
* 写入缓存
* @param key
* @param value
* @return
*/
publicbooleanset(finalString key, Object value) {
boolean result = false;
try{
ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
operations.set(key, value);
result = true;
} catch(Exception e) {
e.printStackTrace();
}
return result;
}
/**
* 写入缓存设置时效时间
* @param key
* @param value
* @return
*/
publicboolean setEx(finalString key, Object value, Long expireTime) {
boolean result = false;
try{
ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
operations.set(key, value);
redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);
result = true;
} catch(Exception e) {
e.printStackTrace();
}
return result;
}
/**
* 判断缓存中是否有对应的value
* @param key
* @return
*/
publicboolean exists(finalString key) {
return redisTemplate.hasKey(key);
}
/**
* 读取缓存
* @param key
* @return
*/
publicObjectget(finalString key) {
Object result = null;
ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
result = operations.get(key);
return result;
}
/**
* 删除对应的value
* @param key
*/
publicboolean remove(finalString key) {
if(exists(key)) {
Booleandelete= redisTemplate.delete(key);
returndelete;
}
returnfalse;
}
}
2、自定义注解AutoIdempotent
自定义一个注解，定义此注解的主要目的是把它添加在须要实现幂等的方法上，凡是某个方法注解了它，都会实现自动幂等。后台利用反射若是扫描到这个注解，就会处理这个方法实现自动幂等，使用元注解ElementType.METHOD表示它只能放在方法上，etentionPolicy.RUNTIME表示它在运行时。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public@interfaceAutoIdempotent{
}
3、token建立和检验
一、token服务接口
咱们新建一个接口，建立token服务，里面主要是两个方法，一个用来建立token，一个用来验证token。建立token主要产生的是一个字符串，检验token的话主要是传达request对象，为何要传request对象呢？主要做用就是获取header里面的token,而后检验，经过抛出的Exception来获取具体的报错信息返回给前端。
publicinterfaceTokenService{
/**
* 建立token
* @return
*/
public String createToken();
/**
* 检验token
* @param request
* @return
*/
publicboolean checkToken(HttpServletRequest request) throwsException;
}
二、token的服务实现类
token引用了redis服务，建立token采用随机算法工具类生成随机uuid字符串,而后放入到redis中(为了防止数据的冗余保留,这里设置过时时间为10000秒,具体可视业务而定)，若是放入成功，最后返回这个token值。checkToken方法就是从header中获取token到值(若是header中拿不到，就从paramter中获取)，如若不存在,直接抛出异常。这个异常信息能够被拦截器捕捉到，而后返回给前端。
@Service
publicclassTokenServiceImplimplementsTokenService{
@Autowired
privateRedisService redisService;
/**
* 建立token
*
* @return
*/
@Override
publicString createToken() {
String str = RandomUtil.randomUUID();
StrBuilder token = newStrBuilder();
try{
token.append(Constant.Redis.TOKEN_PREFIX).append(str);
redisService.setEx(token.toString(), token.toString(),10000L);
boolean notEmpty = StrUtil.isNotEmpty(token.toString());
if(notEmpty) {
return token.toString();
}
}catch(Exception ex){
ex.printStackTrace();
}
returnnull;
}
/**
* 检验token
*
* @param request
* @return
*/
@Override
publicboolean checkToken(HttpServletRequest request) throwsException{
String token = request.getHeader(Constant.TOKEN_NAME);
if(StrUtil.isBlank(token)) {// header中不存在token
token = request.getParameter(Constant.TOKEN_NAME);
if(StrUtil.isBlank(token)) {// parameter中也不存在token
thrownewServiceException(Constant.ResponseCode.ILLEGAL_ARGUMENT, 100);
}
}
if(!redisService.exists(token)) {
thrownewServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
}
boolean remove = redisService.remove(token);
if(!remove) {
thrownewServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
}
returntrue;
}
}
4、拦截器的配置
一、web配置类，实现WebMvcConfigurerAdapter，主要做用就是添加autoIdempotentInterceptor到配置类中，这样咱们到拦截器才能生效，注意使用@Configuration注解，这样在容器启动是时候就能够添加进入context中。
@Configuration
publicclassWebConfigurationextendsWebMvcConfigurerAdapter{
@Resource
privateAutoIdempotentInterceptor autoIdempotentInterceptor;
/**
* 添加拦截器
* @param registry
*/
@Override
publicvoid addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(autoIdempotentInterceptor);
super.addInterceptors(registry);
}
}
二、拦截处理器：主要的功能是拦截扫描到AutoIdempotent到注解到方法,而后调用tokenService的checkToken()方法校验token是否正确，若是捕捉到异常就将异常信息渲染成json返回给前端
/**
* 拦截器
*/
@Component
publicclassAutoIdempotentInterceptorimplementsHandlerInterceptor{
@Autowired
privateTokenService tokenService;
/**
* 预处理
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
@Override
publicboolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throwsException{
if(!(handler instanceofHandlerMethod)) {
returntrue;
}
HandlerMethod handlerMethod = (HandlerMethod) handler;
Method method = handlerMethod.getMethod();
//被ApiIdempotment标记的扫描
AutoIdempotent methodAnnotation = method.getAnnotation(AutoIdempotent.class);
if(methodAnnotation != null) {
try{
return tokenService.checkToken(request);// 幂等性校验, 校验经过则放行, 校验失败则抛出异常, 并经过统一异常处理返回友好提示
}catch(Exception ex){
ResultVo failedResult = ResultVo.getFailedResult(101, ex.getMessage());
writeReturnJson(response, JSONUtil.toJsonStr(failedResult));
throw ex;
}
}
//必须返回true,不然会被拦截一切请求
returntrue;
}
@Override
publicvoid postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throwsException{
}
@Override
publicvoid afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throwsException{
}
/**
* 返回的json值
* @param response
* @param json
* @throws Exception
*/
privatevoid writeReturnJson(HttpServletResponse response, String json) throwsException{
PrintWriter writer = null;
response.setCharacterEncoding("UTF-8");
response.setContentType("text/html; charset=utf-8");
try{
writer = response.getWriter();
writer.print(json);
} catch(IOException e) {
} finally{
if(writer != null)
writer.close();
}
}
}
5、测试用例
一、模拟业务请求类
首先咱们须要经过/get/token路径经过getToken()方法去获取具体的token，而后咱们调用testIdempotence方法，这个方法上面注解了@AutoIdempotent，拦截器会拦截全部的请求，当判断处处理的方法上面有该注解的时候，就会调用TokenService中的checkToken()方法，若是捕获到异常会将异常抛出调用者，下面咱们来模拟请求一下：
@RestController
publicclassBusinessController{
@Resource
privateTokenService tokenService;
@Resource
privateTestService testService;
@PostMapping("/get/token")
publicString getToken(){
String token = tokenService.createToken();
if(StrUtil.isNotEmpty(token)) {
ResultVo resultVo = newResultVo();
resultVo.setCode(Constant.code_success);
resultVo.setMessage(Constant.SUCCESS);
resultVo.setData(token);
returnJSONUtil.toJsonStr(resultVo);
}
returnStrUtil.EMPTY;
}
@AutoIdempotent
@PostMapping("/test/Idempotence")
publicString testIdempotence() {
String businessResult = testService.testIdempotence();
if(StrUtil.isNotEmpty(businessResult)) {
ResultVo successResult = ResultVo.getSuccessResult(businessResult);
returnJSONUtil.toJsonStr(successResult);
}
returnStrUtil.EMPTY;
}
}
二、使用postman请求
首先访问get/token路径获取到具体到token：
利用获取到到token,而后放到具体请求到header中,能够看到第一次请求成功，接着咱们请求第二次：
第二次请求，返回到是重复性操做，可见重复性验证经过，再屡次请求到时候咱们只让其第一次成功，第二次就是失败：
6、总结
本篇博客介绍了使用springboot和拦截器、redis来优雅的实现接口幂等，对于幂等在实际的开发过程当中是十分重要的，由于一个接口可能会被无数的客户端调用，如何保证其不影响后台的业务处理，如何保证其只影响数据一次是很是重要的，它能够防止产生脏数据或者乱数据，也能够减小并发量，实乃十分有益的一件事。而传统的作法是每次判断数据，这种作法不够智能化和自动化，比较麻烦。而今天的这种自动化处理也能够提高程序的伸缩性。主题配置请看：我把 SpringBoot 的banner换成了美女，老板说工做不饱和，建议安排加班
福利时间：
前线推出学习交流必定要备注：研究/工做方向+地点+学校/公司+昵称（如目标检测+上海+上交+卡卡），根据格式备注，可更快被经过且邀请进群
扫码加我微信和大佬们零距离
在这里，我为你们准备了一份2020年最新最全的《Java面试题及答案V3.0》，这套电子书涵盖了诸多后端技术栈的面试题和答案，相信能够帮助你们在最短的时间内复习Java后端的大多数面试题，从而拿到本身心仪的offer。
截了张图，你们能够仔细查看左边的菜单栏，覆盖的知识面真的很广，并且质量都很不错。
资料获取方法
扫描下方二维码
后台回复关键词：Java核心整理
END
好文点个在看吧！