共计 7288 个字符，预计需要花费 19 分钟才能阅读完成。
作者|慕容千语 \
起源：https://www.jianshu.com/p/c80…
前言
在理论的开发我的项目中, 一个对外裸露的接口往往会面临很屡次申请，咱们来解释一下幂等的概念： 任意屡次执行所产生的影响均与一次执行的影响雷同 。依照这个含意，最终的含意就是 对数据库的影响只能是一次性的，不能反复解决。如何保障其幂等性，通常有以下伎俩：
1、数据库建设唯一性索引，能够保障最终插入数据库的只有一条数据。
2、token 机制，每次接口申请前先获取一个 token，而后再下次申请的时候在申请的 header 体中加上这个 token，后盾进行验证，如果验证通过删除 token，下次申请再次判断 token。
3、乐观锁或者乐观锁，乐观锁能够保障每次 for update 的时候其余 sql 无奈 update 数据 (在数据库引擎是 innodb 的时候,select 的条件必须是惟一索引, 避免锁全表)
4、先查问后判断，首先通过查询数据库是否存在数据，如果存在证实曾经申请过了，间接回绝该申请，如果没有存在，就证实是第一次进来，间接放行。
redis 实现主动幂等的原理图：
搭建 Redis 服务 API
1、首先是搭建 redis 服务器。
2、引入 springboot 中到的 redis 的 stater，或者 Spring 封装的 jedis 也能够，前面次要用到的 api 就是它的 set 办法和 exists 办法, 这里咱们应用 springboot 的封装好的 redisTemplate。
举荐一个 Spring Boot 基础教程及实战示例：
https://github.com/javastacks…
/**
* redis 工具类
*/
@Component
public class RedisService {
@Autowired
private RedisTemplate redisTemplate;
/**
* 写入缓存
* @param key
* @param value
* @return
*/
public boolean set(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
*/
public boolean 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
*/
public boolean exists(finalString key) {return redisTemplate.hasKey(key);
}
/**
* 读取缓存
* @param key
* @return
*/
public Objectget(finalString key) {
Object result = null;
ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
result = operations.get(key);
return result;
}
/**
* 删除对应的 value
* @param key
*/
public boolean remove(finalString key) {if (exists(key)) {Boolean delete = redisTemplate.delete(key);
return delete;
}
returnfalse;
}
}自定义注解 AutoIdempotent
自定义一个注解，定义此注解的次要目标是把它增加在须要实现幂等的办法上，但凡某个办法注解了它，都会实现主动幂等。后盾利用反射如果扫描到这个注解，就会解决这个办法实现主动幂等，应用元注解 ElementType.METHOD 示意它只能放在办法上，etentionPolicy.RUNTIME 示意它在运行时。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface AutoIdempotent {}token 创立和测验
token 服务接口：咱们新建一个接口，创立 token 服务，外面次要是两个办法，一个用来创立 token，一个用来验证 token。创立 token 次要产生的是一个字符串，测验 token 的话次要是传播 request 对象，为什么要传 request 对象呢？次要作用就是获取 header 外面的 token, 而后测验，通过抛出的 Exception 来获取具体的报错信息返回给前端。
publicinterface TokenService {
/**
* 创立 token
* @return
*/
public String createToken();
/**
* 测验 token
* @param request
* @return
*/
public boolean checkToken(HttpServletRequest request) throws Exception;
}token 的服务实现类：token 援用了 redis 服务，创立 token 采纳随机算法工具类生成随机 uuid 字符串, 而后放入到 redis 中 (为了避免数据的冗余保留, 这里设置过期工夫为 10000 秒, 具体可视业务而定)，如果放入胜利，最初返回这个 token 值。checkToken 办法就是从 header 中获取 token 到值 (如果 header 中拿不到，就从 paramter 中获取)，如若不存在, 间接抛出异样。这个异样信息能够被拦截器捕捉到，而后返回给前端。
@Service
publicclass TokenServiceImpl implements TokenService {
@Autowired
private RedisService redisService;
/**
* 创立 token
*
* @return
*/
@Override
public String createToken() {String str = RandomUtil.randomUUID();
StrBuilder token = new StrBuilder();
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
public boolean checkToken(HttpServletRequest request) throws Exception {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
thrownew ServiceException(Constant.ResponseCode.ILLEGAL_ARGUMENT, 100);
}
}
if (!redisService.exists(token)) {thrownew ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
}
boolean remove = redisService.remove(token);
if (!remove) {thrownew ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
}
returntrue;
}
}拦截器的配置
web 配置类，实现 WebMvcConfigurerAdapter，次要作用就是增加 autoIdempotentInterceptor 到配置类中，这样咱们到拦截器能力失效，留神应用 @Configuration 注解，这样在容器启动是时候就能够增加进入 context 中。
@Configuration
publicclass WebConfiguration extends WebMvcConfigurerAdapter {
@Resource
private AutoIdempotentInterceptor autoIdempotentInterceptor;
/**
* 增加拦截器
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(autoIdempotentInterceptor);
super.addInterceptors(registry);
}
}拦挡处理器：次要的性能是拦挡扫描到 AutoIdempotent 到注解到办法, 而后调用 tokenService 的 checkToken() 办法校验 token 是否正确，如果捕捉到异样就将异样信息渲染成 json 返回给前端。
/**
* 拦截器
*/
@Component
publicclass AutoIdempotentInterceptor implements HandlerInterceptor {
@Autowired
private TokenService tokenService;
/**
* 预处理
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {if (!(handler instanceof HandlerMethod)) {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
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { }
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { }
/**
* 返回的 json 值
* @param response
* @param json
* @throws Exception
*/
private void writeReturnJson(HttpServletResponse response, String json) throws Exception{
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();}
}
}测试用例
模仿业务申请类，首先咱们须要通过 /get/token 门路通过 getToken() 办法去获取具体的 token，而后咱们调用 testIdempotence 办法，这个办法下面注解了 @AutoIdempotent，拦截器会拦挡所有的申请，当判断到解决的办法下面有该注解的时候，就会调用 TokenService 中的 checkToken() 办法，如果捕捉到异样会将异样抛出调用者，上面咱们来模仿申请一下：
@RestController
publicclass BusinessController {
@Resource
private TokenService tokenService;
@Resource
private TestService testService;
@PostMapping("/get/token")
public String getToken(){String token = tokenService.createToken();
if (StrUtil.isNotEmpty(token)) {ResultVo resultVo = new ResultVo();
resultVo.setCode(Constant.code_success);
resultVo.setMessage(Constant.SUCCESS);
resultVo.setData(token);
return JSONUtil.toJsonStr(resultVo);
}
return StrUtil.EMPTY;
}
@AutoIdempotent
@PostMapping("/test/Idempotence")
public String testIdempotence() {String businessResult = testService.testIdempotence();
if (StrUtil.isNotEmpty(businessResult)) {ResultVo successResult = ResultVo.getSuccessResult(businessResult);
return JSONUtil.toJsonStr(successResult);
}
return StrUtil.EMPTY;
}
}应用 postman 申请，首先拜访 get/token 门路获取到具体到 token：
利用获取到到 token, 而后放到具体申请到 header 中, 能够看到第一次申请胜利，接着咱们申请第二次：
第二次申请，返回到是重复性操作，可见重复性验证通过，再屡次申请到时候咱们只让其第一次胜利，第二次就是失败：
总结
本篇博客介绍了应用 springboot 和拦截器、redis 来优雅的实现接口幂等，对于幂等在理论的开发过程中是非常重要的，因为一个接口可能会被有数的客户端调用，如何保障其不影响后盾的业务解决，如何保障其只影响数据一次是十分重要的，它能够避免产生脏数据或者乱数据，也能够缩小并发量，实乃非常无益的一件事。而传统的做法是每次判断数据，这种做法不够智能化和自动化，比拟麻烦。而明天的这种自动化解决也能够晋升程序的伸缩性。
近期热文举荐：
1.1,000+ 道 Java 面试题及答案整顿 (2021 最新版)
2. 别在再满屏的 if/ else 了，试试策略模式，真香！！
3. 卧槽！Java 中的 xx ≠ null 是什么新语法？
4.Spring Boot 2.6 正式公布，一大波新个性。。
5.《Java 开发手册（嵩山版）》最新公布，速速下载！
感觉不错，别忘了顺手点赞 + 转发哦！
