利用 Redis 实现防止接口重复提交功能

后端

2023-11-27 14:30:34

引言

在构建 Web 应用程序时，经常会遇到接口重复提交的问题。这通常发生在用户连续多次点击提交按钮或在网络不稳定时重新加载页面。为了防止这种问题，实现接口幂等性至关重要。幂等性是指接口可以安全地重复执行多次，而不会产生意外的后果。

利用 Redis 实现接口幂等性

Redis 是一种流行的键值存储数据库，具有出色的性能和丰富的功能。它非常适合于实现接口幂等性。

分布式锁

Redis 提供了一个名为分布式锁的功能，它允许我们在多个客户端之间协调对共享资源的访问。我们可以利用分布式锁来防止多个请求同时执行相同操作。

原子操作

Redis 还支持原子操作，这意味着多个操作要么全部执行，要么都不执行。这对于确保数据的完整性至关重要。

实现步骤

下面是利用 Redis 实现接口幂等性的步骤：

创建分布式锁： 在收到请求时，首先尝试获取一个分布式锁。如果锁获取成功，则继续执行请求。
设置请求标识： 为请求生成一个唯一的标识符，并将其存储在 Redis 中。标识符的有效期应足够长，以涵盖请求处理所需的时间。
执行请求： 如果锁获取成功且请求标识不存在，则执行请求并更新数据。
释放锁： 请求执行完成后，释放分布式锁。
检查请求标识： 如果请求标识存在，则表示请求已重复提交，直接返回结果。

示例代码

以下是一个 Node.js 示例代码，展示了如何使用 Redis 实现接口幂等性：

const redis = require('redis');
const client = redis.createClient();

// 获取分布式锁
const getLock = async (key, ttl) => {
  return new Promise((resolve, reject) => {
    client.set(key, 'lock', 'NX', 'EX', ttl, (err, reply) => {
      if (err) {
        reject(err);
      } else {
        resolve(reply);
      }
    });
  });
};

// 释放分布式锁
const releaseLock = async (key) => {
  return new Promise((resolve, reject) => {
    client.del(key, (err, reply) => {
      if (err) {
        reject(err);
      } else {
        resolve(reply);
      }
    });
  });
};

// 接口幂等性中间件
const rateLimit = async (req, res, next) => {
  try {
    // 获取请求标识
    const requestId = req.headers['x-request-id'];

    // 获取分布式锁
    const lock = await getLock(requestId, 60);

    // 请求标识不存在，则执行请求
    if (lock) {
      next();
    } else {
      // 请求标识已存在，直接返回结果
      res.status(409).send('Request already submitted');
    }
  } catch (err) {
    res.status(500).send('Internal server error');
  } finally {
    // 释放分布式锁
    await releaseLock(requestId);
  }
};