134 lines
3.9 KiB
C#
134 lines
3.9 KiB
C#
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);
|
||
} |