【PaPaPa】实现缓存决策

我有话说

 本来这一篇我打算放到后面再说，可是之前泄漏了一点关于缓存决策的代码后被好多人催更了。

 在此感谢大家的支持，让我更有动力的写这个系列。你们的关注让我觉得我的决定是对的，我会坚持下去把这个项目做完。

 另外非常感谢老虎，在百忙之中给我们赶出需求文档，当我们在享受周末的时候他还在公司加班，即便这样，他依然为我们的开源项目奉献着。

 此时我不知道该说些什么，只能以我的行动来回报大家，废话不多说了，入正题。

缓存决策

 先澄清下，这个名字是我杜撰的，因为我觉得在我的项目中它起到了这样的作用。

 缓存：在我做的这个功能中涉及到内存和redis两部分的缓存。

 决策：我从百度找的翻译，指做出决定或选择,是一种“在各种替代方案中考虑各项因素作出选择”的认知、思考过程。

 那么缓存决策到底是干什么的？

 说白了就是选择使用数据库还是缓存。

如何适合缓存决策

缓存决策的由来 - 我是懒人

 因为我懒，所以我要想办法偷懒。

 我希望有一个类库可以帮助我来判断当前的数据是到缓存里取，还是数据库里取。

 而为了实现这样的一个功能，我觉得我应该建立一个规则，这个规则来帮助我判断当前数据在缓存里是不是有一份拷贝。

我对缓存的判断规则有什么要求？

 就以目前项目来说，我缓存是整表缓存的，所以我需要判断的是当前数据是属于哪个表。

 既然如此，那我判断的依据应该是这样： 缓存决策规则.表名列表.包含(数据.表名) == true

 只要满足上面的条件，说明当前数据在缓存里是有拷贝的。

如何管理这些判断规则？

 继续上面提到的包含，我们再分析一下，包含的判断依据其实是逐一比对相等，所以我想了个类名：EqualsMonitorManager，这里的Monitor是监视器的意思，后面的类都会跟这个词有关。

 这个类有4个基本的方法：Add、Remove、Get、IsMonitoring ，看起来其实是很像字典的对吧？其实内部实现确实依赖了字典，对字典做了一些封装。

 为了方面以后扩展支持到更多场景而不局限于缓存，我定义的时候使用到了泛型。

    public static partial class EqualsMonitorManager<TKey, TValue>
        where TValue : IEquatable<TValue>
    {
        private static class MonitorCaller<TCallerKey>
        {
            public static Action<TCallerKey, TValue> Add;

            public static Action<TCallerKey> Remove;

            public static Func<TCallerKey, Func<TValue, bool>, TValue> Get;

            public static Func<TCallerKey, TValue, bool> IsMonitoring;
        }

        #region Members

        private static Dictionary<string, List<TValue>> _dicStringMonitor = new Dictionary<string, List<TValue>>();

        #endregion

        static EqualsMonitorManager()
        {
            StringMonitorCallerInit();
        }

        private static void StringMonitorCallerInit()
        {
            MonitorCaller<string>.Add = (string key, TValue value) =>
            {
                if (!_dicStringMonitor.ContainsKey(key))
                {
                    _dicStringMonitor.Add(key, new List<TValue>());
                }

                _dicStringMonitor[key].Add(value);
            };

            MonitorCaller<string>.Remove = (string key) =>
            {
                if (_dicStringMonitor.ContainsKey(key))
                    _dicStringMonitor.Remove(key);
            };

            MonitorCaller<string>.Get = (string key, Func<TValue, bool> predicate) =>
            {
                if (_dicStringMonitor.ContainsKey(key))
                    return _dicStringMonitor[key].FirstOrDefault(predicate);
                else
                    return default(TValue);
            };

            MonitorCaller<string>.IsMonitoring = (string key, TValue value) =>
            {
                if (!_dicStringMonitor.ContainsKey(key))
                {
                    return false;
                }

                return _dicStringMonitor[key].Exists(x => x.Equals(value));
            };
        }
    }

    public static partial class EqualsMonitorManager<TKey, TValue>
    {
        public static void Add(TKey key, TValue value)
        {
            if (key == null)
            {
                throw new ArgumentNullException();
            }
            MonitorCaller<TKey>.Add(key, value);
        }

        public static void Remove(TKey key)
        {
            if (key == null)
            {
                throw new ArgumentNullException();
            }
            MonitorCaller<TKey>.Remove(key);
        }

        public static TValue Get(TKey key, Func<TValue, bool> predicate)
        {
            if (key == null)
            {
                throw new ArgumentNullException();
            }
            return MonitorCaller<TKey>.Get(key, predicate);
        }

        public static bool IsMonitoring(TKey key, TValue value)
        {
            if (key == null)
            {
                throw new ArgumentNullException();
            }

            return MonitorCaller<TKey>.IsMonitoring(key, value);
        }
    }

这里的代码用到了老赵博客中的一篇关于“逆泛型”的代码，这里是未经优化的，写的仓促。

这里我就不多解释为什么会这么写这个类了，有兴趣可以去翻老赵的博客，写的很详细，对于初学者来说这里有点绕，建议可以去看看。

这里只是创建了一个最基础的封装过的“字典”，用于管理判断规则。

初始化判断规则

 有了管理规则的类，那么我们的项目中首先要做的就是初始化这些规则，否则没有规则后面的写下去也用不了。

 细心的朋友可能会发现，EqualsMonitorManager的TValue需要继承自IEquatable接口，因为内部判断相等是用了这个接口的Equals方法。

 那么，我们第一个缓存决策类出现了，它就是RedisCacheMonitor。

 

    public class RedisCacheMonitor : IEquatable<RedisCacheMonitor>
    {
        public string Key { get { return MonitorConstant.REDIS_KEY; } }

        public string TableName { get; set; }

        public string[] Fields { get; set; }

        #region IEquatable<RedisCacheMonitor> 成员

        public bool Equals(RedisCacheMonitor other)
        {
            if (other == null)
            {
                return false;
            }

            return this.TableName == other.TableName;
        }

        #endregion
    }

我们可以发现，这个类的自由度很大，唯一的约束就是要实现IEquatable接口，这样EqualMonitorManager的可扩展性就充分被利用了起来。
而RedisCacheMonitor就可以任由我们来发挥，我们只需要告诉EqualMonitorManager如何去判断相等即可。

TableName表示缓存的表名，Fields是使用了Redis HGet命令的一个参数名，表示哪些字段可以作为关键字来查询数据或者说需要缓存哪些字段为关键字。

接下来就是如何把一个RedisCacheMonitor加入到EqualMonitorManager

var monitor = new RedisCacheMonitor() { TableName = "User", Fields = new string[] { "Id", "UserName" } };
EqualsMonitorManager<string, RedisCacheMonitor>.Add(monitor.Key, monitor);

是的，就这么简单，我们的缓存规则就加完了。剩下就是操作Redis，把User表缓存起来我就不多说了。

自动缓存决策与手动缓存决策

为什么会有自动和手动两种？

 因为我操作数据库用的EF，查询条件是表达式树，为了降低解析表达式树的工作量暂时选择了自动和手动。

如何实现手动缓存决策？

var monitor = EqualsMonitorManager<string, RedisCacheMonitor>.Get(MonitorConstant.REDIS_KEY, x => x.TableName == tableName);

if (monitor != null)
{
    //todo something
}

手动决策很简单，只要尝试获取一下即可，获取到monitor就说明被缓存了，下面就可以直接取缓存了。

如何实现自动缓存决策？

 看到第一篇的应该对下面的代码有印象，我把之前写的内容直接copy过来一份：

 SaveChangesAsync是EF的异步保存方法，我们要做的事情其实很简单，就是拦截保存方法，代码中是SaveAsync，这个是我们自己针对EF封装后的方法。

 大概思路是这样的：

 想要让 SaveAsync 听我们的话， override 就派上了用场，重写 SaveAsync。

 调用基类的 SaveAsync 后，再加上保存到Redis的代码。

 这样一个SaveAsync就变成了做2件事，先保存到数据库再保存到Redis，从而杜绝了代码中到处写保存到Redis的重复代码。

    public class DataWrapper<T> : EFWrapperBase<T>
        where T : class,new()
    {
        public DataWrapper()
        {
            base.Context.EventRegistModel += ModelRegister.Regist;
        }

        public override async Task<int> SaveAsync()
        {
            var result = await base.SaveAsync();

            SaveToRedis();

            return result;
        }

        private void SaveToRedis()
        {
            try
            {
                var type = typeof(T);
                var monitor = EqualsMonitorManager<string, RedisCacheMonitor>.Get(MonitorConstant.REDIS_KEY, x => x.TableName == type.Name);
                if (monitor != null)
                {
                    foreach (var entity in base.DbSet.Local)
                    {
                        foreach (var field in monitor.Fields)
                        {
                            var pi = type.GetProperty(field);
                            RedisSingleton.GetInstance.Client.HSet(type.Name, string.Format("{0}:{1}", pi.Name, pi.GetValue(entity, null).ToString()), entity);
                        }
                    }
                }
            }
            catch (Exception ex)
            {
                Logger.Error(ex.ToString());
            }
        }

    }

源码

 源码地址：http://git.oschina.net/doddgu/PaPaPa

 PS：其实想想真的不难，主要是一种思路，用到的都是基本的C#语法，关键在于你敢不敢想，而我敢想了，你还在犹豫吗？后面我们会有更多敢想敢做的事，欢迎你的加入。