团队开发框架实战—缓存管理

团队开发框架实战—缓存管理

WEB 缓存

缓存它是一种空间换取时间的一种技术。
Web缓存（或HTTP缓存）是用于Web文档，如HTML页面和图像，减少带宽的使用，服务器的负载的一种信息技术。一个Web缓存系统存储通过Cache来传递的文件的副本；如果满足某些条件，则可以从缓存中得到后续的请求。

WEb缓存有几种方式：

• 服务端缓存
  利用 Memcached，Redis，In-Memery 等缓存技术实现对数据的缓存。

Reids

Redis是一个开源，先进的key-value(键/值对)存储，并且勇于构建高性能，可扩展的Web应用程序的完美解决方案
Redis和Memcached的对比

1. Redis数据库完全在内存中，使用磁盘仅用于持久性
2. 相比较许多键值对存储，redis拥有更加丰富的数据类型，Redis提供的五种数据类型： strings、map、 list、sets、 sorted sets
3. Redis可以将数据复制到任意数量的从服务器
   Redis拥有的优势
4. Redis的执行响应速度非常快
5. 支持丰富的数据类型
6. 原子性，保证了如果两个客户端同事访问的Redis服务器将获得更新后的值
7. 多功能实用工具，Redis是一个多实用的工具，可以在多个用例如缓存，消息，队列实用，任何短暂的数据，应用程序。

Memcached

1. Memcached是一个高性能的分布式缓存系统，用于Web应用减轻数据库负载，它通过在内存中缓存数据和对象来减少读取数据库的次数，从而提高网站的访问速度。

2. Memcached是一个给予存储键/值对的HashMap，底层使用C语言完成，但是客户端可以使用任何语言来编写(Java,.NET，PHP).
3. Memcached中的数据都是存储在memcached内置的内存存储空间中，由于数据仅存在于内存中，因此当某个服务器停止运行或者出现问题之后，所有存放在服务器上的键/值对都会丢失。
4. 下面这幅图可以说明Memcached的工作过程，当首次访问系统的时候，系统从数据库中取得数据保存到Memcached中，在第二次访问的时候则直接从Memcached中读取出来需要的值信息。
   
   

   Memcached.png
   
   Memcached的特征
   Memcached作为高速运行的分布式缓存服务器，具有以下的特点：
5. 协议简单(客户端通信并不是使用复杂的XML格式，而是使用简单的基于文本行的协议)
6. 基于libevent的事件处理(libevent是一个程序库，即使服务器的连接数增加，也能发挥o(1)的性能)
7. 内置内存存储方式(c中已经描述)
8. Memcached不互相通信的分布式。

• 代理服务器缓存
  利用类似nginx的反向代理服务器，对请求的url对应的输出的进行缓存。这个缓存和应用程序实现的动态页面缓存类似，只不过用反向代理充当了应用程序的缓存实现。
• 客户端缓存
  浏览器缓存，其实主要就是HTTP协议定义的缓存机制（如： Last-Modified,If-Modified-Since，Expires； Cache-control等）。

ASP.NET Core 缓存

• .NET数据缓存框架

类	支持	功能	应用场景
System.HttpRuntime.Cache、System.Web.Caching.Cache、System.Web.Context.Current.Cache	全部	网站中缓存对象实例，HTML等	web
System.Runtime.Caching	.NET 4.0	各种对象	web / non-web
System.Web.Caching.OutputCacheProvider	.NET 4.0	网站中缓存HTML页面	web

System.Runtime.Caching，这是在.NET 4.0中新增的缓存框架，存在于程序集System.Runtime.Caching.dll。它是一个可扩展的数据缓存框架，内置提供了内存缓存的实现MemoryCache。HttpRuntime.Cache 获取当前应用程序的Cache，通俗来说就是此缓存信息虽然被放在了System.Web命名空间下，但是非Web程序也可以使用此缓存。

.NET 4.0的缓存功能主要由三部分组成：System.Runtime.Caching，System.Web.Caching.Cache和Output Cache。
System.Runtime.Caching这是在.NET 4.0中新增的缓存框架，主要是使用MemoryCache对象，该对象存在于程序集System.Runtime.Caching.dll。
System.Web.Caching.Cache这个则是在.NET2.0开始就一直存在的缓存对象，一般主要用在Web中，当然也可以用于Winform里面，不过要引用System.Web.dll。
Output Cache则是Asp.NET里面使用的，在ASP.NET 4.0之前的版本都是直接使用System.Web.Caching.Cache来缓存HTML片段。在ASP.NET 4.0中对它进行了重新设计，提供了一个OutputCacheProvider供开发人员进行扩展，但是它默认情况下，仍然使用System.Web.Caching.Cache来做做缓存。

• 内存缓存

最简单的一种缓存，ASP.NET Core 提供了** IMemoryCache 接口来供我们使用。它存储在本地的 WEB 服务器内容中，注意是单机的 WEB 服务器，如果你需要部署的是一个服务器集群的话，那么你应该用分布式缓存**，而不是选择这个。就不详细介绍了，想了解的可以直接看官方文档。

• 分布式缓存

随着云应用和服务器集群以及 docker 等技术的成熟，越来越多的应用程序开始考虑集群部署，因为它具有更好的性能和可伸缩可扩展性。那么这个时候就需要用到分布式缓存了。在 ASP.NET Core应用中，已经对分布式缓存做了抽象，提供了 IDistributedCache 接口，该接口提供了添加，检索，删除等的同步和异步的方法。并且还默认提供了 Redis 和 SQLServer 的分布式缓存实现，我们也可以实现 IDistributedCache 接口来扩展自己的缓存系统。
需要说明的是Get,GetAsync和Set,SetAsync。 这两个接口方法默认是使用的byte[]，之所以没有提供直接存储对象的方法是因为微软想把这个默认序列化的选择交给用户，因为每一个团队的偏好是不一样的，有些团队喜欢使用 XML，有些喜欢使用 JSON，有些喜欢使用 Protobuf 等，所以在 项目中，你可以根据自己的偏好来扩展想要的方法。
具体使用方法还是直接看官方文档好了。

• Response 缓存

在 ASP.NET Core中，有一种缓存叫做Response缓存，这个缓存主要是用来做代理服务器的缓存。它主要原理是在输出的HTTP Response的header里面添加指定的缓存标记。这些缓存标记用来让客户端或者代理服务器来识别需要缓存的内容。然后当客户端有请求到代理服务器的时候，代理服务器可以识别出一部分请求，然后直接把结果返回给浏览器，从而提高后端应用程序的性能和吞吐。

proxy-and-cache.png

从这个图中看出来，在第一次的时候，一个客户端请求经过代理服务器请求的我们后端的WEB服务器上，然后WEB服务器在返回结果的META上添加了cache-control标签，它的值为public。
下面是cache-control标签一些值的说明：

• public
  指示响应可被任何缓存区缓存。
• private
  指示对于单个用户的整个或部分响应消息，不能被共享缓存处理。这允许服务器仅仅描述当用户的部分响应消息，此响应消息对于其他用户的请求无效。
• no-cache
  指示请求或响应消息不能缓存（HTTP/1.0用Pragma的no-cache替换）根据什么能被缓存
• max-age
  指示客户机可以接收生存期不大于指定时间（以秒为单位）的响应。
• min-fresh
  指示客户机可以接收响应时间小于当前时间加上指定时间的响应。
• max-stale
  指示客户机可以接收超出超时期间的响应消息。如果指定max-stale消息的值，那么客户机可以接收超出超时期指定值之内的响应消息。

Expires 表示存在时间，允许客户端在这个时间之前不去检查（发请求），等同max-age的效果。但是如果同时存在，则被Cache-Control的max-age覆盖。
格式：Expires = "Expires" ":" HTTP-date
通过HTTP的META设置expires和cache-control

在 ASP.NET Core MVC 中，提供了ResponseCache
这个特性用来做上面这些事情。它被作为一个Attribute添加的Controller的Action上。

• Duration
  指示缓存的过期时间，对应到Cache-Control 的 max-age 。
• Location
  有三个值Any
  ,Client
  ,None
  分别对应到Cache-Control的 public，private，no-cache。
• NoStore
  设置值是否被存储。如果是true，它将设置Cache-Control为no-store
• VaryByHeader
  将在header中添加Vary标记。
• CacheProfileName
  使用的策略，在startup.cs中设置。
• Order
  在过滤器中的排序。

现在，我们已经知道了如果在Action中设置缓存标记了。

Nginx 缓存

对于一些静态文件，比如程序用到的图片，css，js等，Nginx是可以直接处理的，只需要配置一下。如果使用Nginx来处理静态文件的话，那么程序中startup.cs就可以不用添加app.UseStaticFiles();中间件了。

• 配置
  打开nginx.conf文件，在ubuntu系统下位于/etc/nginx/conf.d/nginx.conf
  没有的话就新建一个。内容如下：

proxy_temp_path   /usr/local/nginx/proxy_temp_dir 1 2; #注：proxy_temp_path和proxy_cache_path指定的路径必须在同一分区

#keys_zone=cache1:100m 表示这个zone(缓存区域)名称为cache1，分配的内存大小为100MB
#/usr/local/nginx/proxy_cache_dir/cache1 表示cache1这个zone的文件要存放的目录
#levels=1:2 表示缓存目录的第一级目录是1个字符，第二级目录是2个字符，即/usr/local/nginx/proxy_cache_dir/cache1/a/1b这种形式
#inactive=1d 表示这个zone中的缓存文件如果在1天内都没有被访问，那么文件会被cache manager进程删除掉
#max_size=10g 表示这个zone的硬盘容量为10GB
proxy_cache_path  /usr/local/nginx/proxy_cache_dir/cache1  levels=1:2 keys_zone=cache1:100m inactive=1d max_size=10g;

#upstream web-app {
#    server webapp1:5090;
#    server webapp2:5090;
#}

server {
    listen 80;
    server_name *.example.com;

    #在日志格式中加入$upstream_cache_status
    log_format format1 '$remote_addr - $remote_user [$time_local]  '
        '"$request" $status $body_bytes_sent '
        '"$http_referer" "$http_user_agent" $upstream_cache_status';

    #访问日志
    access_log log/access.log fomat1;

    #$upstream_cache_status表示资源缓存的状态，有HIT MISS EXPIRED三种状态
    add_header X-Cache $upstream_cache_status;
    
    #命中的正则表达式
    location ~ .*\.(gif|jpg|jpeg|png|bmp|swf|js|css|html)$ {
        proxy_pass http://127.0.0.1:5000;
        #proxy_pass http://web-app;   
        
        #proxy_set_header Host $host;
        #proxy_set_header X-Real-IP $remote_addr;
        #proxy_set_header X-Forwarded-For $remote_addr;
        #proxy_set_header Accept-Encoding "none";
        #设定proxy_set_header Accept-Encoding '';（或是后台服务器关闭gzip），这样这台机器才不会缓存被压缩的文件，造成乱码
        #proxy_set_header Accept-Encoding ""; 这个也可
        
        #如果后端的服务器返回502、504、执行超时等错误，自动将请求转发到upstream负载均衡池中的另一台服务器，实现故障转移。
        #proxy_next_upstream http_502 http_504 error timeout invalid_header;

        #设置资源缓存的zone
        proxy_cache cache1;

        #设置缓存的key
        proxy_cache_key $host$uri$is_args$args;

        #设置状态码为200和304的响应可以进行缓存，并且缓存时间为10分钟
        proxy_cache_valid 200 304 10m;
        
        # **！！！重要！！！** 这段配置加上后，proxy_cache就能支持后台设定的Cache-Control，Expires。 
        proxy_ignore_headers "Cache-Control" "Expires";

        expires 30d;
    }
}

上面有一个配置项在 ASP.NET Core 程序中比较重要，就是proxy_ignore_headers这个配置项，它代表支持后台设定Cache-Control，Expires等。

其中upstream节点是用来配置负载均衡的服务器的，proxy_pass用来设置代理到upstream节点，proxy_next_upstream是用来配置故障转移。

• 应用配置
  使用sudo nginx -s reload命令来重新加载配置。

ICacheService

using System;
using System.Collections.Generic;
using System.Threading.Tasks;

namespace Tdf.CacheManager
{
    public interface ICacheService
    {
        #region 验证缓存项是否存在
        /// 

        ///  验证缓存项是否存在
        /// 
        /// 缓存Key
        /// 
        bool Exists(string key);
        #endregion

        #region 添加缓存
        /// 

        /// 添加缓存
        /// 
        /// 缓存Key
        /// 缓存Value
        /// 
        bool Add(string key, object value);

        /// 

        /// 添加缓存（异步方式）
        /// 
        /// 缓存Key
        /// 缓存Value
        /// 
        Task AddAsync(string key, object value);

        /// 

        /// 添加缓存
        /// 
        /// 缓存Key
        /// 缓存Value
        /// 滑动过期时长（如果在过期时间内有操作，则以当前时间点延长过期时间）
        /// 绝对过期时长
        /// 
        bool Add(string key, object value, TimeSpan expiresSliding, TimeSpan expiressAbsoulte);

        /// 

        /// 添加缓存（异步方式）
        /// 
        /// 缓存Key
        /// 缓存Value
        /// 滑动过期时长（如果在过期时间内有操作，则以当前时间点延长过期时间）
        /// 绝对过期时长
        /// 
        Task AddAsync(string key, object value, TimeSpan expiresSliding, TimeSpan expiressAbsoulte);

        /// 

        /// 添加缓存
        /// 
        /// 缓存Key
        /// 缓存Value
        /// 缓存时长
        /// 是否滑动过期（如果在过期时间内有操作，则以当前时间点延长过期时间）
        /// 
        bool Add(string key, object value, TimeSpan expiresIn, bool isSliding = false);

        /// 

        /// 添加缓存（异步方式）
        /// 
        /// 缓存Key
        /// 缓存Value
        /// 缓存时长
        /// 是否滑动过期（如果在过期时间内有操作，则以当前时间点延长过期时间）
        /// 
        Task AddAsync(string key, object value, TimeSpan expiresIn, bool isSliding = false);
        #endregion

        #region 删除缓存
        /// 

        /// 删除缓存
        /// 
        /// 缓存Key
        /// 
        bool Remove(string key);

        /// 

        /// 删除缓存（异步方式）
        /// 
        /// 缓存Key
        /// 
        Task RemoveAsync(string key);

        /// 

        /// 批量删除缓存
        /// 
        /// 缓存Key集合
        /// 
        void RemoveAll(IEnumerable keys);

        /// 

        /// 批量删除缓存（异步方式）
        /// 
        /// 缓存Key集合
        /// 
        Task RemoveAllAsync(IEnumerable keys);
        #endregion

        #region 获取缓存
        /// 

        /// 获取缓存
        /// 
        /// 缓存Key
        /// 
        T Get(string key) where T : class;

        /// 

        /// 获取缓存（异步方式）
        /// 
        /// 缓存Key
        /// 
        Task GetAsync(string key) where T : class;

        /// 

        /// 获取缓存
        /// 
        /// 缓存Key
        /// 
        object Get(string key);

        /// 

        /// 获取缓存（异步方式）
        /// 
        /// 缓存Key
        /// 
        Task