概述
在 Web 开发中，幂等性（idempotency）是一个非常重要的概念。它指的是在同一请求被多次执行时，结果不会受到多次执行的影响，只产生一次执行的效果。
为了实现幂等性，在前端开发中经常会使用一些库或框架。其中，idempotency-express 是一个非常有用的 npm 包，它可以让开发者更加方便地实现幂等性。
本文将介绍 npm 包 idempotency-express 的使用教程，包括基本使用方法、常见问题的解决方案以及最佳实践。
安装
安装 idempotency-express 的命令很简单：
npm install idempotency-express
基本使用方法
使用 idempotency-express 最基本的方法是将中间件插入到 Express 应用程序的路由器中。下面是一个简单的示例：
-- -------------------- ---- ------- ----- ----------- - ------------------------------- ----- ------- - ------------------- ----- --- - ---------- -- -- ------------------- --- ----------------------- -- -- --- -------- -- ------------------- ----- ---- ----- -- - -- -------- ---------- -------- ------ ------- --- --- ---------------- -- -- ------------------- ------------
使用上述代码后，所有通过 GET /example 路由器进行的请求都将具有幂等性。如果同一请求被多次发送，只会产生一次处理结果。
配置选项
idempotency-express 还提供了一些配置选项，以便你更好地控制其行为。
idempotencyHeaderName
默认情况下，idempotency-express 会在 req.headers 中查找一个名为 "Idempotency-Key" 的 HTTP 标头，以确定请求是否具有幂等性。如果该标头不存在，则该请求不会被视为幂等性。
但是，你可以通过 idempotencyHeaderName 选项更改标头名称。例如，你可以将其更改为 "X-Idempotency-Key"：
app.use(Idempotency({ idempotencyHeaderName: "X-Idempotency-Key" }));ttl
默认情况下，idempotency-express 将幂等键与处理结果存储在内存中，并允许它们在 300 秒后过期。如果你想缩短或延长幂等键的存储时间，可以使用 ttl 选项：
app.use(Idempotency({ ttl: 60 }));上述代码将幂等键的过期时间更改为 60 秒。
storageEngine
默认情况下，idempotency-express 使用内存作为存储引擎。但是，在生产环境下，你可能需要使用其他的存储引擎，以便更好地处理并发请求。
idempotency-express 支持使用 Redis、Memcached、MongoDB 等流行的存储引擎，你可以通过指定 storageEngine 选项来使用它们。例如，如果你想使用 Redis 作为存储引擎：
-- -------------------- ---- -------
----- ----- - -----------------
----- ------ - ---------------------
--------
-------------
-------------- --- --------------------------------------
--
--shouldSkip
默认情况下，idempotency-express 会在每个路由请求中都进行幂等性检查以确保处理具有幂等性。但是，在某些情况下，你可能需要跳过幂等性检查。例如，在处理与时间有关的请求时，幂等性检查可能会导致请求被拒绝。
你可以通过编写 shouldSkip 函数来控制哪些请求应该跳过幂等性检查。shouldSkip 函数应该返回一个布尔值，如果返回 true，则该请求将被跳过幂等性检查。
app.use(
Idempotency({
shouldSkip: (req) => req.query.skipIdempotencyCheck === "true"
})
);上述代码将跳过所有包含 "?skipIdempotencyCheck=true" 查询参数的请求的幂等性检查。
常见问题及其解决方案
如何处理幂等键冲突？
在某些情况下，不同的请求可能会使用相同的幂等键（idempotency key）。在这种情况下，将会出现幂等键冲突。
解决办法是在幂等键的前面添加一些随机字符或时间戳。你可以使用 uuid 包生成唯一的幂等键。例如：
const uuid = require("uuid");
app.post("/example", (req, res, next) => {
const idempotencyKey = `${uuid.v4()}:${req.headers["idempotency-key"]}`;
// ...
});上述代码将幂等键与随机 UUID 前缀组合在一起，以确保它们是唯一的。
如何防止在响应已发送后继续处理请求？
在某些情况下，即使幂等性检查失败，还是可能会继续处理请求。在这种情况下，可能会导致响应被发送到客户端，而请求在继续处理，从而造成不必要的性能或资源浪费。
解决办法是使用一个信号量来防止响应已发送后继续处理请求。你可以使用 async-lock 包实现信号量。例如：
-- -------------------- ---- -------
----- --------- - ----------------------
----- ---- - --- ------------
-------------------- ----- ----- ---- ----- -- -
----- -------------- - -------------------------------
----- ------- - ----- ---------------------------- -- -- ----
--- -
-- ---------
- ------- -
----------
-
---上述代码使用 async-lock 包实现了一个信号量。如果信号量被占用，则实现业务逻辑的代码不会被执行。
如何在多个 Express 应用程序之间共享幂等键？
在生产环境中，你可能需要在多个 Express 应用程序之间共享幂等键。为了实现此目的，你需要使用一个支持分布式存储的存储引擎（如 Redis）。
解决办法是使用支持分布式存储的存储引擎，如 Redis。例如：
-- -------------------- ---- -------
----- ----- - -----------------
----- - ------------------ - - -------------------------------
----- ------ - ---------------------
--------
-------------
-------------- --- -------------------------- ---------
--
--上述代码将幂等键存储在 Redis 中，并使用前缀 "myapp:" 进行区分。
最佳实践
以下是一些使用 idempotency-express 的最佳实践：
- 在生产环境中，最好使用一个支持分布式存储的存储引擎，如 Redis。
- 如果一个请求需要进行身份验证，请不要将身份验证令牌（如 JWT）包含在幂等键中。幂等键应该仅仅与请求本身有关。
- 尽量避免在请求正文中包含随机元素（如时间戳）。这样会导致幂等键难以重复，并且可能会增加冲突的可能性。
- 尽可能在任务执行之前获取幂等键。这可以避免在任务执行后发生冲突的可能性。
结论
本文介绍了 npm 包 idempotency-express 的使用教程，包括基本使用方法、配置选项、常见问题及其解决方案以及最佳实践。通过使用 idempotency-express，你可以更好地实现幂等性，增加 Web 应用程序的可靠性和稳定性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005664381e8991b448e2531