@ OutputCache

以声明的方式控制 ASP.NET 页或页中包含的用户控件的输出缓存策略。 有关输出缓存的更多信息，请参见 ASP.NET 缓存。

<%@ OutputCache Duration="#ofseconds"
   Location="Any | Client | Downstream | Server | None | 
     ServerAndClient "
   Shared="True | False"
   VaryByControl="controlname"
   VaryByCustom="browser | customstring"
   VaryByHeader="headers"
   VaryByParam="parametername" 
   VaryByContentEncoding="encodings"
   CacheProfile="cache profile name | ''"
   NoStore="true | false"
   SqlDependency="database/table name pair | CommandNotification"
   ProviderName="Provider Name"  
%>

特性

• Duration
  页或用户控件进行缓存的时间（以秒计）。 在页或用户控件上设置该特性为来自对象的 HTTP 响应建立了一个过期策略，并将自动缓存页或用户控件输出。

  注意
  此特性必选。如果未包含该属性，将出现分析器错误。

• Location
  OutputCacheLocation 枚举值之一。 默认值为 Any。

  注意
  包含在用户控件（.ascx 文件）中的 @ OutputCache 指令不支持此特性。

• CacheProfile
  与该页关联的缓存设置的名称。 这是可选特性，默认值为空字符串 ("")。

  注意
  包含在用户控件（.ascx 文件）中的 @ OutputCache 指令不支持此特性。在页中指定此属性时，属性值必须与 outputCacheSettings 节下面的 outputCacheProfiles 元素中的一个可用项的名称匹配。如果此名称与配置文件项不匹配，将引发异常。

• NoStore
  一个布尔值，它决定了是否阻止敏感信息的二级存储。

  注意
  包含在用户控件（.ascx 文件）中的 @ OutputCache 指令不支持此特性。将此特性设置为 true 等效于在请求期间执行以下代码：

              Response.Cache.SetNoStore();
  

• ProviderName
  一个字符串值，标识要使用的自定义输出缓存提供程序。 有更多信息，请参见本主题 Remarks 这一节和 Scott Guthrie 博客上的 Extensible Output Caching with ASP.NET 4 (VS 2010 and .NET 4.0 Series) 文章。

  注意
  此属性仅在用户控件（.ascx 文件）中受到支持。它不受包含在 ASP.NET 页（.aspx 文件）中的 @ OutputCache 指令的支持。

• Shared
  一个布尔值，确定用户控件输出是否可以由多个页共享。 默认值为 false。 有关更多信息，请参见备注部分。

  注意
  包含在 ASP.NET 页（.aspx 文件）中的 @ OutputCache 指令不支持此特性。

• SqlDependency
  标识一组数据库/表名称对的字符串值，页或控件的输出缓存依赖于这些名称对。 请注意，SqlCacheDependency 类监视输出缓存所依赖的数据库中的表，因此当更新表中的项时，使用基于表的轮询时将从缓存中移除这些项。 如果以值 CommandNotification 使用通知（在 Microsoft SQL Server 2005 中），则最终会使用 SqlDependency 类向 SQL Server 2005 服务器注册查询通知。

  注意
  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 页的某些部分。

  注意
  在 ASP.NET 页和用户控件上使用 @ OutputCache 指令时，需要此特性或 VaryByParam 特性。

• VaryByContentEncodings
  以分号分隔的字符串列表，用于更改输出缓存。 将 VaryByContentEncodings 特性用于 Accept-Encoding 标头，可确定不同内容编码获得缓存响应的方式。 有关如何指定 Accept-Encoding 标头的更多信息，请参见 W3C 网站上的 Hypertext Transfer Protocol -- HTTP/1.1（超文本传输协议 -- HTTP/1.1）规范的 14.3 节。

备注

设置页输出缓存的值与通过 Cache 属性操作 SetExpires 和 SetCacheability 方法的过程相同。

如果 Web 窗体页要求用户查看授权，则输出缓存将 Cache-Control HTTP 标头设置为 private。 有关所有这些主题的更多信息，请参见 缓存 ASP.NET 页。

如果将 Shared 特性设置为 true，则多个 Web 窗体页可以访问缓存的用户控件输出。 如果未将其设置为 true，则默认行为是为包含该控件的每一页缓存一个用户控件输出版本。 通过启用 Shared 特性，可能可以节省大量内存。 有关更多信息，请参见 缓存 ASP.NET 页的某些部分。

示例

下面的代码示例演示如何设置页或用户控件进行输出缓存的持续时间。

<%@ OutputCache Duration="100" VaryByParam="none" %>

下一个代码示例演示如何指示输出缓存按页或用户控件的位置对它们进行缓存，并根据窗体的 POST 方法或查询字符串对窗体参数进行计数。 每个收到的具有不同位置或计数参数（或两者）的 HTTP 请求都进行 10 秒的缓存处理。 带有相同参数值的任何后继请求都将从缓存中得到满足，直至超过输入的缓存期。

<%@ OutputCache Duration="10" VaryByParam="location;count" %>

请参见

参考

文本模板指令语法

概念

ASP.NET 缓存概述

缓存 ASP.NET 页

缓存 ASP.NET 页的某些部分

ASP.NET 网页语法概述