using StackExchange.Redis; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace OASystem.RedisRepository.RedisAsyncHelper { /// /// 异步方法接口 /// 存入数据均为方法内部序列化后的byte,所以取数据的时候需要反序列化时,请指定正确的数据类型 /// public partial interface IRedisHelper { #region Redis数据类型—String /// /// 将任何数据以redis string存储 /// /// /// /// /// /// Task StringSetAsync(string key, T value, TimeSpan? timeout = null); /// /// 对数值进行减法操作,默认-1 /// /// /// /// 操作后的结果 Task StringDecrementAsync(string key, long value = 1L); /// /// 对数值进行加法操作,默认+1 /// /// /// /// 操作后的结果 Task StringIncrementAsync(string key, long value = 1L); /// /// 从redis string中以指定类型取出 /// /// /// /// Task StringGetAsync(string key); #endregion #region Redis数据类型—Hash /// /// 向Hash key中存储任意类型任意值 /// /// /// /// /// /// 是否成功 Task HashSetAsync(string key, string field, T value); /// /// 批量 向Hash key中存储任意类型任意值 /// /// /// /// /// 无返回值 Task HashMultiSetAsync(string key, Dictionary hashFields); /// /// 对指定hash key中制定field做数量增加操作 默认自增1 /// 如果此操作前key不存在 则创建。 如果此操作前该field不存在或者非数字 则先被置0,再被继续操作 /// /// /// /// /// 操作后的结果 Task HashIncrementAsync(string key, string field, long incrCount = 1); /// /// 对指定hash key中制定field做数量增加操作 默认自减1 /// 如果此操作前key不存在 则创建。 如果此操作前该field不存在或者非数字 则先被置0,再被继续操作 /// /// /// /// /// 操作后的结果 Task HashDecrementAsync(string key, string field, long decrCount = 1); /// /// 从指定Hash中 删除指定field /// 如果key或者field不存在,则false /// /// /// /// 是否成功 Task HashDeleteFieldAsync(string key, string field); /// /// 从指定Hash key中 批量删除指定field /// 如果key或者field不存在,则false /// /// /// /// 移除数量 Task HashMultiDeleteFieldAsync(string key, List fields); /// /// 从指定Hash key中获取指定field值 /// /// /// /// /// Task HashGetAsync(string key, string field); /// /// 从指定Hash key中判断field是否存在 /// /// /// /// Task HashFieldExistAsync(string key, string field); /// /// 获取指定Hash key中的所有field的值 /// /// /// /// Task> HashValuesAsync(string key); /// /// 获取指定Hash key中所有 field名称及其Value /// /// /// /// Task> HashGetAllAsync(string key); /// /// 获取指定Hash key中所有field /// /// /// Task> HashFieldsAsync(string key); #endregion #region Redis数据类型—List /// /// 在指定pivot后插入value, 如果pivot不存在,则返回-1, 如果key不存在,则返回0 /// 如果存在多个相同指定的的pivot,则插入第一个指定pivot后面. /// 即链表从左向右查找,遇到指定pivot,则确定位置 /// /// /// /// list中的一个值 /// /// Task ListInsertAfterAsync(string key, string pivot, T value); /// /// 在指定pivot前插入value, 如果pivot不存在,则返回-1, 如果key不存在,则返回0 /// 如果存在多个相同指定的的pivot,则插入第一个指定pivot前面. /// 即链表从左向右查找,遇到指定pivot,则确定位置 /// /// /// /// /// /// Task ListInsertBeforeAsync(string key, string pivot, T value); /// /// 从链表左侧弹出第一个元素(弹出能获取到该元素并且被删除) /// 如果key不存在 或者链表为空 则为null /// /// /// /// Task ListLeftPopAsync(string key); /// /// 从链表左侧增加一个元素,key不存在则被创建 /// /// /// /// /// 返回操作后的链表长度 Task ListLeftPushAsync(string key, T value); /// /// 从链表左侧批量增加元素,如果 a b c 则c会在链表左侧第一位 b第二位 a第三位 /// /// /// /// /// 返回操作后的链表长度 Task ListLeftMultiPushAsync(string key, List values); /// /// 获取链表长度,不存在key则为0 /// /// /// /// Task ListLengthAsync(string key); /// /// 获取链表中所有数据,从左侧start开始到stop结束,从0—-1则认为获取全部,默认获取全部 /// start为负数则代表从链表右侧开始,-1为右侧第一位,-2为右侧第二位 /// start要小于stop,否则返回null /// /// /// /// /// /// Task> ListRangeAsync(string key, long start = 0L, long stop = -1L); /// /// 从链表中一处count数量的value. count大于0则从左至右,count小于0则从右至左,count=0则移除全部 /// /// /// /// /// /// Task ListRemoveAsync(string key, T value, long count = 0L); /// /// 从右侧弹出第一个元素(弹出能获取到该元素并且被删除) /// /// /// /// Task ListRightPopAsync(string key); /// /// 从链表右侧加入元素,如果 rpush a b c 则c为右侧第一位 b第二位 c第三位 /// /// /// /// /// Task ListRightPushAsync(string key, T value); /// /// 从右侧批量插入,和左侧相反 /// /// /// /// /// Task ListRightMultiPushAsync(string key, List values); /// /// 在链表指定索引处,插入元素 /// 正数索引从0开始,代表左侧。负数从-1开始 代表从右侧。-1为右侧第一位 /// /// /// /// /// /// Task ListSetByIndexAsync(string key, int index, T value); /// /// 留下start到stop之间的数据。负数代表从右侧寻找 -1为右侧第一位 /// /// /// /// /// Task ListTrimAsync(string key, long start, long stop); /// /// 获取指定index的值,负数代表从右侧寻找 -1为右侧第一位 /// /// /// /// /// Task ListGetByIndexAsync(string key, long index); #endregion #region Redis数据类型—Set /// /// 向指定集合中增加一个元素 /// /// /// /// /// Task SetAddAsync(string key, T value); ///// ///// 指定集合计算操作operation枚举,指定计算结果将存的目标destKey,指定需要参与计算的多个key ///// ///// ///// ///// ///// //Task SetCombineAndStoreAsync(SetOperation operation, string destKey, List combineKeys); ///// ///// 指定集合计算操作operation枚举,指定需要参与计算的多个key ///// ///// ///// ///// ///// //Task> SetCombineAsync(SetOperation operation, List combineKeys); ///// ///// 指定值是否存在于指定集合中 ///// ///// ///// ///// ///// //Task SetContainsAsync(string key, T value); ///// ///// 获取指定集合中元素个数 ///// ///// ///// //Task SetLengthAsync(string key); ///// ///// 获取指定集合中的所有元素 ///// ///// ///// ///// ///// //Task> SetMembersAsync(string key, T value); ///// ///// 从sourceKey移除指定value到目标distKey集合当中 ///// 如果sourceKey存在指定value则返回true,否则不做任何操作返回false ///// ///// ///// ///// ///// ///// //Task SetMoveAsync(string sourcekey, string distKey, T value); ///// ///// 从指定集合当中随机取出一个元素 ///// ///// ///// ///// //Task SetRandomMemberAsync(string key); ///// ///// 从指定集合随机弹出(删除并获取)一个元素 ///// ///// ///// ///// //Task SetPopAsync(string key); ///// ///// 从集合中随机弹出(删除并获取)多个元素 ///// ///// ///// ///// //Task> SetRandomMembersAsync(string key); ///// ///// 从集合中移除指定元素 ///// ///// ///// ///// ///// //Task SetRemoveAsync(string key, T value); ///// ///// 从集合中批量移除元素 ///// ///// ///// ///// ///// //Task SetMultiRemoveAsync(string key, List values); #endregion #region Redis数据类型—SortSet #endregion #region Redis Key操作 /// /// 删除指定key /// /// /// Task KeyDeleteAsync(string key); /// /// 设置key过期时间具体DateTime /// /// /// /// //Task KeyExpireAtAsync(string key, DateTime expireAt); /// /// 设置key在将来的timeout后过期(TimeSpan) /// /// /// /// Task KeyExpireInAsync(string key, TimeSpan timeout); /// /// key重命名 /// /// /// /// Task KeyRenameAsync(string key, string newKey); /// /// 判断key是否已存在 /// /// /// Task KeyExistsAsync(string key); #endregion #region Redis Transcation /// /// 在事务中执行一系列redis命令。注意:在委托中的一系列命令的所有 值 都需要进行字节数组序列化 /// /// /// //Task DoInTranscationAsync(Action ranOperations); #endregion } }