为了统一缓存的使用,定义了统一接口ICache。在现代化应用开发中,逻辑代码注入ICache即可,具体实现由外部装配。实际上,强烈推荐使用更高一级封装的缓存架构ICacheProvider来替代直接使用ICache。

ICache的实现有:MemoryICacheNewLife.Redis、XCode.DbCache。

Nuget包:NewLife.Core

源码:https://github.com/NewLifeX/X/blob/master/NewLife.Core/Caching/ICache.cs

基础属性

名称Name用于区分不同的缓存实例。Count表示该缓存库的缓存个数。

ICache支持索引器访问和设置缓存,过期时间来自Expire。

/// <summary>名称</summary>
String Name { get; }

/// <summary>默认缓存时间。默认0秒表示不过期</summary>
Int32 Expire { get; set; }

/// <summary>获取和设置缓存,永不过期</summary>
/// <param name="key"></param>
/// <returns></returns>
Object? this[String key] { get; set; }

/// <summary>缓存个数</summary>
Int32 Count { get; }

/// <summary>所有键</summary>
ICollection<String> Keys { get; }

基础操作

最常见的操作是读写Set/Get。

/// <summary>是否包含缓存项</summary>
/// <param name="key"></param>
/// <returns></returns>
Boolean ContainsKey(String key);

/// <summary>设置缓存项</summary>
/// <param name="key">键</param>
/// <param name="value">值</param>
/// <param name="expire">过期时间,秒。小于0时采用默认缓存时间<seealso cref="Expire"/></param>
/// <returns></returns>
Boolean Set<T>(String key, T value, Int32 expire = -1);

/// <summary>设置缓存项</summary>
/// <param name="key">键</param>
/// <param name="value">值</param>
/// <param name="expire">过期时间</param>
/// <returns></returns>
Boolean Set<T>(String key, T value, TimeSpan expire);

/// <summary>获取缓存项</summary>
/// <param name="key">键</param>
/// <returns></returns>
[return: MaybeNull]
T Get<T>(String key);

/// <summary>批量移除缓存项</summary>
/// <param name="keys">键集合</param>
/// <returns></returns>
Int32 Remove(params String[] keys);

/// <summary>清空所有缓存项</summary>
void Clear();

/// <summary>设置缓存项有效期</summary>
/// <param name="key">键</param>
/// <param name="expire">过期时间</param>
Boolean SetExpire(String key, TimeSpan expire);

/// <summary>获取缓存项有效期</summary>
/// <param name="key">键</param>
/// <returns></returns>
TimeSpan GetExpire(String key);

集合操作

批量读取和设置,是高并发场景提升吞吐的关键所在。Redis中使用批量读写,每秒可读写100万次。

/// <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时采用默认缓存时间<seealso cref="Expire"/></param>
void SetAll<T>(IDictionary<String, T> values, Int32 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);

高级操作

在分布式环境中,为了避免重复处理相同数据,可以使用Add实现去重。

if(!rds.Add(key, 1, 3600)) return;

/// <summary>添加,已存在时不更新</summary>
/// <typeparam name="T">值类型</typeparam>
/// <param name="key">键</param>
/// <param name="value">值</param>
/// <param name="expire">过期时间,秒。小于0时采用默认缓存时间<seealso cref="Cache.Expire"/></param>
/// <returns></returns>
Boolean Add<T>(String key, T value, Int32 expire = -1);

/// <summary>设置新值并获取旧值,原子操作</summary>
/// <remarks>
/// 常常配合Increment使用,用于累加到一定数后重置归零,又避免多线程冲突。
/// </remarks>
/// <typeparam name="T">值类型</typeparam>
/// <param name="key">键</param>
/// <param name="value">值</param>
/// <returns></returns>
[return: MaybeNull]
T Replace<T>(String key, T value);

/// <summary>尝试获取指定键,返回是否包含值。有可能缓存项刚好是默认值,或者只是反序列化失败,解决缓存穿透问题</summary>
/// <typeparam name="T">值类型</typeparam>
/// <param name="key">键</param>
/// <param name="value">值。即使有值也不一定能够返回,可能缓存项刚好是默认值,或者只是反序列化失败</param>
/// <returns>返回是否包含值,即使反序列化失败</returns>
Boolean TryGetValue<T>(String key, [MaybeNull] out T value);

/// <summary>获取 或 添加 缓存数据,在数据不存在时执行委托请求数据</summary>
/// <typeparam name="T"></typeparam>
/// <param name="key"></param>
/// <param name="callback"></param>
/// <param name="expire">过期时间,秒。小于0时采用默认缓存时间<seealso cref="Cache.Expire"/></param>
/// <returns></returns>
[return: MaybeNull]
T GetOrAdd<T>(String key, Func<String, T> callback, Int32 expire = -1);

/// <summary>累加,原子操作</summary>
/// <param name="key">键</param>
/// <param name="value">变化量</param>
/// <returns></returns>
Int64 Increment(String key, Int64 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>
Int64 Decrement(String key, Int64 value);

/// <summary>递减,原子操作</summary>
/// <param name="key">键</param>
/// <param name="value">变化量</param>
/// <returns></returns>
Double Decrement(String key, Double value);

事务

分布式锁使用AcquireLock。

/// <summary>提交变更。部分提供者需要刷盘</summary>
/// <returns></returns>
Int32 Commit();

/// <summary>申请分布式锁</summary>
/// <param name="key">要锁定的key</param>
/// <param name="msTimeout">锁等待时间,单位毫秒</param>
/// <returns></returns>
IDisposable? AcquireLock(String key, Int32 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, Int32 msTimeout, Int32 msExpire, Boolean throwOnFailure);

作者:大石头 发布:2023-11-22 21:20:19 浏览:449)