微服务下接口幂等性的思考

概念:

一次和多次请求某一个资源,对资源本身所产生的的影响均与一次执行的影响相同; 需要考虑到幂等的场景就是新增和更新,对于查询,删除的操作执行一次和执行多次不影响最终结果集所以Select, delete 天生就是幂等的

常见解决方案

1:分布式锁保证幂等

1.1 场景:秒杀,抢票

在秒杀情况下同一个用户只能抢购一件商品,在买票的情况下同一个用户,同一个班次的火车票也能买一张;如果此时用户是写的脚本程序或者网络抖动发生重试,执行了多次request 则会导致一个用户抢购多个商品或者出票重复

1.2 解决方案:redis 锁

用户ID + 火车班次号 生成一个唯一key 存储到redis中使用setnx / rédission 保证某一段时间内的数据唯一性

1.3 DEMO 代码

redis设置全局锁代码

 public ResponseCode setLockAndExecute(String key, String value, long timeOut, TimeUnit time, Supplier<ResponseCode> execute) {
   boolean lock = false;
   try {
     lock = stringRedisTemplate.opsForValue().setIfAbsent(key, value, timeOut, time);
     if (lock) {
       log.info(“重复请求:{}”, key);
       return execute.get();
     }
     //加锁失败
     log.info("重复请求:{}", key);
     return ResponseCode.REPEAT_ERROR;
   } catch (Exception ex) {
     log.error("Redis加锁异常", ex);
     return ResponseCode.UNKNOWN_ERROR;
   } finally {
     if (lock) {
       log.info("任务执行完成:删除锁:{}",key);
       this.del(key);
     }
   }
}

需要做幂等的业务方法

return setLockAndExecute(userId+productId, 1, 1, TimeUnit.HOURS, () -> {
   User user = userService.getUserById(userId);
   if (ObjectUtils.isEmpty(user)) {
     log.info(“不存在该用户:{}”, userid);
     return ResponseCode.USER_NOT_FIND;
   }
   Product product = productService.getProductById(productId);
   if (ObjectUtils.isEmpty(product)) {
       log.info(“不存在该商品:{}”, productid);
       return ResponseCode.PRODUCT_NOT_FIND;
   }
   String orderId = orderService.insertNewOrder(user, product);
   if (StringUtils.hasLength(orderId)) {
       log.info(“订单生成成功:{}”, orderId);
       return ResponseCode.SUCCESS;
   }
   log.info("订单生成失败);
   return ResponseCode.FAIL;
});

2:token保证幂等

2.1 场景:用户注册,创建子部门

当有创建新数据的时候因为都是新数据没有ID,当用户点击多次提交会导致创建重复数据到DB中

2.2 解决方案:在正式请求前做一次获取令牌的预请求

当点击新增,或者注册的时候先请求一次后端接口后端接口生成一个token保存到redis中(setnx)同时返回给前端请求,等前端填写完注册信息并提交保存的时候携带上上次返回的token, 后端收到请求后获取token并且判断redis中是否存在,如果存在从redis中删除然后保存数据库,如果不存在返回错误信息给前端

2.3 DEMO 代码:

创建注册用户的幂等拦截注解,以后对于需要幂等的方法只需要在方法上添加该注解即可

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RegisterRestriction {
    boolean value() default true;
}

在注册用户的controller 上添加幂等判断注解

@PostMapping(“/register")
@RegisterRestriction
public ResponseData registerUser(@RequestHeader(value = "Authorization") String token, HttpServletResponse response) {
    return userService.registerUser(token, response);
}

生成正式请求的令牌代码

Public ResponseCode generateUniqueKey(String userId) {
   User user = userService.getUserById(userId);
   if (ObjectUtils.isEmpty(user)) {
     log.info(“不存在该用户:{}”, userid);
     return ResponseCode.USER_NOT_FIND;
   }
  //生成唯一key 给response
  String uniqueKey = String.*format*("%s%s", Instant.*now*().toEpochMilli(), userId);
  stringRedisTemplate.opsForValue().set(uniqueKey, uniqueKey, 5 * 60, TimeUnit.SECONDS);
  response.setHeader(CommonConst.*REGISTER_REQUEST_ID*, uniqueKey);
  // 成功更新,返回
  return ResponseCode.SUCCESS;
}

幂等拦截器代码

@Slf4j
public class RegisterInterceptor implements HandlerInterceptor {

    @Autowired
    private RedisUtils redisUtils;

    private boolean checkRequestId(HttpServletRequest request, HttpServletResponse response) throws InterceptorException {
        String requestId = request.getHeader("X-Request-Id");
        if (!StringUtils.hasLength(requestId)) {
            log.info("header中未获取到预先生成的注册令牌,请求非法");
            throw new InterceptorException(40012, "header中未获取到预先生成的注册令牌,请求非法");
        }
        //判断redis中是否存在requestId, 如果存在 -> return true
        //如果不存在(可能是前端造的假ID-> return false)
        if (redisUtils.exists(requestId)) {
            //删除
            if (redisUtils.del(requestId)) {
                return true;
            }

            log.info("请勿重复请求");
            throw new InterceptorException(ResponseCode.REPEAT_ERROR);
        }

        log.info("redis 中未获取到预先生成的注册令牌,请求非法");
        throw new InterceptorException(ResponseCode.REPEAT_ERROR);
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod)handler;
            Method method = handlerMethod.getMethod();
            if (!ObjectUtils.isEmpty(method) && method.isAnnotationPresent(RegisterRestriction.class)) {
                if (method.getAnnotation(RegisterRestriction.class).value()) {
                    return checkRequestId(request, response);
                }
            }
        }

        return true;
    }
}

3:mysql unique key 保证幂等

3.1 解决方案:

通过对mysql 表创建唯一key来达到幂等性,比如用户注册手机号设置唯一key 当发生重复请求后mysql判重拒绝写入db,
创建子部门,可以创建parent_id + 部门名称做唯一key 来保证幂等性

3.3 DEMO 代码:

ALTER TABLE tb_department ADD CONSTRAINT department_info_UN UNIQUE KEY (parent_id,department_name);

4:乐观锁保证幂等

4.1 场景:

当涉及到自增,自减更新的时候需要考虑幂等性问题,因为普通的更新就是给字段赋值执行一次和执行多次效果都是一样的,比如:更新用户名称,更新数据状态
Update user set name= ‘张三’ where id = ‘zhangsan’
Update user set status=‘1’ where id = ‘zhansan’

4.2 解决方案:乐观锁

对于自增自减类的update,比如:update goods set count=count -1 where id = ‘123’ 就需要做幂等处理因为执行多次就会自减多次,使用乐观锁,给表中新增一个version字段,每次读取的时候将version字段读取,更新的时候再判断version字段是否是自己持有的值同时将version +1

Update goods set count=count -1 , version=version +1 where id = ‘123’ and version = ‘1’
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容

  • 一、背景 我们实际系统中有很多操作,是不管做多少次,都应该产生一样的效果或返回一样的结果。例如 前端重复提交选中的...
    JANME丶阅读 153评论 0 0
  • 一、什么是幂等性 幂等是一个数学与计算机学概念,在数学中某一元运算为幂等时,其作用在任一元素两次后会和其作用一次的...
    life_niu阅读 181评论 0 0
  • 一、幂等性概念 在编程中.一个幂等操作的特点是其任意多次执行所产生的影响均与一次执行的影响相同。幂等函数,或幂等方...
    小波同学阅读 1,131评论 1 18
  • 一、幂等性概念 二、分布式系统 中的幂等性 在编程中,一个幂等操作的特点是其任意多次执行所产生的影响与一次执行的影...
    逗逼程序员阅读 1,400评论 0 27
  • 分布式服务接口的幂等性如何设计 什么是幂等性 一个分布式系统中的某个接口,要保证幂等性,该如何保证?这个事儿其实是...
    wanggs阅读 433评论 0 0