在理论的开发我的项目中,一个对外裸露的接口往往会面临很屡次申请,咱们来解释一下幂等的概念:任意屡次执行所产生的影响均与一次执行的影响雷同。依照这个含意,最终的含意就是 对数据库的影响只能是一次性的,不能反复解决。如何保障其幂等性,通常有以下伎俩:
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 基础教程及实战示例:
/**java我的项目 fhadmin.cn
- 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 {
/**java我的项目 fhadmin.cn
* 创立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
* java fhadmin.cn
* @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返回给前端。
/** fhadmin.cn
- 拦截器
*/
@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中,能够看到第一次申请胜利,接着咱们申请第二次:
第二次申请,返回到是重复性操作,可见重复性验证通过,再屡次申请到时候咱们只让其第一次胜利,第二次就是失败:
发表回复