using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using NewLife;
using NewLife.Log;
using NewLife.Threading;
namespace XCode.Cache
{
/// <summary>单对象缓存</summary>
/// <remarks>
/// 用一个值为实体的字典作为缓存(键一般就是主键),适用于单表大量互相没有关系的数据。
/// </remarks>
/// <typeparam name="TKey">键值类型</typeparam>
/// <typeparam name="TEntity">实体类型</typeparam>
public class SingleEntityCache<TKey, TEntity> : CacheBase<TEntity>, ISingleEntityCache<TKey, TEntity> where TEntity : Entity<TEntity>, new()
{
#region 属性
/// <summary>过期时间。单位是秒,默认60秒</summary>
public Int32 Expire { get; set; }
/// <summary>最大实体数。默认10000</summary>
public Int32 MaxEntity { get; set; } = 10000;
/// <summary>是否在使用缓存</summary>
public Boolean Using { get; private set; }
#endregion
#region 主键
/// <summary>获取缓存主键的方法,默认方法为获取实体主键值</summary>
public Func<TEntity, TKey> GetKeyMethod { get; set; }
/// <summary>查找数据的方法</summary>
public Func<TKey, TEntity> FindKeyMethod { get; set; }
#endregion
#region 从键
/// <summary>从键是否区分大小写</summary>
public Boolean SlaveKeyIgnoreCase { get; set; }
/// <summary>根据从键查找数据的方法</summary>
public Func<String, TEntity> FindSlaveKeyMethod { get; set; }
/// <summary>获取缓存从键的方法,默认为空</summary>
public Func<TEntity, String> GetSlaveKeyMethod { get; set; }
#endregion
#region 构造、检查过期缓存
/// <summary>实例化一个实体缓存</summary>
public SingleEntityCache()
{
var exp = Setting.Current.SingleCacheExpire;
if (exp <= 0) exp = 60;
Expire = exp;
var fi = Entity<TEntity>.Meta.Unique;
if (fi != null) GetKeyMethod = entity => (TKey)entity[Entity<TEntity>.Meta.Unique.Name];
FindKeyMethod = key => Entity<TEntity>.FindByKey(key);
}
/// <summary>子类重载实现资源释放逻辑时必须首先调用基类方法</summary>
/// <param name="disposing">从Dispose调用(释放所有资源)还是析构函数调用(释放非托管资源)。
/// 因为该方法只会被调用一次,所以该参数的意义不太大。</param>
protected override void OnDispose(Boolean disposing)
{
base.OnDispose(disposing);
try
{
var reason = GetType().Name + (disposing ? "Dispose" : "GC");
Clear(reason);
}
catch (Exception ex)
{
XTrace.WriteException(ex);
}
_Timer.TryDispose();
}
private TimerX _Timer;
private void CheckExpire(Object state)
{
var es = Entities;
if (es == null) return;
// 找到所有严重过期的缓存项
var exp = DateTime.Now.AddSeconds(-600);
var list = new List<CacheItem>();
lock (es)
{
foreach (var item in es)
{
if (item.Value.ExpireTime < exp) list.Add(item.Value);
}
foreach (var item in list)
{
es.Remove(item.Key);
}
}
// 删除从表
var ses = _SlaveEntities;
if (ses != null && list.Count > 0)
{
lock (ses)
{
foreach (var item in list)
{
if (!item.SlaveKey.IsNullOrEmpty()) ses.Remove(item.SlaveKey);
}
}
}
}
#endregion
#region 缓存对象
/// <summary>缓存对象</summary>
class CacheItem
{
//private SingleEntityCache<TKey, TEntity> Cache { get; }
/// <summary>键</summary>
public TKey Key { get; set; }
/// <summary>从键</summary>
public String SlaveKey { get; set; }
/// <summary>实体</summary>
public TEntity Entity { get; set; }
/// <summary>缓存过期时间</summary>
public DateTime ExpireTime { get; set; }
///// <summary>下一次保存的时间</summary>
//public DateTime NextSave { get; set; }
/// <summary>是否已经过期</summary>
public Boolean Expired { get { return ExpireTime <= DateTime.Now; } }
//public CacheItem(SingleEntityCache<TKey, TEntity> sc) { Cache = sc; }
public void SetEntity(TEntity entity, Int32 expire)
{
Entity = entity;
ExpireTime = DateTime.Now.AddSeconds(expire);
//NextSave = ExpireTime;
}
}
#endregion
#region 单对象缓存
/// <summary>单对象缓存</summary>
private Dictionary<TKey, CacheItem> Entities = new Dictionary<TKey, CacheItem>();
private Dictionary<String, CacheItem> _SlaveEntities;
/// <summary>单对象缓存,从键查询使用</summary>
private Dictionary<String, CacheItem> SlaveEntities
{
get
{
if (_SlaveEntities == null)
{
Dictionary<String, CacheItem> dic;
if (SlaveKeyIgnoreCase)
dic = new Dictionary<String, CacheItem>(StringComparer.OrdinalIgnoreCase);
else
dic = new Dictionary<String, CacheItem>();
if (Interlocked.CompareExchange(ref _SlaveEntities, dic, null) != null)
dic = null;
}
return _SlaveEntities;
}
}
#endregion
#region 统计
/// <summary>总次数</summary>
public Int32 Total;
/// <summary>命中</summary>
public Int32 Success;
/// <summary>显示统计信息</summary>
public void ShowStatics()
{
if (Total > 0)
{
var sb = new StringBuilder();
var name = "<{0},{1}>({2})".F(typeof(TKey).Name, typeof(TEntity).Name, Entities.Count);
sb.AppendFormat("单对象缓存{0,-20}", name);
sb.AppendFormat("总次数{0,7:n0}", Total);
if (Success > 0) sb.AppendFormat(",命中{0,7:n0}({1,6:P02})", Success, (Double)Success / Total);
XTrace.WriteLine(sb.ToString());
}
}
#endregion
#region 获取数据
/// <summary>根据主键获取实体数据</summary>
/// <param name="key"></param>
/// <returns></returns>
public TEntity this[TKey key] { get { return GetItem(Entities, key); } set { Add(key, value); } }
private TEntity GetItem<TKey2>(IDictionary<TKey2, CacheItem> dic, TKey2 key)
{
// 为空的key,直接返回null,不进行缓存查找
if (key == null) return null;
// 更新统计信息
CheckShowStatics(ref Total, ShowStatics);
// 如果找到项,返回
// 如果TryGetValue获取成功,item为空说明同一时间别的线程已做删除操作
if (dic.TryGetValue(key, out var item) && item != null && !item.Expired) return GetData(item);
lock (dic)
{
// 再次尝试获取
if (dic.TryGetValue(key, out item) && item != null) return GetData(item);
// 开始更新数据,然后加入缓存
TEntity entity = null;
if (dic == Entities)
entity = Invoke(FindKeyMethod, (TKey)(Object)key);
else
entity = Invoke(FindSlaveKeyMethod, key + "");
if (entity != null) TryAdd(entity);
return entity;
}
}
/// <summary>尝试向两个字典加入数据</summary>
/// <param name="entity"></param>
/// <returns></returns>
private Boolean TryAdd(TEntity entity)
{
//if (!Using)
{
Using = true;
//WriteLog("单对象缓存首次使用 {0} {1}", typeof(TEntity).FullName, XTrace.GetCaller(1, 16));
if (_Timer == null)
{
// 启动一个定时器,用于定时清理过期缓存。因为比较耗时,最后一个参数采用线程池
_Timer = new TimerX(CheckExpire, null, Expire * 1000, Expire * 1000, "SC");
_Timer.Async = true;
}
}
var item = new CacheItem();
var skey = GetSlaveKeyMethod?.Invoke(entity);
var mkey = GetKeyMethod(entity);
item.Key = mkey;
item.SlaveKey = skey;
item.SetEntity(entity, Expire);
var success = false;
var es = Entities;
lock (es)
{
if (!es.ContainsKey(mkey))
{
// 如果满了,删除前面一个
while (MaxEntity > 0 && es.Count >= MaxEntity)
{
var key = es.Keys.First();
RemoveKey(key);
//WriteLog("单对象缓存满,删除{0}", key);
}
es.Add(mkey, item);
success = true;
}
}
if (success && !skey.IsNullOrWhiteSpace())
{
var ses = SlaveEntities;
lock (ses)
{
// 新增或更新
ses[skey] = item;
}
}
return success;
}
/// <summary>根据从键获取实体数据</summary>
/// <param name="slaveKey"></param>
/// <returns></returns>
public TEntity GetItemWithSlaveKey(String slaveKey) { return GetItem(SlaveEntities, slaveKey); }
/// <summary>内部处理返回对象。
/// 把对象传进来,而不是只传键值然后查找,是为了避免别的线程移除该项
/// </summary>
/// <remarks>此方法只做更新操作,不再进行缓存新增操作</remarks>
/// <param name="item"></param>
/// <returns></returns>
private TEntity GetData(CacheItem item)
{
if (item == null) return null;
Interlocked.Increment(ref Success);
// 异步更新缓存
//var tid = Thread.CurrentThread.ManagedThreadId;
if (item.Expired) Task.Run(() =>
{
// 先修改过期时间
item.ExpireTime = DateTime.Now.AddSeconds(Expire);
// 更新过期缓存,在原连接名表名里面获取
var entity = Invoke(FindKeyMethod, item.Key);
if (entity != null)
item.SetEntity(entity, Expire);
else
// 数据库查不到,说明该数据可能已经被删除
RemoveKey(item.Key);
});
return item.Entity;
}
#endregion
#region 方法
/// <summary>是否包含指定键</summary>
/// <param name="key"></param>
/// <returns></returns>
public Boolean ContainsKey(TKey key) { return Entities.ContainsKey(key); }
/// <summary>是否包含指定从键</summary>
/// <param name="key"></param>
/// <returns></returns>
public Boolean ContainsSlaveKey(String key) { return SlaveEntities.ContainsKey(key); }
/// <summary>向单对象缓存添加项</summary>
/// <param name="key"></param>
/// <param name="entity">数值</param>
/// <returns></returns>
Boolean Add(TKey key, TEntity entity)
{
var es = Entities;
// 如果找到项,返回
CacheItem item = null;
lock (es)
{
if (!es.TryGetValue(key, out item) || item == null) return TryAdd(entity);
item.SetEntity(entity, Expire);
return false;
}
}
/// <summary>移除指定项</summary>
/// <param name="key">键值</param>
private void RemoveKey(TKey key)
{
var es = Entities;
if (!es.TryGetValue(key, out var item)) return;
lock (es)
{
if (!es.TryGetValue(key, out item)) return;
es.Remove(key);
}
if (item != null && !item.SlaveKey.IsNullOrWhiteSpace())
{
lock (SlaveEntities)
{
SlaveEntities.Remove(item.SlaveKey);
}
}
}
/// <summary>根据主键移除指定项</summary>
/// <param name="entity"></param>
public void Remove(TEntity entity)
{
if (entity == null) return;
var key = GetKeyMethod(entity);
RemoveKey(key);
}
/// <summary>清除所有数据</summary>
/// <param name="reason">清除缓存原因</param>
public void Clear(String reason)
{
if (!Using) return;
WriteLog("清空单对象缓存:{0} 原因:{1} Using = false", typeof(TEntity).FullName, reason);
var es = Entities;
if (es == null) return;
// 不要清空单对象缓存,而是设为过期
lock (es)
{
foreach (var item in es)
{
item.Value.ExpireTime = DateTime.Now.AddSeconds(-1);
}
}
Using = false;
}
#endregion
#region ISingleEntityCache 成员
/// <summary>获取数据</summary>
/// <param name="key"></param>
/// <returns></returns>
IEntity ISingleEntityCache.this[Object key] { get { return GetItem(Entities, (TKey)key); } }
/// <summary>根据从键获取实体数据</summary>
/// <param name="slaveKey"></param>
/// <returns></returns>
IEntity ISingleEntityCache.GetItemWithSlaveKey(String slaveKey) { return GetItemWithSlaveKey(slaveKey); }
/// <summary>是否包含指定主键</summary>
/// <param name="key"></param>
/// <returns></returns>
Boolean ISingleEntityCache.ContainsKey(Object key) { return ContainsKey((TKey)key); }
/// <summary>移除指定项</summary>
/// <param name="entity"></param>
void ISingleEntityCache.Remove(IEntity entity) { Remove(entity as TEntity); }
/// <summary>向单对象缓存添加项</summary>
/// <param name="value">实体对象</param>
/// <returns></returns>
Boolean ISingleEntityCache.Add(IEntity value)
{
if (!Using) return false;
var entity = value as TEntity;
if (entity == null) return false;
var key = GetKeyMethod(entity);
return Add(key, entity);
}
#endregion
#region 辅助
internal SingleEntityCache<TKey, TEntity> CopySettingFrom(ISingleEntityCache<TKey, TEntity> ec)
{
this.Expire = ec.Expire;
this.MaxEntity = ec.MaxEntity;
this.GetKeyMethod = ec.GetKeyMethod;
this.FindKeyMethod = ec.FindKeyMethod;
this.SlaveKeyIgnoreCase = ec.SlaveKeyIgnoreCase;
this.GetSlaveKeyMethod = ec.GetSlaveKeyMethod;
this.FindSlaveKeyMethod = ec.FindSlaveKeyMethod;
return this;
}
/// <summary>已重载。</summary>
/// <returns></returns>
public override String ToString()
{
return "SingleEntityCache<{0}, {1}>[{2}]".F(typeof(TKey).Name, typeof(TEntity).Name, Entities.Count);
}
#endregion
}
}
|