添加项目文件。
This commit is contained in:
fuenmao
@@ -0,0 +1,70 @@
|
||||
// Copyright (c) 2022-Now 少林寺驻北固山办事处大神父王喇嘛
|
||||
//
|
||||
// SimpleAdmin 基于 Apache License Version 2.0 协议发布，可用于商业项目，但必须遵守以下补充条款:
|
||||
// 1.请不要删除和修改根目录下的LICENSE文件。
|
||||
// 2.请不要删除和修改SimpleAdmin源码头部的版权声明。
|
||||
// 3.分发源码时候，请注明软件出处 https://gitee.com/dotnetmoyu/SimpleAdmin
|
||||
// 4.基于本软件的作品，只能使用 SimpleAdmin 作为后台服务，除外情况不可商用且不允许二次分发或开源。
|
||||
// 5.请不得将本软件应用于危害国家安全、荣誉和利益的行为，不能以任何形式用于非法为目的的行为。
|
||||
// 6.任何基于本软件而产生的一切法律纠纷和责任，均于我司无关。
|
||||
|
||||
namespace SimpleAdmin.Cache;
|
||||
|
||||
/// <summary>
|
||||
/// 缓存服务
|
||||
/// </summary>
|
||||
public partial interface ISimpleCacheService
|
||||
{
|
||||
/// <summary>
|
||||
/// 添加一条数据到HashMap
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="hashKey">hash列表里的Key</param>
|
||||
/// <param name="value">值</param>
|
||||
void HashAdd<T>(string key, string hashKey, T value);
|
||||
|
||||
/// <summary>
|
||||
/// 添加多条数据到HashMap
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="dic">键值对字典</param>
|
||||
/// <returns></returns>
|
||||
bool HashSet<T>(string key, Dictionary<string, T> dic);
|
||||
|
||||
/// <summary>
|
||||
/// 从HashMap中删除数据
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="fields">hash键列表</param>
|
||||
/// <returns>执行结果</returns>
|
||||
int HashDel<T>(string key, params string[] fields);
|
||||
|
||||
/// <summary>
|
||||
/// 根据键获取hash列表中的值
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="fields">hash键列表</param>
|
||||
/// <returns>数据列表</returns>
|
||||
List<T> HashGet<T>(string key, params string[] fields);
|
||||
|
||||
/// <summary>
|
||||
/// 根据键获取hash列表中的值
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="field">hash键</param>
|
||||
/// <returns></returns>
|
||||
T HashGetOne<T>(string key, string field);
|
||||
|
||||
/// <summary>
|
||||
/// 获取所有键值对
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <returns>数据字典</returns>
|
||||
IDictionary<string, T> HashGetAll<T>(string key);
|
||||
}
|
||||
@@ -0,0 +1,108 @@
|
||||
// Copyright (c) 2022-Now 少林寺驻北固山办事处大神父王喇嘛
|
||||
//
|
||||
// SimpleAdmin 基于 Apache License Version 2.0 协议发布，可用于商业项目，但必须遵守以下补充条款:
|
||||
// 1.请不要删除和修改根目录下的LICENSE文件。
|
||||
// 2.请不要删除和修改SimpleAdmin源码头部的版权声明。
|
||||
// 3.分发源码时候，请注明软件出处 https://gitee.com/dotnetmoyu/SimpleAdmin
|
||||
// 4.基于本软件的作品，只能使用 SimpleAdmin 作为后台服务，除外情况不可商用且不允许二次分发或开源。
|
||||
// 5.请不得将本软件应用于危害国家安全、荣誉和利益的行为，不能以任何形式用于非法为目的的行为。
|
||||
// 6.任何基于本软件而产生的一切法律纠纷和责任，均于我司无关。
|
||||
|
||||
using NewLife.Caching.Queues;
|
||||
|
||||
namespace SimpleAdmin.Cache;
|
||||
|
||||
/// <summary>
|
||||
/// 缓存服务
|
||||
/// </summary>
|
||||
public partial interface ISimpleCacheService
|
||||
{
|
||||
#region 普通队列
|
||||
|
||||
/// <summary>
|
||||
/// 添加到队列
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">值数组</param>
|
||||
/// <returns>添加数量</returns>
|
||||
int AddQueue<T>(string key, T[] value);
|
||||
|
||||
/// <summary>
|
||||
/// 添加到队列
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">值</param>
|
||||
/// <returns>添加数量</returns>
|
||||
int AddQueue<T>(string key, T value);
|
||||
|
||||
/// <summary>
|
||||
/// 获取队列实例
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <returns>队列实例</returns>
|
||||
RedisQueue<T> GetRedisQueue<T>(string key);
|
||||
|
||||
/// <summary>
|
||||
/// 从队列中获取数据
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="Count">数量</param>
|
||||
/// <returns>数据列表</returns>
|
||||
List<T> GetQueue<T>(string key, int Count = 1);
|
||||
|
||||
/// <summary>
|
||||
/// 取一条数据
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="timeout">阻塞时间</param>
|
||||
/// <returns>数据</returns>
|
||||
T GetQueueOne<T>(string key, int timeout = 1);
|
||||
|
||||
/// <summary>
|
||||
/// 异步取一条数据
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="timeout">阻塞时间</param>
|
||||
/// <returns>数据</returns>
|
||||
Task<T> GetQueueOneAsync<T>(string key, int timeout = 1);
|
||||
|
||||
#endregion
|
||||
|
||||
#region 延迟队列
|
||||
|
||||
/// <summary>
|
||||
/// 添加一条数据到延迟队列
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">值</param>
|
||||
/// <param name="delay">延迟时间</param>
|
||||
/// <returns>添加成功数量</returns>
|
||||
int AddDelayQueue<T>(string key, T value, int delay);
|
||||
|
||||
/// <summary>
|
||||
/// 批量添加数据到延迟队列
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">值</param>
|
||||
/// <param name="delay">延迟时间</param>
|
||||
/// <returns>添加成功数量</returns>
|
||||
int AddDelayQueue<T>(string key, List<T> value, int delay);
|
||||
|
||||
/// <summary>
|
||||
/// 获取延迟队列实例
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <returns></returns>
|
||||
RedisDelayQueue<T> GetDelayQueue<T>(string key);
|
||||
|
||||
#endregion
|
||||
}
|
||||
@@ -0,0 +1,191 @@
|
||||
// Copyright (c) 2022-Now 少林寺驻北固山办事处大神父王喇嘛
|
||||
//
|
||||
// SimpleAdmin 基于 Apache License Version 2.0 协议发布，可用于商业项目，但必须遵守以下补充条款:
|
||||
// 1.请不要删除和修改根目录下的LICENSE文件。
|
||||
// 2.请不要删除和修改SimpleAdmin源码头部的版权声明。
|
||||
// 3.分发源码时候，请注明软件出处 https://gitee.com/dotnetmoyu/SimpleAdmin
|
||||
// 4.基于本软件的作品，只能使用 SimpleAdmin 作为后台服务，除外情况不可商用且不允许二次分发或开源。
|
||||
// 5.请不得将本软件应用于危害国家安全、荣誉和利益的行为，不能以任何形式用于非法为目的的行为。
|
||||
// 6.任何基于本软件而产生的一切法律纠纷和责任，均于我司无关。
|
||||
|
||||
namespace SimpleAdmin.Cache;
|
||||
|
||||
/// <summary>
|
||||
/// 缓存服务
|
||||
/// </summary>
|
||||
public partial interface ISimpleCacheService
|
||||
{
|
||||
#region 基础操作
|
||||
|
||||
/// <summary>是否包含缓存项</summary>
|
||||
/// <param name="key"></param>
|
||||
/// <returns></returns>
|
||||
bool ContainsKey(string key);
|
||||
|
||||
/// <summary>设置缓存项</summary>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">值</param>
|
||||
/// <param name="expire">过期时间，秒。小于0时采用默认缓存时间</param>
|
||||
/// <returns></returns>
|
||||
bool Set<T>(string key, T value, int expire = -1);
|
||||
|
||||
/// <summary>设置缓存项</summary>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">值</param>
|
||||
/// <param name="expire">过期时间</param>
|
||||
/// <returns></returns>
|
||||
bool Set<T>(string key, T value, TimeSpan expire);
|
||||
|
||||
/// <summary>获取缓存项</summary>
|
||||
/// <param name="key">键</param>
|
||||
/// <returns></returns>
|
||||
T Get<T>(string key);
|
||||
|
||||
/// <summary>批量移除缓存项</summary>
|
||||
/// <param name="keys">键集合</param>
|
||||
/// <returns></returns>
|
||||
int Remove(params string[] keys);
|
||||
|
||||
/// <summary>清空所有缓存项</summary>
|
||||
void Clear();
|
||||
|
||||
/// <summary>设置缓存项有效期</summary>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="expire">过期时间</param>
|
||||
bool SetExpire(string key, TimeSpan expire);
|
||||
|
||||
/// <summary>获取缓存项有效期</summary>
|
||||
/// <param name="key">键</param>
|
||||
/// <returns></returns>
|
||||
TimeSpan GetExpire(string key);
|
||||
|
||||
/// <summary>
|
||||
/// 模糊删除
|
||||
/// </summary>
|
||||
/// <param name="pattern">匹配关键字</param>
|
||||
void DelByPattern(string pattern);
|
||||
|
||||
#endregion 基础操作
|
||||
|
||||
#region 集合操作
|
||||
|
||||
/// <summary>批量获取缓存项</summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="keys"></param>
|
||||
/// <returns></returns>
|
||||
IDictionary<string, T> GetAll<T>(IEnumerable<string> keys);
|
||||
|
||||
/// <summary>批量设置缓存项</summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="values"></param>
|
||||
/// <param name="expire">过期时间，秒。小于0时采用默认缓存时间</param>
|
||||
void SetAll<T>(IDictionary<string, T> values, int expire = -1);
|
||||
|
||||
/// <summary>获取列表</summary>
|
||||
/// <typeparam name="T">元素类型</typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <returns></returns>
|
||||
IList<T> GetList<T>(string key);
|
||||
|
||||
/// <summary>获取哈希</summary>
|
||||
/// <typeparam name="T">元素类型</typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <returns></returns>
|
||||
IDictionary<string, T> GetDictionary<T>(string key);
|
||||
|
||||
/// <summary>获取队列</summary>
|
||||
/// <typeparam name="T">元素类型</typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <returns></returns>
|
||||
IProducerConsumer<T> GetQueue<T>(string key);
|
||||
|
||||
/// <summary>获取栈</summary>
|
||||
/// <typeparam name="T">元素类型</typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <returns></returns>
|
||||
IProducerConsumer<T> GetStack<T>(string key);
|
||||
|
||||
/// <summary>获取Set</summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="key"></param>
|
||||
/// <returns></returns>
|
||||
ICollection<T> GetSet<T>(string key);
|
||||
|
||||
#endregion 集合操作
|
||||
|
||||
#region 高级操作
|
||||
|
||||
/// <summary>添加，已存在时不更新</summary>
|
||||
/// <typeparam name="T">值类型</typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">值</param>
|
||||
/// <param name="expire">过期时间，秒。小于0时采用默认缓存时间</param>
|
||||
/// <returns></returns>
|
||||
bool Add<T>(string key, T value, int expire = -1);
|
||||
|
||||
/// <summary>设置新值并获取旧值，原子操作</summary>
|
||||
/// <remarks>
|
||||
/// 常常配合Increment使用，用于累加到一定数后重置归零，又避免多线程冲突。
|
||||
/// </remarks>
|
||||
/// <typeparam name="T">值类型</typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">值</param>
|
||||
/// <returns></returns>
|
||||
T Replace<T>(string key, T value);
|
||||
|
||||
/// <summary>尝试获取指定键，返回是否包含值。有可能缓存项刚好是默认值，或者只是反序列化失败，解决缓存穿透问题</summary>
|
||||
/// <typeparam name="T">值类型</typeparam>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">值。即使有值也不一定能够返回，可能缓存项刚好是默认值，或者只是反序列化失败</param>
|
||||
/// <returns>返回是否包含值，即使反序列化失败</returns>
|
||||
bool TryGetValue<T>(string key, out T value);
|
||||
|
||||
/// <summary>累加，原子操作</summary>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">变化量</param>
|
||||
/// <returns></returns>
|
||||
long Increment(string key, long value);
|
||||
|
||||
/// <summary>累加，原子操作</summary>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">变化量</param>
|
||||
/// <returns></returns>
|
||||
double Increment(string key, double value);
|
||||
|
||||
/// <summary>递减，原子操作</summary>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">变化量</param>
|
||||
/// <returns></returns>
|
||||
long Decrement(string key, long value);
|
||||
|
||||
/// <summary>递减，原子操作</summary>
|
||||
/// <param name="key">键</param>
|
||||
/// <param name="value">变化量</param>
|
||||
/// <returns></returns>
|
||||
double Decrement(string key, double value);
|
||||
|
||||
#endregion 高级操作
|
||||
|
||||
#region 事务
|
||||
|
||||
/// <summary>提交变更。部分提供者需要刷盘</summary>
|
||||
/// <returns></returns>
|
||||
int Commit();
|
||||
|
||||
/// <summary>申请分布式锁</summary>
|
||||
/// <param name="key">要锁定的key</param>
|
||||
/// <param name="msTimeout">锁等待时间，单位毫秒</param>
|
||||
/// <returns></returns>
|
||||
IDisposable AcquireLock(string key, int msTimeout);
|
||||
|
||||
/// <summary>申请分布式锁</summary>
|
||||
/// <param name="key">要锁定的key</param>
|
||||
/// <param name="msTimeout">锁等待时间，申请加锁时如果遇到冲突则等待的最大时间，单位毫秒</param>
|
||||
/// <param name="msExpire">锁过期时间，超过该时间如果没有主动释放则自动释放锁，必须整数秒，单位毫秒</param>
|
||||
/// <param name="throwOnFailure">失败时是否抛出异常，如果不抛出异常，可通过返回null得知申请锁失败</param>
|
||||
/// <returns></returns>
|
||||
IDisposable AcquireLock(string key, int msTimeout, int msExpire,
|
||||
bool throwOnFailure);
|
||||
|
||||
#endregion 事务
|
||||
}
|
||||
Reference in New Issue
Block a user