.NET 缓存模块设计实践

上一篇谈了我对缓存的概念，框架上的理解和看法，这篇承接上篇讲讲我自己的缓存模块设计实践。 

基本的缓存模块设计
最基础的缓存模块一定有一个统一的cachehelper，如下: 

  public interface icachehelper
  {   
    t get<t>(string key);
        
    void set<t>(string key, t value);   

    void remove(string key);        
  }

然后业务层是这样调用的 

  public user get(int id)
    {
      if (id <= 0)
        throw new argumentnullexception("id");

      var key = string.format(user_cache_key, id);
      var user = _cachehelper.get<user>(key);
      if (user != null)
        return user;

      return _repository.get(id);
    }  

上面的代码没什么错误，但是实际运用的时候就产生疑问了，因为我一直强调缓存要保存"热数据"，那样"热数据"一定会有过期的时候，我们不可能另外写一个去set。所以干脆就结合到一起写是比较合适的。 

public user getv2(int id)
{
  if (id <= 0)
    throw new argumentnullexception("id");

  var key = string.format(user_cache_key, id);
  var user = _cachehelper.get<user>(key);
  if (user != null)
    return user;
    user = _repository.get(id);
  if (user != null)
    _cachehelper.set(key, user);
    return user;
}

上面的代码其实只是加了一个set而已，就这样的设计的话，每次一个get需要的重复代码实在是太多了，那么是不是应该更精简？这时候吃点c#语法糖就很有必要了，语法糖偶尔吃点增进效率，何乐而不为？ 

public user getv3(int id)
{
   if (id <= 0)
     throw new argumentnullexception("id");

   var key = string.format(user_cache_key, id);
    return _cachehelperv2.get<user>(key, () => _repository.get(id));      
}

//icache get<t>实现
public t get<t>(string key, func<t> fetch = null)
{
  t result = default(t);
  var obj = cache.get(key);
  if (obj is t)
  {
    result = (t)obj;
  }

  if(result == null)
  {
    result = fetch();

    if (result != null)
      set(key, result);
  }

  return result;
}      

这里我直接把set方法都包装进了icache.get<t>，附带上fetch func。这样就把公共的操作抽象到了一起，简化了cache的调用，完美的符合了我的想法。

缓存模块设计进阶
上一节里的icache v3几乎已经最精简了，但是其实参考了servicestack.redis之后，我发现了更加的抽象方式。很明显上一节的所有代码里，都是手动管理key的，对于通常的对象cache，这个key还需要手动吗?来上最后一份改进。 

public t get<t>(object id, func<t> fetch = null)
{
  var type = typeof(t);
  var key = string.format("urn:{1}:{2}", type.name, id.tostring());//这里是关键，直接用typename来充当key

  return get(key, fetch);
}

public t get<t>(string key, func<t> fetch = null)
{
  t result = default(t);

  var obj = cache.get(key);
  if (obj is t)
  {
    result = (t)obj;
  }

  if (result == null)
  {
    result = fetch();

    if (result != null)
      set(key, result);
   }

   return result;
}

get方法完全自动化管理了key，然后调用的方式再次被精简。

public user getv4(int id)
{
   if (id <= 0)
    throw new argumentnullexception("id");

   return _cachehelperv3.get<user>(id, () => _repository.get(id));
}

很明显还少了最重要的set啊，set的时候这个key获取就要费一点事情了，最需要 解决的是如何获取这个主键id的值。 

public class user
{
    [primarykey] //这个attribute是最重要的东西
    public int userid { get; set;}

    public string username { get; set; }

    public string cellphone { get; set; }
}
public void set<t>(t obj)
{
   //此处应该被缓存以提高反射的效率
   var type = typeof(t);
   var primarykey = type.getproperties()
        .firstordefault(t => t.getcustomattributes(false)
          .any(c => c is primarykeyattribute));//这里通过取primarykeyattribute来获取id的value
    var keyvalue = primarykey.getvalue(obj, null);      
    var key = string.format("urn:{0}:{1}", type.name, keyvalue);

    var dt = datetime.utcnow.adddays(1);//假设默认缓存1天
    var offset = new datetimeoffset(dt);
    cache.set(key, obj, offset);
}

到这里，我想到的最终版本的icache就完成了。这里还需要说明的是其实primarykey可以更加灵活多变。很多时候一个object的primarykey是很复杂的，这时候设计cache实体的时候可以变通下：

public class usercacheentity
{
    [primarykey]
    public int id
    {
      get
      {
        return string.format("{0}:{1}", userid, username);
      }
    }

    public int userid { get; set; }

    public string username { get; set; }

    public string cellphone { get; set; }
}

上面的方式几乎可以自动管理常见的数据cache了，唯一麻烦的是 需要自定义一个cacheobject，这样就带来了实体转换的麻烦，这时候就要看怎么取舍了。
 再次说明下我想要的icache设计： 

1. 永远只cache热数据，这意味着每个key都要有过期时间 
2. icache自动管理get/set，最好能自动管理key。 
3. icache精简同时又不失灵活。 
详细的代码demo可以参考：git

更灵活的实现 
我在写这篇总结之前，也一直在思考cache应该放到什么层，普通三层的时候放哪里？ddd那样分层的时候又放哪里。google了下，看到了一些参考。 
 
我觉得这里比较符合我的想法，cache应该是全局任意的，当然实现起来当然是interface+ioc，这样引用起来更加的独立一些。 
另外还有cache更加高级的使用，aop结合icache v4这样的设计，岂不是更好？这里我还没有去实现aop的attribute，这又是一个大话题的，下次再来实现吧。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。