@ OutputCache 指令的 VaryByCustom 属性来缓存不同版本的页面

来自：http://www.cnblogs.com/leonjoon/archive/2006/08/27/487747.html

petshop输出缓存设置
petshop的web页面上部的ControlHeader是随着用户登陆的状态有关的，故其设置了VaryByCustom属性以来标识用户不同登陆状态的缓存版本。而Category页面由于可能被大量的访问，并且数据量很大，是十分有必要缓存的，但是由于数据的随机性很大，存在不同的版本，比如说是不同类别的Category，甚至不同的分页显示的数据页，在这里采用了VaryByCustom属性以缓存不同版本的页。

我们再看下其具体实现代码：
VaryByCustom，我们可以自定义输出缓存要求的任意文本。除了在OutputCache指令里面申明该属性之外，我们还得在应用程序的 global.asax 文件的代码声明块中，重写 GetVaryByCustomString 方法来为自定义字符串指定输出缓存的行为。

举一列来说：

<%@ OutputCache VaryByParam="none" VaryByCustom="CategoryPageKey" Location="server" Duration="43200" %>

这里的VaryByCustom定义的为CategoryPageKey，那么在global.asax里面我们必须定义CategoryPageKey这个字符创输出缓存的行为，见下面代码。

public override string GetVaryByCustomString(HttpContext context, String arg) {

string cacheKey = "";

switch(arg) {

case "CategoryPageKey":

if (Request.IsAuthenticated == true) {

cacheKey = "QQQ" + context.Request.QueryString["category_id"] + context.Request.QueryString["requestedPage"];

}

else {

cacheKey = "AAA" + context.Request.QueryString["category_id"] + context.Request.QueryString["requestedPage"];

}

break;

case "SearchPageKey" :

if (Request.IsAuthenticated == true) {

cacheKey = "QQQ" + context.Request.QueryString["search_text"] + context.Request.QueryString["requestedPage"];

}

else {

cacheKey = "AAA" + context.Request.QueryString["search_text"] + context.Request.QueryString["requestedPage"];

}

break;

case "ProductPageKey" :

if (Request.IsAuthenticated == true) {

cacheKey = "QQQ" + context.Request.QueryString["name"] + context.Request.QueryString["product_id"] + context.Request.QueryString["requestedPage"];

}

else {

cacheKey = "AAA" + context.Request.QueryString["name"] + context.Request.QueryString["product_id"] + context.Request.QueryString["requestedPage"];

}

break;

case "ProductDetailsPageKey" :

if (Request.IsAuthenticated == true) {

cacheKey = "QQQ" + context.Request.QueryString["item_id"] + context.Request.QueryString["requestedPage"];

}

else {

cacheKey = "AAA" + context.Request.QueryString["item_id"] + context.Request.QueryString["requestedPage"];

}

break;

case "UserID" :

if (Request.IsAuthenticated == true) {

cacheKey = "UserID_In";

}

else {

cacheKey = "UserID_Out";

}

break;

}

return cacheKey;

}

从上面对CategoryPageKey字符创所作的行为来看，当我们的请求页面中含有对特定的category_id的某一分页显示的数据页的请求时，将调用缓存（自然是已经缓存了该页）。

在源代码中设置页面缓存
@ OutputCache：以声明的方式控制 ASP.NET 页或页中包含的用户控件的输出缓存策略。
主要属性：

• Duration：页或用户控件进行缓存的时间（以秒计）。在页或用户控件上设置该属性为来自对象的 HTTP 响应建立了一个过期策略，并将自动缓存页或用户控件输出。这是必选属性。如果未包含该属性，将出现分析器错误。
• Location：指定有效值，用于控制资源的输出缓存 HTTP 响应的位置。默认值为 Any。包含在用户控件（.ascx 文件）中的 @ OutputCache 指令不支持此属性。

成员名称	说明
Any	输出缓存可位于产生请求的浏览器客户端、参与请求的代理服务器（或任何其他服务器）或处理请求的服务器上。
Client	输出缓存位于产生请求的浏览器客户端上。
Downstream	输出缓存可存储在任何 HTTP 1.1 可缓存设备中，源服务器除外。这包括代理服务器和发出请求的客户端。
Server	输出缓存位于处理请求的 Web 服务器上。
None	对于请求的页，禁用输出缓存。
ServerAndClient	输出缓存只能存储在源服务器或发出请求的客户端中。代理服务器不能缓存响应。

• CacheProfile：与该页关联的缓存设置的名称。这是可选属性，默认值为空字符串 ("")。包含在用户控件（.ascx 文件）中的 @ OutputCache 指令不支持此属性。在页中指定此属性时，属性值必须与 outputCacheSettings 节下面的 outputCacheProfiles 元素中的一个可用项的名称匹配。如果此名称与配置文件项不匹配，将引发异常。
• NoStore：一个布尔值，它决定了是否阻止敏感信息的二级存储。将此属性设置为 true 等效于在请求期间执行以下代码：Response.Cache.SetNoStore();包含在用户控件（.ascx 文件）中的 @ OutputCache 指令不支持此属性。
• Shared：一个布尔值，确定用户控件输出是否可以由多个页共享。默认值为 false。 包含在 ASP.NET 页（.aspx 文件）中的 @ OutputCache 指令不支持此属性。
• SqlDependency：标识一组数据库/表名称对的字符串值，页或控件的输出缓存依赖于这些名称对。可选值：database/table name pair和CommandNotification。SqlDependency 属性的 CommandNotification 值仅在网页 (.aspx) 中有效。用户控件只能将基于表的轮询用于 @ OutputCache 指令。
• VaryByCustom：表示自定义输出缓存要求的任意文本。如果赋予该属性的值为 browser，缓存将随浏览器名称和主要版本信息的不同而异。如果输入自定义字符串，则必须在应用程序的 Global.asax 文件中重写 GetVaryByCustomString 方法。
• VaryByHeader：分号分隔的 HTTP 标头列表，用于使输出缓存发生变化。将该属性设为多标头时，对于每个指定标头组合，输出缓存都包含一个不同版本的请求文档。

  设置 VaryByHeader 属性将启用在所有 HTTP 1.1 版缓存中缓存项，而不仅仅在 ASP.NET 缓存中进行缓存。用户控件中的 @ OutputCache 指令不支持此属性。

• VaryByParam：分号分隔的字符串列表，用于使输出缓存发生变化。默认情况下，这些字符串与随 GET 方法属性发送的查询字符串值对应，或与使用 POST 方法发送的参数对应。将该属性设置为多个参数时，对于每个指定参数组合，输出缓存都包含一个不同版本的请求文档。可能的值包括 none、星号 (*) 以及任何有效的查询字符串或 POST 参数名称。在 ASP.NET 页和用户控件上使用 @ OutputCache 指令时，需要该属性或 VaryByControl 属性。如果没有包含它，则发生分析器错误。如果不希望通过指定参数来改变缓存内容，请将值设置为 none。如果希望通过所有的参数值改变输出缓存，请将属性设置为星号 (*))。
• VaryByControl：一个分号分隔的字符串列表，用于更改用户控件的输出缓存。这些字符串代表用户控件中声明的 ASP.NET 服务器控件的 ID 属性值。在 ASP.NET 页和用户控件上使用 @ OutputCache 指令时，需要该属性或 VaryByParam 属性。
• VaryByContentEncodings：以分号分隔的字符串列表，用于更改输出缓存。将 VaryByContentEncodings 属性用于 Accept-Encoding 标头，可确定不同内容编码获得缓存响应的方式。