后端接口幂等请求设计思想

• 什么是幂等性

• 什么是接口幂等性

• 为什么需要实现幂等性

• 引入幂等性后对系统的影响

• Restful API 接口的幂等性如何实现幂等性

• 方案一：数据库唯一主键
• 方案二：数据库乐观锁 
• 方案三：防重 Token 令牌
• 方案四、下游传递唯一序列号实现接口幂等示例

上文参考：SpringBoot接口幂等性设计

一：幂等请求的实现方式扩展

    1. 前端按钮重复点击控制

    2. 后端接口程序控制 (文末附代码示例)

    上述的 方案一 和 方案二 是数据库操作方面实现幂等设计；

     方案三是基于API接口的幂等设计；

     方案四和扩展1 都是前端操作控制和服务器配合使用，但后者存在用户跳过页面操作，直接持有接口对服务器发起请求问题。

 

附：测试整合代码,使用请按规范修改各代码段存放指定类和位置目录

 

package com.company.java.算法;

import javax.annotation.PostConstruct;
import java.security.MessageDigest;
import java.util.Collections;
import java.util.concurrent.TimeUnit;

/**
 * 功能说明：哈希工具类
 *
 * @author ljy on 2021/3/23
 */

public class HashUtils {

    private static final char[] HEX_DIGITS = "0123456789abcdef".toCharArray();

    //测试
    public static void main(String[] args) {
        String srcStr = "param1,param2...";
        String idempotentLock = HashUtils.md5(srcStr);
        System.out.println("md5 result is " + idempotentLock);

        String lockKey = "goto_next_step_" + userToken;

        if (!tryGetDistributedLock(lockKey, idempotentLock, 30, TimeUnit.SECONDS)) {
            System.out.println("请勿重复请求");
        }

        //释放请求锁
        releaseDistributedLock(lockKey, idempotentLock);
    }


    @Autowired(required = false)
    @Qualifier("InitRedisTemplate")
    private RedisTemplate<String, Object> redisTemplateBean;
    private static volatile RedisTemplate<String, Object> redisTemplate;

    @PostConstruct
    public void init() {
        redisTemplate = redisTemplateBean;
    }

    /**
     * 尝试获取分布式锁
     *
     * @param lockKey    锁
     * @param requestId  请求标识
     * @param expireTime 超期时间
     * @return 是否获取成功
     */
    public static boolean tryGetDistributedLock(String lockKey, String requestId, int expireTime, TimeUnit unit) {
        boolean success = redisTemplate.opsForValue().setIfAbsent(lockKey, requestId, expireTime, unit);
        if (!success) {
            System.out.println("锁已存在");
            return false;
        }
        return true;
    }


    private static final long RELEASE_SUCCESS = 1L;
    private static final String RELEASE_LOCK_LUA_SCRIPT =
            "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
    /**
     * 释放分布式锁
     *
     * @param lockKey   锁
     * @param requestId 请求标识
     * @return 是否释放成功
     */
    public static boolean releaseDistributedLock(String lockKey, String requestId) {

        /**
         * 1. 直接编写脚本
         */
        // 指定 lua 脚本，并且指定返回值类型
        //返回值解释：为什么返回值不用 Integer 接收而是用 Long。这里是因为 spring-boot-starter-data-redis 提供的返回类型里面不支持 Integer
        DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>(RELEASE_LOCK_LUA_SCRIPT, Long.class);
        // 参数一：redisScript，参数二：key列表，参数三：arg（可多个）
        Long result = redisTemplate.execute(redisScript, Collections.singletonList(lockKey), requestId);

        if (result!= null && RELEASE_SUCCESS == result.longValue()) {
            return true;
        }
        return false;

    }


    /**
     * 功能说明：使用MD5算法对字符串参数进行哈希处理
     * 修改说明：
     *
     * @param srcStr 原字符串
     * @return 返回md5哈希处理后的字符串
     */
    public static String md5(String srcStr) {
        try {
            MessageDigest md = MessageDigest.getInstance("MD5");
            byte[] bytes = md.digest(srcStr.getBytes("utf-8"));
            return toHex(bytes);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * 功能说明：把字节数组转为16进制字符串
     * 修改说明：
     *
     * @param bytes
     * @return
     */
    private static String toHex(byte[] bytes) {
        StringBuilder ret = new StringBuilder(bytes.length * 2);
        for (int i = 0; i < bytes.length; i++) {
            ret.append(HEX_DIGITS[(bytes[i] >> 4) & 0x0f]);
            ret.append(HEX_DIGITS[bytes[i] & 0x0f]);
        }
        return ret.toString();
    }

}