// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
using Newtonsoft.Json;
namespace Admin.NET.Core.Service;
///
/// 系统缓存服务 🧩
///
[ApiDescriptionSettings(Order = 400, Description = "系统缓存")]
public class SysCacheService : IDynamicApiController, ISingleton
{
private static ICacheProvider _cacheProvider;
private readonly CacheOptions _cacheOptions;
public SysCacheService(ICacheProvider cacheProvider, IOptions cacheOptions)
{
_cacheProvider = cacheProvider;
_cacheOptions = cacheOptions.Value;
}
///
/// 申请分布式锁 🔖
///
/// 要锁定的key
/// 申请锁等待的时间,单位毫秒
/// 锁过期时间,超过该时间没有主动是放则自动是放,必须整数秒,单位毫秒
/// 失败时是否抛出异常,如不抛出异常,可通过判断返回null得知申请锁失败
///
[DisplayName("申请分布式锁")]
public 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;
}
}
///
/// 获取缓存键名集合 🔖
///
///
[DisplayName("获取缓存键名集合")]
public List GetKeyList()
{
return _cacheProvider.Cache == Cache.Default
? [.. _cacheProvider.Cache.Keys.Where(u => u.StartsWith(_cacheOptions.Prefix)).Select(u => u[_cacheOptions.Prefix.Length..]).OrderBy(u => u)]
: [.. ((FullRedis)_cacheProvider.Cache).Search($"{_cacheOptions.Prefix}*", int.MaxValue).Select(u => u[_cacheOptions.Prefix.Length..]).OrderBy(u => u)];
}
///
/// 增加缓存
///
///
///
///
[NonAction]
public bool Set(string key, object value)
{
return !string.IsNullOrWhiteSpace(key) && _cacheProvider.Cache.Set($"{_cacheOptions.Prefix}{key}", value);
}
///
/// 增加缓存并设置过期时间
///
///
///
///
///
[NonAction]
public bool Set(string key, object value, TimeSpan expire)
{
return !string.IsNullOrWhiteSpace(key) && _cacheProvider.Cache.Set($"{_cacheOptions.Prefix}{key}", value, expire);
}
public async Task AdGetAsync
(String cacheName, Func> del, TimeSpan? expiry = default) where TR : class
{
return await AdGetAsync(cacheName, del, [], expiry);
}
public async Task
AdGetAsync
(String cacheName, Func> del, T1 t1, TimeSpan? expiry = default) where TR : class
{
return await AdGetAsync(cacheName, del, [t1], expiry);
}
public async Task
AdGetAsync
(String cacheName, Func> del, T1 t1, T2 t2, TimeSpan? expiry = default) where TR : class
{
return await AdGetAsync(cacheName, del, [t1, t2], expiry);
}
public async Task
AdGetAsync
(String cacheName, Func> del, T1 t1, T2 t2, T3 t3, TimeSpan? expiry = default) where TR : class
{
return await AdGetAsync(cacheName, del, [t1, t2, t3], expiry);
}
private async Task AdGetAsync(string cacheName, Delegate del, Object[] obs, TimeSpan? expiry) where T : class
{
var key = Key(cacheName, obs);
// 使用分布式锁
using (_cacheProvider.Cache.AcquireLock($@"lock:AdGetAsync:{cacheName}", 1000))
{
var value = Get(key);
value ??= await ((dynamic)del).DynamicInvokeAsync(obs);
Set(key, value);
return value;
}
}
public T Get(String cacheName, object t1)
{
return Get(cacheName, [t1]);
}
public T Get(String cacheName, object t1, object t2)
{
return Get(cacheName, [t1, t2]);
}
public T Get(String cacheName, object t1, object t2, object t3)
{
return Get(cacheName, [t1, t2, t3]);
}
private T Get(String cacheName, Object[] obs)
{
var key = cacheName + ":" + obs.Aggregate(string.Empty, (current, o) => current + $"<{o}>");
return Get(key);
}
private static string Key(string cacheName, object[] obs)
{
if (obs.OfType().Any()) throw new Exception("缓存参数类型不能能是:TimeSpan类型");
StringBuilder sb = new(cacheName + ":");
foreach (var a in obs) sb.Append($"<{KeySingle(a)}>");
return sb.ToString();
}
private static string KeySingle(object t)
{
return t.GetType().IsClass && !t.GetType().IsPrimitive ? JsonConvert.SerializeObject(t) : t.ToString();
}
///
/// 获取缓存的剩余生存时间
///
///
///
[NonAction]
public TimeSpan GetExpire(string key)
{
return _cacheProvider.Cache.GetExpire(key);
}
///
/// 获取缓存
///
///
///
///
[NonAction]
public T Get(string key)
{
return _cacheProvider.Cache.Get($"{_cacheOptions.Prefix}{key}");
}
///
/// 删除缓存 🔖
///
///
///
[ApiDescriptionSettings(Name = "Delete"), HttpPost]
[DisplayName("删除缓存")]
public int Remove(string key)
{
return _cacheProvider.Cache.Remove($"{_cacheOptions.Prefix}{key}");
}
///
/// 清空所有缓存 🔖
///
///
[DisplayName("清空所有缓存")]
[ApiDescriptionSettings(Name = "Clear"), HttpPost]
public void Clear()
{
_cacheProvider.Cache.Clear();
Cache.Default.Clear();
}
///
/// 检查缓存是否存在
///
/// 键
///
[NonAction]
public bool ExistKey(string key)
{
return _cacheProvider.Cache.ContainsKey($"{_cacheOptions.Prefix}{key}");
}
///
/// 根据键名前缀删除缓存 🔖
///
/// 键名前缀
///
[ApiDescriptionSettings(Name = "DeleteByPreKey"), HttpPost]
[DisplayName("根据键名前缀删除缓存")]
public int RemoveByPrefixKey(string prefixKey)
{
var delKeys = _cacheProvider.Cache == Cache.Default
? _cacheProvider.Cache.Keys.Where(u => u.StartsWith($"{_cacheOptions.Prefix}{prefixKey}")).ToArray()
: ((FullRedis)_cacheProvider.Cache).Search($"{_cacheOptions.Prefix}{prefixKey}*", int.MaxValue).ToArray();
return _cacheProvider.Cache.Remove(delKeys);
}
///
/// 根据键名前缀获取键名集合 🔖
///
/// 键名前缀
///
[DisplayName("根据键名前缀获取键名集合")]
public List GetKeysByPrefixKey(string prefixKey)
{
return _cacheProvider.Cache == Cache.Default
? _cacheProvider.Cache.Keys.Where(u => u.StartsWith($"{_cacheOptions.Prefix}{prefixKey}")).Select(u => u[_cacheOptions.Prefix.Length..]).ToList()
: ((FullRedis)_cacheProvider.Cache).Search($"{_cacheOptions.Prefix}{prefixKey}*", int.MaxValue).Select(u => u[_cacheOptions.Prefix.Length..]).ToList();
}
///
/// 获取缓存值 🔖
///
///
///
[DisplayName("获取缓存值")]
public object GetValue(string key)
{
if (string.IsNullOrEmpty(key)) return null;
if (Regex.IsMatch(key, @"%[0-9a-fA-F]{2}"))
key = HttpUtility.UrlDecode(key);
var fullKey = $"{_cacheOptions.Prefix}{key}";
if (_cacheProvider.Cache == Cache.Default)
return _cacheProvider.Cache.Get