// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
using NewLife.Caching.Queues;
namespace Admin.NET.Core;
///
/// Redis 消息队列
///
public static class RedisQueue
{
private static ICacheProvider _cacheProvider = App.GetRequiredService();
/// 创建Redis消息队列。默认消费一次,指定消费者group时使用STREAM结构,支持多消费组共享消息
///
/// 使用队列时,可根据是否设置消费组来决定使用简单队列还是完整队列。 简单队列(如RedisQueue)可用作命令队列,Topic很多,但几乎没有消息。 完整队列(如RedisStream)可用作消息队列,Topic很少,但消息很多,并且支持多消费组。
///
///
/// 主题
/// 消费组。未指定消费组时使用简单队列(如RedisQueue),指定消费组时使用完整队列(如RedisStream)
///
public static IProducerConsumer GetQueue(String topic, String group = null)
{
// 队列需要单列
var key = $"myStream:{topic}";
if (_cacheProvider.InnerCache.TryGetValue>(key, out var queue)) return queue;
queue = _cacheProvider.GetQueue(topic, group);
_cacheProvider.Cache.Set(key, queue);
return queue;
}
///
/// 获取可信队列,需要确认
///
///
///
///
public static RedisReliableQueue GetRedisReliableQueue(string topic)
{
// 队列需要单列
var key = $"myQueue:{topic}";
if (_cacheProvider.InnerCache.TryGetValue>(key, out var queue)) return queue;
queue = (_cacheProvider.Cache as FullRedis).GetReliableQueue(topic);
_cacheProvider.Cache.Set(key, queue);
return queue;
}
///
/// 可信队列回滚
///
///
///
///
public static int RollbackAllAck(string topic, int retryInterval = 60)
{
var queue = GetRedisReliableQueue(topic);
queue.RetryInterval = retryInterval;
return queue.RollbackAllAck();
}
///
/// 发送一个数据列表到可信队列
///
///
///
///
///
public static int AddReliableQueueList(string topic, List value)
{
var queue = GetRedisReliableQueue(topic);
var count = queue.Count;
var result = queue.Add(value.ToArray());
return result - count;
}
///
/// 发送一条数据到可信队列
///
///
///
///
///
public static int AddReliableQueue(string topic, T value)
{
var queue = GetRedisReliableQueue(topic);
var count = queue.Count;
var result = queue.Add(value);
return result - count;
}
///
/// 获取延迟队列
///
///
///
///
public static RedisDelayQueue GetDelayQueue(string topic)
{
// 队列需要单列
var key = $"myDelay:{topic}";
if (_cacheProvider.InnerCache.TryGetValue>(key, out var queue)) return queue;
queue = (_cacheProvider.Cache as FullRedis).GetDelayQueue(topic);
_cacheProvider.Cache.Set(key, queue);
return queue;
}
///
/// 发送一条数据到延迟队列
///
///
///
/// 延迟时间。单位秒
///
///
public static int AddDelayQueue(string topic, T value, int delay)
{
var queue = GetDelayQueue(topic);
return queue.Add(value, delay);
}
///
/// 发送数据列表到延迟队列
///
///
///
///
/// 延迟时间。单位秒
///
public static int AddDelayQueue(string topic, List value, int delay)
{
var queue = GetDelayQueue(topic);
queue.Delay = delay;
return queue.Add(value.ToArray());
}
///
/// 在可信队列获取一条数据
///
///
///
///
public static T ReliableTakeOne(string topic)
{
var queue = GetRedisReliableQueue(topic);
return queue.TakeOne(1);
}
///
/// 异步在可信队列获取一条数据
///
///
///
///
public static async Task ReliableTakeOneAsync(string topic)
{
var queue = GetRedisReliableQueue(topic);
return await queue.TakeOneAsync(1);
}
///
/// 在可信队列获取多条数据
///
///
///
///
///
public static List ReliableTake(string topic, int count)
{
var queue = GetRedisReliableQueue(topic);
return queue.Take(count).ToList();
}
///
/// 申请分布式锁
///
/// 要锁定的key
/// 申请锁等待的时间,单位毫秒
/// 锁过期时间,超过该时间没有主动是放则自动是放,必须整数秒,单位毫秒
/// 失败时是否抛出异常,如不抛出异常,可通过判断返回null得知申请锁失败
///
public static IDisposable? BeginCacheLock(string key, int msTimeout = 500, int msExpire = 10000, bool throwOnFailure = true)
{
try
{
return _cacheProvider.Cache.AcquireLock(key, msTimeout, msExpire, throwOnFailure);
}
catch
{
return null;
}
}
}