ASP.NET 缓存：方法和最佳实践 页面缓存技术(Cache、XML)

         ASP.NET 缓存：方法和最佳实践 ASP.NET 提供三种主要形式的缓存：页面级输出缓存、用户控件级输出缓存（或称为片段缓存）和缓存 API。输出缓存和片段缓存的优点是非常易于实现，在大多数情况下，使用这两种缓存就足够了。而缓存 API 则提供了额外的灵活性（实际上是相当大的灵活性），可用于在应用程序的每一层利用缓存。

     

在 ASP.NET 提供的许多特性中，缓存支持无疑是我最欣赏的特性，我这样说当然是有充分理由的。相比 ASP.NET 的所有其他特性，缓存对应用程序的性能具有最大的潜在影响，利用缓存和其他机制，ASP.NET 开发人员可以接受使用开销很大的控件（例如，DataGrid）构建站点时的额外开销，而不必担心性能会受到太大的影响。为了在应用程序中最大程度地利用缓存，您应该考虑在所有程序级别上都实现缓存的方法。
Steve 的缓存提示

尽早缓存；经常缓存

您应该在应用程序的每一层都实现缓存。向数据层、业务逻辑层、UI 或输出层添加缓存支持。内存现在非常便宜 — 因此，通过以智能的方式在整个应用程序中实现缓存，可以获得很大的性能提高。

缓存可以掩盖许多过失

缓存是一种无需大量时间和分析就可以获得“足够良好的”性能的方法。这里再次强调，内存现在非常便宜，因此，如果您能通过将输出缓存 30 秒，而不是花上一整天甚至一周的时间尝试优化代码或数据库就可以获得所需的性能，您肯定会选择缓存解决方案（假设可以接受 30 秒的旧数据）。缓存正是那些利用 20% 付出获得 80% 回报的特性之一，因此，要提高性能，应该首先想到缓存。不过，如果设计很糟糕，最终却有可能带来不良的后果，因此，您当然也应该尽量正确地设计应用程序。但如果您只是需要立即获得足够高的性能，缓存就是您的最佳选择，您可以在以后有时间的时候再尽快重新设计应用程序。
返回页首
页面级输出缓存

作为最简单的缓存形式，输出缓存只是在内存中保留为响应请求而发送的 HTML 的副本。其后再有请求时将提供缓存的输出，直到缓存到期，这样，性能有可能得到很大的提高（取决于需要多少开销来创建原始页面输出 - 发送缓存的输出总是很快，并且比较稳定）。

实现

要实现页面输出缓存，只要将一条 OutputCache 指令添加到页面即可。

<%@ OutputCache Duration="60" VaryByParam="*" %>

如同其他页面指令一样，该指令应该出现在 ASPX 页面的顶部，即在任何输出之前。它支持五个属性（或参数），其中两个是必需的。

Duration
 

必需属性。页面应该被缓存的时间，以秒为单位。必须是正整数。

Location
 

指定应该对输出进行缓存的位置。如果要指定该参数，则必须是下列选项之一：Any、Client、Downstream、None、Server 或 ServerAndClient。

VaryByParam
 

必需属性。Request 中变量的名称，这些变量名应该产生单独的缓存条目。"none" 表示没有变动。"*" 可用于为每个不同的变量数组创建新的缓存条目。变量之间用 ";" 进行分隔。

VaryByHeader
 

基于指定的标头中的变动改变缓存条目。

VaryByCustom
 

允许在 global.asax 中指定自定义变动（例如，"Browser"）。

利用必需的 Duration 和 VaryByParam 选项的组合可以处理大多数情况。例如，如果您的产品目录允许用户基于 categoryID 和页变量查看目录页，您可以用参数值为 "categoryID;page" 的 VaryByParam 将产品目录缓存一段时间（如果产品不是随时都在改变，一小时还是可以接受的，因此，持续时间是 3600 秒）。这将为每个种类的每个目录页创建单独的缓存条目。每个条目从其第一个请求算起将维持一个小时。

VaryByHeader 和 VaryByCustom 主要用于根据访问页面的客户端对页面的外观或内容进行自定义。同一个 URL 可能需要同时为浏览器和移动电话客户端呈现输出，因此，需要针对不同的客户端缓存不同的内容版本。或者，页面有可能已经针对 IE 进行了优化，但需要能针对 Netscape 或 Opera 完全降低优化（而不仅仅是破坏页面）。后一个例子非常普遍，我们将提供一个说明如何实现此目标的示例：

示例：VaryByCustom 用于支持浏览器自定义

为了使每个浏览器都具有单独的缓存条目，VaryByCustom 的值可以设置为 "browser"。此功能已经内置在缓存模块中，并且将针对每个浏览器名称和主要版本插入单独的页面缓存版本。

<%@ OutputCache Duration="60" VaryByParam="None" VaryByCustom="browser"  %>

返回页首
片段缓存，用户控件输出缓存

缓存整个页面通常并不可行，因为页面的某些部分是针对用户定制的。不过，页面的其他部分是整个应用程序共有的。这些部分最适合使用片段缓存和用户控件进行缓存。菜单和其他布局元素，尤其是那些从数据源动态生成的元素，也应该用这种方法进行缓存。如果需要，可以将缓存的控件配置为基于对其控件（或其他属性）的更改或由页面级输出缓存支持的任何其他变动进行改变。使用同一组控件的几百个页面还可以共享那些控件的缓存条目，而不是为每个页面保留单独的缓存版本。

实现

片段缓存使用的语法与页面级输出缓存一样，但其应用于用户控件（.ascx 文件）而不是 Web 窗体（.aspx 文件）。除了 Location 属性，对于 OutputCache 在 Web 窗体上支持的所有属性，用户控件也同样支持。用户控件还支持名为 VaryByControl 的 OutputCache 属性，该属性将根据用户控件（通常是页面上的控件，例如，DropDownList）的成员的值改变该控件的缓存。如果指定了 VaryByControl，可以省略 VaryByParam。最后，在默认情况下，对每个页面上的每个用户控件都单独进行缓存。不过，如果一个用户控件不随应用程序中的页面改变，并且在所有页面都使用相同的名称，则可以应用 Shared="true" 参数，该参数将使用户控件的缓存版本供所有引用该控件的页面使用。

示例

<%@ OutputCache Duration="60" VaryByParam="*" %>

该示例将缓存用户控件 60 秒，并且将针对查询字符串的每个变动、针对此控件所在的每个页面创建单独的缓存条目。

<%@ OutputCache Duration="60" VaryByParam="none" 
VaryByControl="CategoryDropDownList" %>

该示例将缓存用户控件 60 秒，并且将针对 CategoryDropDownList 控件的每个不同的值、针对此控件所在的每个页面创建单独的缓存条目。

<%@ OutputCache Duration="60" VaryByParam="none" VaryByCustom="browser" 
Shared="true %>

最后，该示例将缓存用户控件 60 秒，并且将针对每个浏览器名称和主要版本创建一个缓存条目。然后，每个浏览器的缓存条目将由引用此用户控件的所有页面共享（只要所有页面都用相同的 ID 引用该控件即可）。
返回页首
缓存 API，使用 Cache 对象

页面级和用户控件级输出缓存的确是一种可以迅速而简便地提高站点性能的方法，但是在 ASP.NET 中，缓存的真正灵活性和强大功能是通过 Cache 对象提供的。使用 Cache 对象，您可以存储任何可序列化的数据对象，基于一个或多个依赖项的组合来控制缓存条目到期的方式。这些依赖项可以包括自从项被缓存后经过的时间、自从项上次被访问后经过的时间、对文件和/或文件夹的更改以及对其他缓存项的更改，在略作处理后还可以包括对数据库中特定表的更改。

在 Cache 中存储数据

在 Cache 中存储数据的最简单的方法就是使用一个键为其赋值，就像 HashTable 或 Dictionary 对象一样：

Cache["key"] = "value";

这种做法将在缓存中存储项，同时不带任何依赖项，因此它不会到期，除非缓存引擎为了给其他缓存数据提供空间而将其删除。要包括特定的缓存依赖项，可使用 Add() 或 Insert() 方法。其中每个方法都有几个重载。Add() 和 Insert() 之间的唯一区别是，Add() 返回对已缓存对象的引用，而 Insert() 没有返回值（在 C# 中为空，在 VB 中为 Sub）。

示例

Cache.Insert("key", myXMLFileData, new 
System.Web.Caching.CacheDependency(Server.MapPath("users.xml")));

该示例可将文件中的 xml 数据插入缓存，无需在以后请求时从文件读取。 CacheDependency 的作用是确保缓存在文件更改后立即到期，以便可以从文件中提取最新数据，重新进行缓存。如果缓存的数据来自若干个文件，还可以指定一个文件名的数组。

Cache.Insert("dependentkey", myDependentData, new 
System.Web.Caching.CacheDependency(new string[] {}, new string[] 
{"key"}));

该示例可插入键值为 "key" 的第二个数据块（取决于是否存在第一个数据块）。如果缓存中不存在名为 "key" 的键，或者如果与该键相关联的项已到期或被更新，则 "dependentkey" 的缓存条目将到期。

Cache.Insert("key", myTimeSensitiveData, null, 
DateTime.Now.AddMinutes(1), TimeSpan.Zero);

绝对到期：此示例将对受时间影响的数据缓存一分钟，一分钟过后，缓存将到期。注意，绝对到期和滑动到期（见下文）不能一起使用。

Cache.Insert("key", myFrequentlyAccessedData, null, 
System.Web.Caching.Cache.NoAbsoluteExpiration, 
TimeSpan.FromMinutes(1));

滑动到期：此示例将缓存一些频繁使用的数据。数据将在缓存中一直保留下去，除非数据未被引用的时间达到了一分钟。注意，滑动到期和绝对到期不能一起使用。

更多选项

除了上面提到的依赖项，我们还可以指定项的优先级（依次为 low、high、NotRemovable，它们是在 System.Web.Caching.CacheItemPriority 枚举中定义的）以及当缓存中的项到期时调用的 CacheItemRemovedCallback 函数。大多数时候，默认的优先级已经足够了 — 缓存引擎可以正常完成任务并处理缓存的内存管理。CacheItemRemovedCallback 选项考虑到一些很有趣的可能性，但实际上它很少使用。不过，为了说明该方法，我将提供它的一个使用示例：

CacheItemRemovedCallback 示例

System.Web.Caching.CacheItemRemovedCallback callback = new System.Web.Caching.CacheItemRemovedCallback (OnRemove);
Cache.Insert("key",myFile,null, 
System.Web.Caching.Cache.NoAbsoluteExpiration, 
TimeSpan.Zero, 
System.Web.Caching.CacheItemPriority.Default, callback);
. . .
public static void OnRemove(string key, 
object cacheItem, 
System.Web.Caching.CacheItemRemovedReason reason)
{
AppendLog("The cached value with key '" + key + 
"' was removed from the cache.  Reason: " + 
reason.ToString()); 
}

该示例将使用

AppendLog()

方法（这里不讨论该方法，请参阅 Writing Entries to Event Logs）中定义的任何逻辑来记录缓存中的数据到期的原因。通过在从缓存中删除项时记录这些项并记录删除的原因，您可以确定是否在有效地使用缓存或者您是否可能需要增加服务器上的内存。注意，callback 是一个静态（在 VB 中为 Shared）方法，建议使用该方法的原因是，如果不使用它，保存回调函数的类的实例将保留在内存中，以支持回调（对 static/Shared 方法则没有必要）。

该特性有一个潜在的用处 — 在后台刷新缓存的数据，这样用户永远都不必等待数据被填充，但数据始终保持相对较新的状态。但实际上，此特性并不适用于当前版本的缓存 API，因为在从缓存中删除缓存的项之前，不触发或不完成回调。因此，用户将频繁地发出尝试访问缓存值的请求，然后发现缓存值为空，不得不等待缓存值的重新填充。我希望在未来的 ASP.NET 版本中看到一个附加的回调，可以称为 CachedItemExpiredButNotRemovedCallback，如果定义了该回调，则必须在删除缓存项之前完成执行。

缓存数据引用模式

每当我们尝试访问缓存中的数据时，都应该考虑到一种情况，那就是数据可能已经不在缓存中了。因此，下面的模式应该普遍适用于您对缓存的数据的访问。在这种情况下，我们假定已缓存的数据是一个数据表。

public DataTable GetCustomers(bool BypassCache)
{
string cacheKey = "CustomersDataTable";
object cacheItem = Cache[cacheKey] as DataTable;
if((BypassCache) || (cacheItem == null))
{
cacheItem = GetCustomersFromDataSource();
Cache.Insert(cacheKey, cacheItem, null,
DateTime.Now.AddSeconds(GetCacheSecondsFromConfig(cacheKey), 
TimeSpan.Zero);
}
return (DataTable)cacheItem;
}

关于此模式，有以下几点需要注意：

    *

      某些值（例如，cacheKey、cacheItem 和缓存持续时间）是一次定义的，并且只定义一次。
    *

      可以根据需要跳过缓存 — 例如，当注册一个新客户并重定向到客户列表后，最好的做法可能就是跳过缓存，用最新数据重新填充缓存，该数据包括新插入的客户。
    *

      缓存只能访问一次。这种做法可以提高性能，并确保不会发生 NullReferenceExceptions，因为该项在第一次被检查时是存在的，但第二次检查之前就已经到期了。
    *

      该模式使用强类型检查。C# 中的 "as" 运算符尝试将对象转换为类型，如果失败或该对象为空，则只返回 null（空）。
    *

      持续时间存储在配置文件中。在理想的情况下，所有的缓存依赖项（无论是基于文件的，或是基于时间的，还是其他类型的依赖项）都应该存储在配置文件中，这样就可以进行更改并轻松地测量性能。我还建议您指定默认缓存持续时间，而且，如果没有为所使用的 cacheKey 指定持续时间，就让 GetCacheSecondsFromConfig() 方法使用该默认持续时间。

相关的代码示例是一个 helper 类，它将处理上述所有情况，但允许通过一行或两行代码访问缓存的数据。请下载 CacheDemos.msi。
返回页首
小结

缓存可以使应用程序的性能得到很大的提高，因此在设计应用程序以及对应用程序进行性能测试时应该予以考虑。应用程序总会或多或少地受益于缓存，当然有些应用程序比其他应用程序更适合使用缓存。对 ASP.NET 提供的缓存选项的深刻理解是任何 ASP.NET 开发人员应该掌握的重要技巧。

页面缓存技术(Cache、XML)

页面缓存
使用OutputCache指令。
<%@ OutputCache Duration="3600"
               Location="Any"
               VaryByCustom="browser"
               VaryByParam="RequestID" %>
其中Duration和VaryByParam特性是必须的。

Location控制页面缓存的位置
Location含义Any
默认值。意味着页面的输出可以缓存在客户端浏览器，缓存在任何“下游”的客户端（如代理服务器），或缓存在Web服务器本身
Client
指明输出缓存只能存储在发出请求的客户端（即浏览器）的本地缓存中
Downstream
指明输出缓存能存储在任何支持HTTP1.1缓存的设备（如代理服务器）中
Server
指明输出缓存将存储在Web服务器上
None
指明该页面禁用输出缓存

Duration允许我们控制页面在缓存中生存的时间（单位是秒）

VaryByParam允许我们缓存页面的不同版本。在上面的例子中，VaryByParam设为了RequestID，所以ASP.NET使用RequestID参数的不同值，这些值或者是在HTTP GET的查询字符串中传入，或者是在HTTP POST的参数中传入。可以通过检查RequestID参数的值让应用程序区分不同的用户；通过在页面的OutputCache指令中放置VaryByParam＝"RequestID"，可以让ASP.NET为每个用户缓存页面的不同版本。
如果不想根据参数的值缓存页面的不问版本，那么只要把VaryByParam设为none。
也可以要求ASP.NET为每个可能的参数组合缓存页面的一个版本。为此，可把VaryByParam设为*。

VaryByHeader和VaryByCustom特性与VaryByParam的相似之处在于，它们允许指定何时应创建页面新的缓存版本。
VaryByHeader允许我们根据由分号分隔的HTTP头的列表末缓存页面的不向版本。
VaryByCustom当设为browser时，允许我们根据浏览器的名称和主版本信息缓存不同版本。也可以把它设为一个自定义方法的名称，从而实现我们自己的逻辑，控制缓存的版本。

片断缓存
可以利用用户控件将页面分段，在ascx文件中写入缓存的语句，而不在aspx文件中写缓存语句，这样ASP.NET就可以只缓存ascx片断的输出了。一般像页眉或页脚基本上都是一样的，就不需要重新加载。但是如果其中有动态变化的数据就不能对其进行缓存，因为一旦被缓存后程序就不会再创建它的实例来更新数据显示，只有等到生存期过期才行，所以对于这种情况就不适于用页面片断缓存。
注意：
一、注意片段缓存不支持Location特性；缓存页面片段惟一合法的地方是web服务器。这是因为片段缓存在ASP.NET中是新的功能，所以浏览器和代理服务器不支持。
二、片段缓存有另外一个在页面缓存中没有的特性——VaryByControl。VaryByControl特性允许指定一个由分号分隔的字符串列表，代表用户控件内使用的控件的名称；ASP.NET将针对值的每个不同的组合生成用户构件的一个缓存版本。

数据缓存
低级API是Cache类，它位于ASP.NET中的System.web.Caching命名空间，可以用它缓存生成很耗费资源的数据。Cache类的使用和Session与Application对象一样简单。每个应用程序只有一个Cache对象——这意味着使用Cache对象存储在缓存中的数据是应用程序级别的数据。使事情更为简单的是，Page类的Cache属性使应用程序的Cache对象实例能在代码中使用。
通过Cache对象缓存的数据存储在应用程序的内存中。这意味着该数据的生存期不会超过应用程序的重启(事实上，这和存储在Application与Session对象中的数据一样，除非使用StateService或SQL State会话模式存储Session数据)。
具体的使用和语法与Session和Application一样。转换回来的时候需要注意对其进行相应类型的强制类型转换。

这不是在ASP.NET缓存中添加缓存项的惟一方式。Cache对象有两个方法Insert()方法和Add()方法，它们灵活性更高。它们的用法近似，但稍有不同：
Insert()方法用于覆盖ASP.NET缓存中现有的缓存项。
Add()方法只用于在ASP.NET缓存中添加新的缓存项(如果用它覆盖现有的缓存项，则会失败)。
每个方法都有7个参数，而且两个方法的参数相同。
在缓存某一项时，可以指定它的相关性，告诉ASP.NET该缓存项在缓存中一直保留到某个事件发生时为止。
相关性值含义CacheDependency
允许指定一个文件或缓存键。如果文件发生变化，对象就被删除。如果缓存键发生变化，对象也被删除。
DateTime
这是一个DataTime值，指明缓存数据过期的时间（绝对过期时间）
TimeSpan
这是一个时间间隔，指明缓存数据在上一次访问后可以在缓存中保留多长时间（弹性过期时间）
使用CacheItemPriority来指定缓存数据的优先级，以便在缓存被填满的时候删除那些优先级低的数据。
优先级值含义High
设为此优先级的缓存项是最不可能在内存不足时被删除的
AboveNormal
设为此优先级的缓存项比优先级为Normal或以下的缓存项更优先保留
Normal
设为此优先级的缓存项比优先级为BelowNormal和Low的缓存项更优先保留
BelowNormal
这是倒数第二级的优先级；设为此优先级的缓存项只比优先级设为Low的缓存项更优先保留
Low
设为此优先级的缓存项是最有可能在内存不足时被删除的
Default
缓存项的优先级的默认值是Normal
NotRemovable
当缓存项设为此优先级时，是在告诉ASP.NET即使是内存不足，也不要从缓存中删除它
DateTime dt = new DateTime(DateTime.Now.Year,12,31);
Cache.Add("MembersDataSet",dsMembers,null,
dt,TimeSpan.Zero,
CacheItemPriority.Normal,null);
第一个参数是引用缓存对象的键，第二个参数是要缓存的对象。第三个参数是null(表明没有相关性)。
第四和第五个参数是绝对的过期时间和弹性的过期时间。这里，我们指定缓存应在当前年份的最后一天过期(dt)。我们想指定没有弹性的过期时间，所以第五个参数使用TimeSpan.Zero。第六个参数使用System.Web.Caching.CacheItemPriority枚举中的一个值，把优先级设为Normal。

指定一个5分钟的弹性过期时间，没有指定绝对过期时间
Cache.Add("MembersDataSet",dsMembers,null,
                 DateTime.MaxValue,TimeSpan.FromMinutes(5),
             CacheItemPriority.Normal,null);

添加一个相关性。在这个例子中，过期时间也取决于一个文件的修改，即test.xml文件：
CacheDependency dep = new CacheDependency(@"C:/test.xml");
Cache.Add("MembersDataSet",dsMembers,dep,
                 DateTime.MaxValue,TimeSpan.FromMinutes(5),
             CacheItemPriority.Normal,null);

过期时间取决于缓存中另一项的修改：
String[] dependencyKeys = new String[1];
dependencyKeys[0] = "MembersChanged";
CacheDependency dependency = new CacheDependency(null, dependencyKeys);
Cache.Add("MembersDataSet",dsMembers,dependency,
                 DateTime.MaxValue,TimeSpan.Zero,
             CacheItemPriority.Normal,null);

最后一个参数是CacheItemRemovedCallback类型的，允许我们在缓存项从缓存中删除时要求通知，可以编写一个自定义的方法(像这里的ItemRemovedCallback()方法)，然后在第7个参数中指定该方法：
         public void ItemRemovedCallback(String key, Object value, CacheItemRemovedReason reason)
         {
         }

Cache.Add("MembersDataSet",dsMembers,dependency,
                 DateTime.MaxValue,TimeSpan.FromMinutes(5),
             CacheItemPriority.Normal,
new CacheItemRemovedCallback(this.ItemRemovedCallback));
第一个参数是在缓存中存储缓存项时使用的键，第二个是存储的对象本身，第三个是缓存项删除的原因