ASP.net 中 OutputCache 指令各个参数的作用

使用@ OutputCache指令 

使用@ OutputCache指令，能够实现对页面输出缓存的一般性需要。@ OutputCache指令在ASP.NET页或者页中包含的用户控件的头部声明。这种方式非常方便，只需几个简单的属性设置，就能够实现页面的输出缓存 策略。@ OutputCache指令声明代码如下。 

@ OutputCache指令代码 

＜%@ OutputCache CacheProfile =" " NoStore= "True | False" Duration ="#ofseconds" Shared ="True | False" Location ="Any | Client | Downstream | Server | None | ServerandClient " SqlDependency ="database/table name pair | CommandNotification " VaryByControl ="controlname" VaryByCustom ="browser | customstring" VaryByHeader ="headers" VaryByParam ="parametername" %＞ 

如上所示，在@ OutputCache指令中，共包括10个属性，它们是CacheProfile、NoStore、Duration、Shared、 Location、SqlDependency、VaryByControl、VaryByCustom、VaryByHeader和 VaryByParam。这些属性将对缓存时间、缓存项的位置、SQL数据缓存依赖等各方面进行设置。下面简要介绍以上属性的基本概念。 

CacheProfile 

用于定义与该页关联的缓存设置的名称。是可选属性，默认值为空字符("")。需要注意的是，包含在用户控件中的@ OutputCache指令不支持此属性。在页面中指定此属性时，属性值必须与Web.config文件＜outputCacheSettings＞配置 节下的outputCacheProfiles元素中的一个可用项的名称匹配。如果此名称与配置文件项不匹配，将引发异常。 

NoStore 

该属性定义一个布尔值，用于决定是否阻止敏感信息的二级存储。需要注意的是，包含在用户控件中的@ OutputCache指令不支持此属性。将此属性设置为true等效于在请求期间执行代码“Response.Cache.SetNoStore();”。 

Duration 

用于设置页面或者用户控件缓存的时间。单位是秒。通过设置该属性，能够为来自对象的HTTP响应建立了一个过期策略，并将自动缓存页或用户控件输出。需要注意的是，Duration属性是必需的，否则将会引起分析器错误。 

Shared 

该属性定义一个布尔值，用于确定用户控件输出是否可以由多个页共享。默认值为false。注意，包含在ASP.NET页中的@ OutputCache指令不支持此属性。 

Location 

用于指定输出缓存项的位置。其属性值是OutputCacheLocation枚举值，它们是Any、Client、Downstream、None、 Server和ServerAndClient。默认值是Any，表示输出缓存可用于所有请求，包括客户端浏览器、代理服务器或处理请求的服务器上。需要注意的是，包含在用户控件中的@ OutputCache指令不支持此属性。 

SqlDependency 

该属性标识一组数据库/表名称对的字符串值，页或控件的输出缓存依赖于这些名称对。需要注意：SqlCacheDependency类监视输出缓存所依赖 的数据库中的表，因此，当更新表中的项时，使用基于表的轮询将从缓存中移除这些项。当通知（在SQL Server 2005中）与CommandNotification值一起使用时，最终将使用SqlDependency类向SQL Server 2005服务器注册查询通知。另外，SqlDependency属性的CommandNotification值仅在ASP.NET页中有效。控件只能将 基于表的轮询用于@ OutputCache指令。 

VaryByControl 

该属性使用一个分号分隔的字符串列表来更改用户控件的输出缓存。这些字符串代表在用户控件中声明的ASP.NET服务器控件的ID属性值。除非已经包含了VaryByParam属性，否则在@ OutputCache指令中，该属性是必需的。 

<%@OutputCache Duration="60" VaryByParam="txtCity"%>页面中有一个ＩＤ为txtCity的TextBox控件

如此一来，asp.net会对txtCity控件的值进行判断，只有输入的值和缓存值相同，才从缓存中取出相应的值。

VaryByCustom 

用于自定义输出缓存要求的任意文本。如果赋予该属性值是browser，缓存将随浏览器名称和主要版本信息的不同而异。如果输入了自定义字符串，则必须在 应用程序的Global.asax文件中重写HttpApplication.GetVaryByCustomString方法。 

VaryByHeader 

该属性中包含由分号分隔的HTTP标头列表，用于使输出缓存发生变化。当将该属性设为多标头时，对于每个指定的标头，输出缓存都包含一个请求文档的不同版 本。VaryByHeader属性在所有HTTP 1.1缓存中启用缓存项，而不仅限于ASP.NET缓存。用户控件中的@ OutputCache指令不支持此属性。 

VaryByParam 

该属性定义了一个分号分隔的字符串列表，用于使输出缓存发生变化。默认情况下，这些字符串与用GET方法属性发送的查询字符串值对应，或与用POST方法 发送的参数对应。当将该属性设置为多参数时，对于每个指定的参数，输出缓存都包含一个请求文档的不同版本。可能的值包括“none”、“*”和任何有效的 查询字符串或POST参数名称。值得注意的是，在输出缓存ASP.NET页时，该属性是必需的。它对于用户控件也是必需的，除非已经在用户控件的@ OutputCache指令中包含了VaryByControl属性。如果没有包含，则会发生分析器错误。如果不需要使缓存内容随任何指定参数发生变化， 则可将该值设为“none”。如果要使输出缓存根据所有参数值发生变化，则将属性设置为“*”。

 

 

例如：
如果命令设置为：

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

 

当请求路径 bitauto.com/test.aspx?ProductType=1发生时，会建立缓存

当ProductType的值变为2时，系统会建立新的缓存,但是原来的缓存在有效期内并不会失效。相当于为不同的ProductType值建立了不同版本的缓存。如果熟悉.Net数据缓存的话，很类似于下面的用法。

Cache.Add(“productType1”,cachedObject)

Cache.Add(“productType2”,cachedObject)

 

 

示例

<%@ 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 引用该控件即可）。

 

 

 

参考文档：

1.       ASP.NET 缓存：方法和最佳实践
http://www.microsoft.com/china/MSDN/library/WebServices/ASP.NET/ASP.NETCaching-TechniquesandBestPractiCEs.mspx?mfr=true
2.       数据缓存中页面部分和用户控件部分的说明 http://www.cnblogs.com/chenou/articles/603547.html
3.       ASP.NET缓存策略经验谈
http://www.cnblogs.com/imissherso/articles/635563.html
4.       ASP.NET 2.0的页面缓存功能介绍 http://www.cnblogs.com/Joshualang/archive/2007/01/24/OutputCache.html
5.       移除用户控件的输出缓存(OutputCache)
http://www.cnblogs.com/Truly/archive/2006/10/12/527206.aspx
6.       P.NET 2.0 缓存技术 （原创）
http://www.cnblogs.com/ghd258/archive/2005/11/03/248896.html
7.       页面输出缓存
http://www.cnblogs.com/hide0511/archive/2006/10/21/535702.html