1 C# 实现接口幂等性的四种方案
 2 原创 lyl 后端Q
 3  2024年06月22日 23:27 福建
 4 在分布式系统中，幂等性是一个重要的概念。它指的是一次和多次请求某一个资源应该具有同样的效果，即多次执行同样的操作，系统的状态不会发生改变。在网络不稳定或存在重试机制的情况下，保证接口的幂等性尤为重要，它可以防止因重复操作导致的数据不一致问题。
 5 
 6 本文将介绍在C#中实现接口幂等性的四种方案，并通过示例代码进行详细说明。
 7 
 8 方案一：使用唯一ID
 9 为每次请求生成一个唯一ID（如GUID），在处理请求时，先检查这个ID是否已经被处理过。如果是，则直接返回之前的结果；如果不是，则进行处理并保存结果。
10 
11 public class IdempotentService
12 {
13     private static readonly ConcurrentDictionary<string, string> Cache = new ConcurrentDictionary<string, string>();
14 
15     public string ProcessRequestWithUniqueId(string requestId, string input)
16     {
17         // 检查请求是否已处理
18         if (Cache.TryGetValue(requestId, out string result))
19         {
20             return result; // 返回之前处理的结果
21         }
22 
23         // 模拟处理过程
24         result = "Processed: " + input;
25         // 保存处理结果
26         Cache[requestId] = result;
27         return result;
28     }
29 }
30 
31 // 使用示例
32 var service = new IdempotentService();
33 string requestId = Guid.NewGuid().ToString(); // 生成唯一ID
34 string input = "Hello, World!";
35 string result = service.ProcessRequestWithUniqueId(requestId, input);
36 Console.WriteLine(result); // 输出：Processed: Hello, World!
37 // 再次使用相同的requestId调用，将返回相同的结果
38 string result2 = service.ProcessRequestWithUniqueId(requestId, "Different Input");
39 Console.WriteLine(result2); // 输出：Processed: Hello, World!（与第一次调用相同）

 1 public class DatabaseIdempotentService
 2 {
 3     // 假设有一个方法用于将数据插入数据库
 4     public bool InsertData(string data)
 5     {
 6         try
 7         {
 8             // 模拟数据库插入操作，如果数据已存在，则抛出异常
 9             if (DataExists(data))
10             {
11                 throw new Exception("Data already exists");
12             }
13             // 模拟成功插入数据
14             Console.WriteLine($"Data inserted: {data}");
15             return true;
16         }
17         catch (Exception)
18         {
19             // 插入失败（可能是重复数据）
20             return false;
21         }
22     }
23 
24     // 模拟检查数据是否存在的方法
25     private bool DataExists(string data)
26     {
27         // 实际开发中，这里应该是查询数据库的操作
28         return false; // 示例中始终返回false，表示数据不存在
29     }
30 }
31 
32 // 使用示例
33 var dbService = new DatabaseIdempotentService();
34 string data = "Some unique data";
35 bool result = dbService.InsertData(data); // 尝试插入数据，返回true表示成功，false

 1 public class DistributedLockIdempotentService
 2 {
 3     private static readonly string LockKey = "my_lock_key";
 4     private readonly IRedisClient _redisClient; // 假设使用StackExchange.Redis等库
 5 
 6     public DistributedLockIdempotentService(IRedisClient redisClient)
 7     {
 8         _redisClient = redisClient;
 9     }
10 
11     public string ProcessRequestWithLock(string input)
12     {
13         // 尝试获取分布式锁
14         if (_redisClient.Lock(LockKey, TimeSpan.FromSeconds(30))) // 锁定30秒
15         {
16             try
17             {
18                 // 模拟处理过程，这里应该是实际的业务逻辑
19                 string result = "Processed with lock: " + input;
20                 return result;
21             }
22             finally
23             {
24                 // 释放锁
25                 _redisClient.Unlock(LockKey);
26             }
27         }
28         else
29         {
30             // 获取锁失败，可能已经有其他请求在处理，返回默认结果或错误信息
31             return "Failed to acquire lock";
32         }
33     }

 1 public class StateMachineIdempotentService
 2 {
 3     private enum ProcessingState
 4     {
 5         NotStarted,
 6         Processing,
 7         Completed
 8     }
 9 
10     private static readonly ConcurrentDictionary<string, ProcessingState> States = new ConcurrentDictionary<string, ProcessingState>();
11 
12     public string ProcessRequestWithStateMachine(string requestId, string input)
13     {
14         // 检查当前状态
15         var currentState = States.GetOrAdd(requestId, ProcessingState.NotStarted);
16         switch (currentState)
17         {
18             case ProcessingState.NotStarted:
19                 // 更新状态为正在处理中
20                 States[requestId] = ProcessingState.Processing;
21                 // 模拟处理过程
22                 string result = "Processed with state machine: " + input;
23                 // 更新状态为已完成
24                 States[requestId] = ProcessingState.Completed;
25                 return result;
26             case ProcessingState.Processing:
27             case ProcessingState.Completed:
28                 // 如果已经在处理中或已完成，则直接返回之前的结果或错误信息
29                 return "Request already processed";
30             default:
31                 throw new InvalidOperationException("Unknown state");
32         }
33     }
34 }