添加项目文件。

This commit is contained in:
2023-03-13 15:00:34 +08:00
parent 42bf06ca3e
commit 1d73df3235
1205 changed files with 185078 additions and 0 deletions

View File

@@ -0,0 +1,47 @@
using JNPF.ConfigurableOptions;
namespace JNPF.Common.Cache;
/// <summary>
/// 缓存配置.
/// </summary>
public class CacheOptions : IConfigurableOptions
{
/// <summary>
/// 缓存类型.
/// </summary>
public CacheType CacheType { get; set; }
/// <summary>
/// Redis配置.
/// </summary>
public string RedisConnectionString { get; set; }
/// <summary>
/// 服务器地址.
/// </summary>
public string ip { get; set; }
/// <summary>
/// 端口.
/// </summary>
public int port { get; set; }
/// <summary>
/// 密码.
/// </summary>
public string password { get; set; }
}
public enum CacheType
{
/// <summary>
/// 内存缓存.
/// </summary>
MemoryCache,
/// <summary>
/// Redis缓存.
/// </summary>
RedisCache
}

View File

@@ -0,0 +1,134 @@
namespace JNPF.Common.Cache;
/// <summary>
/// 缓存接口.
/// </summary>
public interface ICache
{
/// <summary>
/// 用于在 key 存在时删除 key.
/// </summary>
/// <param name="key">键.</param>
long Del(params string[] key);
/// <summary>
/// 用于在 key 存在时删除 key.
/// </summary>
/// <param name="key">键.</param>
Task<long> DelAsync(params string[] key);
/// <summary>
/// 用于在 key 模板存在时删除.
/// </summary>
/// <param name="pattern">key模板.</param>
Task<long> DelByPatternAsync(string pattern);
/// <summary>
/// 检查给定 key 是否存在.
/// </summary>
/// <param name="key">键.</param>
bool Exists(string key);
/// <summary>
/// 检查给定 key 是否存在.
/// </summary>
/// <param name="key">键.</param>
Task<bool> ExistsAsync(string key);
/// <summary>
/// 获取指定 key 的增量值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="incrBy">增量.</param>
/// <returns></returns>
long Incrby(string key, long incrBy);
/// <summary>
/// 获取指定 key 的增量值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="incrBy">增量.</param>
/// <returns></returns>
Task<long> IncrbyAsync(string key, long incrBy);
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <param name="key">键.</param>
string Get(string key);
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <typeparam name="T">byte[] 或其他类型.</typeparam>
/// <param name="key">键.</param>
T Get<T>(string key);
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <param name="key">键.</param>
Task<string> GetAsync(string key);
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <typeparam name="T">byte[] 或其他类型.</typeparam>
/// <param name="key">键.</param>
Task<T> GetAsync<T>(string key);
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
bool Set(string key, object value);
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
/// <param name="expire">有效期.</param>
bool Set(string key, object value, TimeSpan expire);
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
Task<bool> SetAsync(string key, object value);
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
/// <param name="expire">有效期.</param>
Task<bool> SetAsync(string key, object value, TimeSpan expire);
/// <summary>
/// 只有在 key 不存在时设置 key 的值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
/// <param name="expire">有效期.</param>
bool SetNx(string key, object value, TimeSpan expire);
/// <summary>
/// 只有在 key 不存在时设置 key 的值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
bool SetNx(string key, object value);
/// <summary>
/// 获取所有缓存.
/// </summary>
List<string> GetAllKeys();
/// <summary>
/// 获取缓存过期时间.
/// </summary>
DateTime GetCacheOutTime(string key);
}

View File

@@ -0,0 +1,254 @@
using JNPF.DependencyInjection;
using Microsoft.Extensions.Caching.Memory;
using System.Reflection;
namespace JNPF.Common.Cache;
/// <summary>
/// 内存缓存.
/// </summary>
public class MemoryCache : ICache, ISingleton
{
private readonly IMemoryCache _memoryCache;
/// <summary>
/// 初始化一个<see cref="MemoryCache"/>类型的新实例.
/// </summary>
/// <param name="memoryCache"></param>
public MemoryCache(IMemoryCache memoryCache)
{
_memoryCache = memoryCache;
}
/// <summary>
/// 用于在 key 存在时删除 key.
/// </summary>
/// <param name="key">键.</param>
public long Del(params string[] key)
{
foreach (string? k in key)
{
_memoryCache.Remove(k);
}
return key.Length;
}
/// <summary>
/// 用于在 key 存在时删除 key.
/// </summary>
/// <param name="key">键.</param>
public Task<long> DelAsync(params string[] key)
{
foreach (var k in key)
{
_memoryCache.Remove(k);
}
return Task.FromResult((long)key.Length);
}
/// <summary>
/// 用于在 key 模板存在时删除.
/// </summary>
/// <param name="pattern">key模板.</param>
public async Task<long> DelByPatternAsync(string pattern)
{
if (string.IsNullOrEmpty(pattern))
return default;
// pattern = Regex.Replace(pattern, @"\{*.\}", "(.*)");
IEnumerable<string>? keys = GetAllKeys().Where(k => k.StartsWith(pattern));
if (keys != null && keys.Any())
return await DelAsync(keys.ToArray());
return default;
}
/// <summary>
/// 检查给定 key 是否存在.
/// </summary>
/// <param name="key">键.</param>
public bool Exists(string key)
{
return _memoryCache.TryGetValue(key, out _);
}
/// <summary>
/// 检查给定 key 是否存在.
/// </summary>
/// <param name="key">键.</param>
public Task<bool> ExistsAsync(string key)
{
return Task.FromResult(_memoryCache.TryGetValue(key, out _));
}
/// <summary>
/// 获取指定 key 的增量值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="incrBy">增量.</param>
/// <returns></returns>
public long Incrby(string key, long incrBy)
{
throw new NotImplementedException();
}
/// <summary>
/// 获取指定 key 的增量值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="incrBy">增量.</param>
/// <returns></returns>
public Task<long> IncrbyAsync(string key, long incrBy)
{
throw new NotImplementedException();
}
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <param name="key">键.</param>
public string Get(string key)
{
return _memoryCache.GetOrCreate(key, entry => { return entry.Value; })?.ToString();
}
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <typeparam name="T">byte[] 或其他类型.</typeparam>
/// <param name="key">键.</param>
public T Get<T>(string key)
{
ICacheEntry entry = _memoryCache.Get<ICacheEntry>(key);
return entry == null ? default(T) : (T)(entry.Value);
}
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <param name="key">键.</param>
public Task<string> GetAsync(string key)
{
return Task.FromResult(Get(key));
}
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <typeparam name="T">byte[] 或其他类型.</typeparam>
/// <param name="key">键.</param>
public Task<T> GetAsync<T>(string key)
{
return Task.FromResult(Get<T>(key));
}
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
public bool Set(string key, object value)
{
var entry = _memoryCache.CreateEntry(key);
entry.Value = value;
_memoryCache.Set(key, entry);
return true;
}
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
/// <param name="expire">有效期.</param>
public bool Set(string key, object value, TimeSpan expire)
{
var entry = _memoryCache.CreateEntry(key);
entry.Value = value;
_memoryCache.Set(key, entry, expire);
return true;
}
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
public Task<bool> SetAsync(string key, object value)
{
var entry = _memoryCache.CreateEntry(key);
entry.Value = value;
Set(key, entry);
return Task.FromResult(true);
}
/// <summary>
/// 保存.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
/// <param name="expire">过期时间.</param>
public Task<bool> SetAsync(string key, object value, TimeSpan expire)
{
var entry = _memoryCache.CreateEntry(key);
entry.Value = value;
Set(key, entry, expire);
return Task.FromResult(true);
}
/// <summary>
/// 获取所有key.
/// </summary>
public List<string> GetAllKeys()
{
const BindingFlags flags = BindingFlags.Instance | BindingFlags.NonPublic;
var entries = _memoryCache.GetType().GetField("_entries", flags).GetValue(_memoryCache);
var cacheItems = entries.GetType().GetProperty("Keys").GetValue(entries) as ICollection<object>;
var keys = new List<string>();
if (cacheItems == null) return keys;
return cacheItems.Select(u => u.ToString()).ToList();
}
/// <summary>
/// 获取缓存过期时间0.
/// </summary>
/// <param name="key"></param>
/// <returns></returns>
public DateTime GetCacheOutTime(string key)
{
ICacheEntry? entry = _memoryCache.GetOrCreate(key, entry =>
{
return entry;
});
if (entry.AbsoluteExpiration == null)
{
return DateTime.Now;
}
DateTimeOffset dateTimeOffset = (DateTimeOffset)entry.AbsoluteExpiration;
return dateTimeOffset.UtcDateTime;
}
/// <summary>
/// 只有在 key 不存在时设置 key 的值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
/// <param name="expire">有效期.</param>
public bool SetNx(string key, object value, TimeSpan expire)
{
throw new NotImplementedException();
}
/// <summary>
/// 只有在 key 不存在时设置 key 的值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
public bool SetNx(string key, object value)
{
throw new NotImplementedException();
}
}

View File

@@ -0,0 +1,227 @@
using JNPF.DependencyInjection;
using Microsoft.Extensions.Options;
namespace JNPF.Common.Cache;
/// <summary>
/// Redis缓存.
/// </summary>
public class RedisCache : ICache, ISingleton
{
/// <summary>
/// 构造函数.
/// </summary>
public RedisCache(IOptions<CacheOptions> cacheOptions)
{
CSRedis.CSRedisClient? csredis = new CSRedis.CSRedisClient(string.Format(cacheOptions.Value.RedisConnectionString, cacheOptions.Value.ip, cacheOptions.Value.port, cacheOptions.Value.password));
RedisHelper.Initialization(csredis);
}
/// <summary>
/// 用于在 key 存在时删除 key.
/// </summary>
/// <param name="key">键.</param>
public long Del(params string[] key)
{
return RedisHelper.Del(key);
}
/// <summary>
/// 用于在 key 存在时删除 key.
/// </summary>
/// <param name="key">键.</param>
public Task<long> DelAsync(params string[] key)
{
return RedisHelper.DelAsync(key);
}
/// <summary>
/// 用于在 key 模板存在时删除.
/// </summary>
/// <param name="pattern">key模板.</param>
public async Task<long> DelByPatternAsync(string pattern)
{
if (string.IsNullOrEmpty(pattern))
return default;
// pattern = Regex.Replace(pattern, @"\{.*\}", "*");
string[]? keys = await RedisHelper.KeysAsync(pattern);
if (keys?.Length > 0)
{
return await RedisHelper.DelAsync(keys);
}
return default;
}
/// <summary>
/// 检查给定 key 是否存在.
/// </summary>
/// <param name="key">键.</param>
public bool Exists(string key)
{
return RedisHelper.Exists(key);
}
/// <summary>
/// 检查给定 key 是否存在.
/// </summary>
/// <param name="key">键.</param>
public Task<bool> ExistsAsync(string key)
{
return RedisHelper.ExistsAsync(key);
}
/// <summary>
/// 获取指定 key 的增量值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="incrBy">增量.</param>
/// <returns></returns>
public long Incrby(string key, long incrBy)
{
return RedisHelper.IncrBy(key, incrBy);
}
/// <summary>
/// 获取指定 key 的增量值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="incrBy">增量.</param>
/// <returns></returns>
public Task<long> IncrbyAsync(string key, long incrBy)
{
return RedisHelper.IncrByAsync(key, incrBy);
}
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <param name="key">键.</param>
public string Get(string key)
{
return RedisHelper.Get(key);
}
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <typeparam name="T">byte[] 或其他类型.</typeparam>
/// <param name="key">键.</param>
public T Get<T>(string key)
{
return RedisHelper.Get<T>(key);
}
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <param name="key">键.</param>
/// <returns></returns>
public Task<string> GetAsync(string key)
{
return RedisHelper.GetAsync(key);
}
/// <summary>
/// 获取指定 key 的值.
/// </summary>
/// <typeparam name="T">byte[] 或其他类型.</typeparam>
/// <param name="key">键.</param>
public Task<T> GetAsync<T>(string key)
{
return RedisHelper.GetAsync<T>(key);
}
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
public bool Set(string key, object value)
{
return RedisHelper.Set(key, value);
}
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
/// <param name="expire">有效期.</param>
public bool Set(string key, object value, TimeSpan expire)
{
return RedisHelper.Set(key, value, expire);
}
/// <summary>
/// 设置指定 key 的值所有写入参数object都支持string | byte[] | 数值 | 对象.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
public Task<bool> SetAsync(string key, object value)
{
return RedisHelper.SetAsync(key, value);
}
/// <summary>
/// 保存.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
/// <param name="expire">过期时间.</param>
/// <returns></returns>
public Task<bool> SetAsync(string key, object value, TimeSpan expire)
{
return RedisHelper.SetAsync(key, value, expire);
}
/// <summary>
/// 只有在 key 不存在时设置 key 的值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
/// <param name="expire">有效期.</param>
public bool SetNx(string key, object value, TimeSpan expire)
{
if (RedisHelper.SetNx(key, value))
{
RedisHelper.Set(key, value, expire);
return true;
}
else
{
return false;
}
}
/// <summary>
/// 只有在 key 不存在时设置 key 的值.
/// </summary>
/// <param name="key">键.</param>
/// <param name="value">值.</param>
public bool SetNx(string key, object value)
{
return RedisHelper.SetNx(key, value);
}
/// <summary>
/// 获取所有key.
/// </summary>
/// <returns></returns>
public List<string> GetAllKeys()
{
return RedisHelper.Keys("*").ToList();
}
/// <summary>
/// 获取缓存过期时间.
/// </summary>
/// <param name="key">键值.</param>
/// <returns></returns>
public DateTime GetCacheOutTime(string key)
{
long second = RedisHelper.PTtl(key);
return DateTime.Now.AddMilliseconds(second);
}
}