asp.net 应用数据缓存 -- Cache对象使用

ASP.NET 应用数据缓存 -- Cache对象使用

[原文：http://msdn.microsoft.com/zh-cn/library/18c1wd61%28v=vs.100%29.aspx]

[说明： 您可以直接使用cache对象，但对MVC中的action，还可以使用OutputCacheAttribute的action filter； 其区别是OutputCache filter仅对该action有用，要在不同的action甚至controller内共享该cache，则只有使用cache对象]

ASP.NET 为您提供了一个强大的、便于使用的缓存机制，用于将需要大量服务器资源来创建的对象存储在内存中。缓存这些类型的资源会大大改进应用程序的性能。

缓存是由 Cache 类实现的；缓存实例是每个应用程序专用的。缓存生存期依赖于应用程序的生存期；重新启动应用程序后，将重新创建 Cache 对象。

设计 Cache 类是为了便于使用。您可以将项放置在 Cache 中，并在以后使用简单的键/值对来检索这些项。有关如何执行此操作的示例，请参见如何：将项添加到缓存中和如何：检索缓存项的值。

Cache 类提供了强大的功能，允许您自定义如何缓存项以及将它们缓存多长时间。例如，当缺乏系统内存时，缓存会自动移除很少使用的或优先级较低的项以释放内存。该技术也称为清理，这是缓存确保过期数据不使用宝贵的服务器资源的方式之一。

当执行清理时，您可以指示 Cache 给予某些项比其他项更高的优先级。若要指示项的重要性，可以在使用 Add 或 Insert 方法添加项时指定一个 CacheItemPriority 枚举值。

当使用 Add 或 Insert 方法将项添加到缓存时，您还可以建立项的过期策略。您可以通过使用 DateTime 值指定项的确切过期时间（绝对过期时间），来定义项的生存期。也可以使用 TimeSpan 值指定一个弹性过期时间，弹性过期时间允许您根据项的上次访问时间来指定该项过期之前的运行时间。一旦项过期，便将它从缓存中移除。试图检索它的值的行为将返回 null（在 Visual Basic 中为 Nothing），除非该项被重新添加到缓存中。

对于存储在缓存中的易失项（例如那些定期进行数据刷新的项或那些只在一段时间内有效的项），通常设置一种过期策略：只要这些项的数据保持为最新的，就将它们保留在缓存中。例如，如果您正在编写一个应用程序，该应用程序通过另一个网站获取数据来跟踪体育比赛的比分，那么只要源网站上比赛的比分不更改，就可以缓存这些比分。在此情况下，您可以根据其他网站更新比分的频率来设置过期策略。您可以编写代码来确定缓存中是否是最新的比分。如果该比分不是最新的，则代码可以从源网站读取比分并缓存新值。

最后，ASP.NET 允许您根据外部文件、目录（文件依赖项）或另一个缓存项（键依赖项）来定义缓存项的有效性。如果具有关联依赖项的项发生更改，缓存项便会失效并从缓存中移除。您可以使用该技术在项的数据源更改时从缓存中移除这些项。例如，如果您编写一个处理 XML 文件中的财务数据的应用程序，则可以从该文件将数据插入缓存中并在此 XML 文件上保留一个依赖项。当该文件更新时，从缓存中移除该项，您的应用程序重新读取 XML 文件，然后将刷新后的数据放入缓存中。

说明：
Cache 对象没有关于它所包含项的内容的信息。它只保留对这些对象的引用。它还提供跟踪它们的依赖项和设置到期策略的方法。

有关如何使用这些功能的更多信息，请参见如何：将项添加到缓存中。

如何：将项添加到缓存中

可以使用 Cache 对象访问应用程序缓存中的项。可以使用 Cache 对象的 Insert 方法向应用程序缓存添加项。该方法向缓存添加项，并且通过几次重载，您可以用不同选项添加项，以设置依赖项、过期和移除通知。如果使用 Insert 方法向缓存添加项，并且已经存在与现有项同名的项，则缓存中的现有项将被替换。

还可以使用 Add 方法向缓存添加项。使用此方法，您可以设置与 Insert 方法相同的所有选项；然而，Add 方法将返回您添加到缓存中的对象。另外，如果使用 Add 方法，并且缓存中已经存在与现有项同名的项，则该方法不会替换该项，并且不会引发异常。

本主题中的过程阐释了向应用程序缓存添加项的如下方式：

• 通过键和值直接设置项，向缓存添加项。

• 使用 Insert 方法向缓存添加项。

• 向缓存添加项并添加依赖项，以便当该依赖项更改时，将该项从缓存中移除。可以基于其他缓存项、文件和多个对象设置依赖项。

• 将设有过期策略的项添加到缓存中。除了能设置项的依赖项以外，还可以设置项在一段时间以后（弹性过期）或在指定时间（绝对过期）过期。您可以定义绝对过期时间或弹性过期时间，但不能同时定义两者。

• 向缓存添加项，并定义缓存的项的相对优先级。相对优先级帮助 .NET Framework 确定要移除的缓存项；较低优先级的项比较高优先级的项先从缓存中移除。

• 通过调用 Add 方法添加项。

除了这里显示的依赖项，可以在 SQL Server 表上或基于自定义依赖项创建依赖项。有关更多信息，请参见 ASP.NET 缓存概述和使用 SqlCacheDependency 类在 ASP.NET 中缓存。

当从缓存中移除项时，还可以使用 CacheItemRemovedCallback 委托让应用程序缓存通知应用程序。有关完整示例，请参见如何：从缓存中移除项时通知应用程序。

通过键和值直接设置项向缓存添加项

• 通过指定项的键和值，像将项添加到字典中一样将其添加到缓存中。

  下面的代码示例将名为 CacheItem1 的项添加到 Cache 对象中：

  C#

  Cache["CacheItem1"] = "Cached Item 1";
  

  
  

通过使用 Insert 方法将项添加到缓存中

• 调用 Insert 方法，传递要添加的项的键和值。

  下面的代码示例添加名为 CacheItem2 的字符串：

  C#

  Cache.Insert("CacheItem2", "Cached Item 2");
  

  
  

通过指定依赖项向缓存添加项

• 调用 Insert 方法，将 CacheDependency 对象的一个实例传递给该方法

  下面的代码示例添加名为 CacheItem3 的项，该项依赖于缓存中名为 CacheItem2 的另一个项：

  C#

  string[] dependencies = { "CacheItem2" };
  Cache.Insert("CacheItem3", "Cached Item 3",
      new System.Web.Caching.CacheDependency(null, dependencies));
  

  
  

  下面的代码示例演示将名为 CacheItem4 的项添加到缓存中，并且在名为 XMLFile.xml 的文件上设置文件依赖项：

  C#

  Cache.Insert("CacheItem4", "Cached Item 4",
      new System.Web.Caching.CacheDependency(
      Server.MapPath("XMLFile.xml")));
  

  
  

  下面的代码示例演示如何创建多个依赖项。它向缓存中名为 CacheItem1 的另一个项添加键依赖项，向名为 XMLFile.xml 的文件添加文件依赖项。

  C#

  System.Web.Caching.CacheDependency dep1 = 
      new System.Web.Caching.CacheDependency(Server.MapPath("XMLFile.xml"));
  string[] keyDependencies2 = { "CacheItem1" };
  System.Web.Caching.CacheDependency dep2 = 
      new System.Web.Caching.CacheDependency(null, keyDependencies2);
  System.Web.Caching.AggregateCacheDependency aggDep = 
      new System.Web.Caching.AggregateCacheDependency();
  aggDep.Add(dep1);
  aggDep.Add(dep2);
  Cache.Insert("CacheItem5", "Cached Item 5", aggDep);
  

  
  
  

将设有过期策略的项添加到缓存中

• 调用 Insert 方法，将绝对过期时间或弹性过期时间传递给该方法。

  下面的代码示例将有一分钟绝对过期时间的项添加到缓存中：

  C#

  Cache.Insert("CacheItem6", "Cached Item 6",
      null, DateTime.Now.AddMinutes(1d), 
      System.Web.Caching.Cache.NoSlidingExpiration);
  

  下面的代码示例将有 10 分钟弹性过期时间的项添加到缓存中：

  C#

  Cache.Insert("CacheItem7", "Cached Item 7",
      null, System.Web.Caching.Cache.NoAbsoluteExpiration,
      new TimeSpan(0, 10, 0));
  

  
  

将设有优先级设置的项添加到缓存中

• 调用 Insert 方法，从 CacheItemPriority 枚举中指定一个值。

  下面的代码示例将优先级值为 High 的项添加到缓存中：

  C#

  Cache.Insert("CacheItem8", "Cached Item 8",
      null, System.Web.Caching.Cache.NoAbsoluteExpiration,
      System.Web.Caching.Cache.NoSlidingExpiration,
      System.Web.Caching.CacheItemPriority.High, null);
  

使用 Add 方法向缓存添加项

• 调用 Add 方法，它返回一个表示项的对象。

  下面的代码示例向缓存添加名为 CacheItem9 的项，同时将变量 CachedItem9 的值设置为已添加的项。

  C#

  string CachedItem9 = (string)Cache.Add("CacheItem9",
      "Cached Item 9", null,
      System.Web.Caching.Cache.NoAbsoluteExpiration,
      System.Web.Caching.Cache.NoSlidingExpiration, 
      System.Web.Caching.CacheItemPriority.Default,
      null);
  

如何：检索缓存项的值

要从缓存中检索数据，应指定存储缓存项的键。不过，由于缓存中所存储的信息为易失信息，即该信息可能由 ASP.NET 移除，因此建议的开发模式是首先确定该项是否在缓存中。如果不在，则应将它重新添加到缓存中，然后检索该项。

检索缓存项的值

• 通过在 Cache 对象中进行检查来确定该项是否不为 null（在 Visual Basic 中为 Nothing）。如果该项存在，则将它分配给变量。否则，重新创建该项，将它添加到缓存中，然后访问它。

  下面的代码示例演示如何从缓存中检索名为 CacheItem 的项。代码将该项的内容分配给名为 cachedString 的变量。如果该项不在缓存中，则代码会将它添加到缓存中，然后将它分配给 cachedString。

  C#

  string cachedString;
  cachedString = (string)Cache["CacheItem"];
  if (cachedString == null)
  {
    cachedString = "Hello, World.";
    Cache.Insert("CacheItem", cachedString);
  }
  

如何：从 ASP.NET 缓存中删除项

ASP.NET 缓存中的数据是易失的，即不能永久保存。由于以下任一原因，缓存中的数据可能会自动移除：

• 缓存已满。

• 该项已过期。

• 依赖项发生更改。

有关更多信息，请参见 ASP.NET 缓存概述。

从缓存中移除项的具体方法由用于向缓存添加项的代码确定。有关更多信息，请参见如何：将项添加到缓存中。项从缓存中移除时会向您发出通知。有关更多信息，请参见如何：从缓存中移除项时通知应用程序。

除了允许从缓存中自动移除项之外，还可以显式移除项。

说明：
如果调用 Insert 方法，并向缓存中添加与现有项同名的项，则将从缓存中删除该旧项。

从缓存中显式删除项

• 调用 Remove 方法，以传递要移除的项的键。

  下面的示例演示如何移除键为 MyData1 的项。

  C#
  Cache.Remove("MyData1");
  

如何：从缓存中移除项时通知应用程序

在大多数缓存方案中，当从缓存中移除项后，直到再次需要此项时，才需要将其放回缓存中。典型的开发模式是在使用项之前始终检查该项是否已在缓存中。如果项位于缓存中，则可以使用。如果不在缓存中，则应再次检索该项，然后将其添加回缓存。

但是，在某些情况下，如果从缓存中移除项时通知应用程序，可能非常有用。例如，您可能具有一个缓存的报告，创建该报告需花费大量的时间进行处理。当该报告从缓存中移除时，您希望重新生成该报告，并立即将其置于缓存中，以便下次请求该报告时，用户不必等待对此报告进行处理。

为了在从缓存中移除项时能够发出通知，ASP.NET 提供了 CacheItemRemovedCallback 委托。该委托定义编写事件处理程序时使用的签名，当对从缓存中移除项进行响应时会调用此事件处理程序。ASP.NET 还提供 CacheItemRemovedReason 枚举，用于指定移除缓存项的原因。

通常，通过在管理尝试检索的特定缓存数据的业务对象中创建处理程序，来实现回调。例如，您可能有一个 ReportManager 对象，该对象具有两种方法，即 GetReport 和 CacheReport。GetReport 报告方法检查缓存以查看报告是否已缓存；如果没有，该方法将重新生成报告并将其缓存。CacheReport 方法具有与 CacheItemRemovedCallback 委托相同的函数签名；从缓存中移除报告时，ASP.NET 会调用 CacheReport 方法，然后将报告重新添加到缓存中。

当从缓存中移除项时通知应用程序

1. 创建一个类，负责从缓存中检索项并处理回调方法，以将项添加回缓存中。

2. 在该类中，创建用于将项添加到缓存中的方法。

3. 在该类中，创建用于从缓存中获取项的方法。

4. 创建用于处理缓存项移除回调的方法。该方法必须具备与 CacheItemRemovedCallback 委托相同的函数签名。从缓存中删除项时，会在该方法中执行要运行的逻辑，如重新生成项并将其添加回缓存中。

测试缓存项回调

1. 创建一个 ASP.NET 网页，该网页将调用类中用于将项添加到缓存中的方法。

   下面的代码示例演示如何调用 ReportManager 类的 GetReport 方法（在此过程后面的示例中定义）。然后将在使用页面的 Page_Load 方法期间显示 Label 控件 Label1 中的报告。

   C#

   protected void Page_Load(object sender, EventArgs e)
   {
       this.Label1.Text = ReportManager.GetReport();
   }
   

2. 在浏览器中请求 ASP.NET 页并查看报告。

   报告是在首次请求页时创建的，在缓存中的报告被移除之前，后续请求都将访问缓存中的报告。

示例

下面的代码示例演示一个名为 ReportManager 的、用于在从缓存中删除项时处理通知的完整类。该类管理字符串形式的报告，此报告表示一个长期运行的进程。

尽管该示例使用声明为 static（在 Visual Basic 中为 Shared）的类，但并不是必须使用静态类。不过，删除缓存项时，用于处理回调的方法必须存在。例如，不应在 ASP.NET 页中实现回调处理程序，因为在从缓存中删除项之前该页可能已被释放，因此用于处理回调的方法将不可用。为了确保从缓存中删除项时处理回调的方法仍然存在，请使用该方法的静态类。但是，静态类的缺点是需要保证所有静态方法都是线程安全的。

警告：
请不要在页面中将 CacheItemRemovedCallback 设置为一个方法。除了在释放页面后回调无法使用页面方法以外，将回调指向页面方法还会阻碍垃圾回收将页面使用的内存回收。由于回调包含对页面的引用，而垃圾回收器不会从内存中移除包含任何引用的项，因此会出现这种情况。在加载应用程序期间，这可能会导致内存很快被用光。

该示例类包括以下功能：

• 私有成员，用于跟踪报告是否已从缓存中移除。

• 名为 CacheReport 的方法，用于将项以 MyReport 的名称添加到缓存中，并将该项设置为在添加到缓存中后一分钟过期。该方法还会将 ReportRemovedCallback 方法传递给 onRemoveCallback 参数，从而注册 ReportRemoveCallback 方法，以便在从缓存中删除项时进行调用。

• 名为 GetReport 的方法，用于从缓存中获取项。该方法确定名为 MyReport 的项是否存在于缓存中。如果该项不存在，则该方法将调用 CacheReport,，将该项添加到缓存中。

• 名为 ReportRemovedCallback 的方法，用于处理缓存项移除回调。ReportRemovedCallback 具有与 CacheItemRemovedCallback 委托相同的函数签名。该方法将变量 _reportRemovedFromCache 设置为 true，然后通过 CacheReport 方法将项添加回缓存中。

using System;
using System.Web;
using System.Web.Caching;
public static class ReportManager
{
    private static bool _reportRemovedFromCache = false;
    static ReportManager()
    { }

    public static String GetReport()
    {
        lock (typeof(ReportManager))
        {
            if (HttpContext.Current.Cache["MyReport"] != null)
                return (string)HttpRuntime.Cache["MyReport"];
            else
            {
                CacheReport();
                return (string)HttpRuntime.Cache["MyReport"];
            }
        }
    }

    public static void CacheReport()
    {
        lock (typeof(ReportManager))
        {
            HttpRuntime.Cache.Add("MyReport",
                CreateReport(), null, Cache.NoAbsoluteExpiration,
                new TimeSpan(0, 1, 0),
                System.Web.Caching.CacheItemPriority.Default,
                new CacheItemRemovedCallback(ReportRemovedCallback));
        }
    }

    private static string CreateReport()
    {
        System.Text.StringBuilder myReport = 
            new System.Text.StringBuilder();
        myReport.Append("Sales Report<br />");
        myReport.Append("2005 Q2 Figures<br />");
        myReport.Append("Sales NE Region - $2 million<br />");
        myReport.Append("Sales NW Region - $4.5 million<br />");
        myReport.Append("Report Generated: " + DateTime.Now.ToString() 
            + "<br />");
        myReport.Append("Report Removed From Cache: " + 
            _reportRemovedFromCache.ToString());
        return myReport.ToString();
    }

    public static void ReportRemovedCallback(String key, object value, 
        CacheItemRemovedReason removedReason)
    {
        _reportRemovedFromCache = true;
        CacheReport();
    }
}