ASP.NET - Substitution Web 服务器控件概述

2019-11-17 04:01:16

字体：大中小

来源：转载

供稿：网友

您可以使用 Substitution 控件，在网页上创建可动态更新并可随后集成到缓存页中的区域。

一、方案

使用 Substitution 控件可以在要缓存输出的网页上指定要显示动态内容的部分。对于多数内容都要进行缓存的页，Substitution 控件提供了进行部分页缓存的简化的解决方案。您可以缓存整个页的输出，然后使用 Substitution 控件来指定页中不进行缓存的部分。缓存区域仅执行一次，且将一直从缓存读取，直至该缓存条目到期或被清除。动态区域则在每次请求页时都会执行。此缓存模型简化了其内容主要是静态内容的网页的代码，因为您不必在 Web 用户控件中对这些静态内容进行封装，以将它们放入缓存。例如，对于包含静态内容（如新闻故事）和显示广告的 AdRotator 控件的网页，此缓存模型就非常有用。新闻故事不会经常更改，这意味着可以将它们放入缓存。您可能会希望在用户每次请求该网页时显示一条新广告。AdRotator 控件直接支持缓存后替换，无论是否缓存了网页，它都会在网页每次回发时呈现一个新广告。

二、背景

缓存 asp.net 网页时，默认情况下，会缓存该网页的全部输出。在第一次请求时，该页将运行并缓存其输出。对于后续的请求，将通过缓存来完成，该页上的代码不会运行。

在某些情况下，您可能不但希望缓存 ASP.NET 网页，还希望在每次请求该网页时更新该网页上的选定部分。例如，您可能要缓存某页的很大一部分，但需要动态更新该页上的与时间高度相关的信息。

可以使用 Substitution 控件将动态内容插入到缓存页中。Substitution 控件不会呈现任何标记。因此，您需要将该控件绑定到网页或父级用户控件中的方法。您需要创建可返回要插入到网页中的信息的静态方法。由 Substitution 控件调用的方法必须符合下面的标准：

      ·必须为静态方法（在 Visual Basic 共享）。

·必须接受类型为 HttpContext 的参数。

·必须返回类型为 String 的值。

Substitution 控件无法访问网页上的其他控件，也就是说，您无法检查或更改其他控件的值。但代码却可使用传递给它的参数来访问当前网页的上下文。

在页运行时，Substitution 控件会调用该方法，然后用从该方法的返回值替换页上的 Substitution 控件。

代码示例

下面的示例演示如何使用 Substitution 控件在缓存页上创建可动态更新的内容。页的 Load 事件中的代码用当前时间来更新 Label 控件。因为页的缓存持续时间已设置为 60 秒，所以 Label 控件的文本不会更改，即使在 60 秒的时间内多次请求了该页。页上的 Substitution 控件调用静态方法 GetTime，该方法将以字符串的形式返回当前时间。每次刷新网页时，都会更新 Substitution 控件表示的值。

<%@ Page Language="C#" %>

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

<script runat="server">

    void Page_Load()

    {

        Label1.Text = DateTime.Now.ToString();

    }



    public static String GetTime(HttpContext context)

    {

      return DateTime.Now.ToString();

    }

</script>

<html>

<head runat="server"></head>

<body>

    <form id="form1" runat="server">

    <div>

    <p>

    <asp:Label runat="server" ID="Label1" />

    </p>

    <p>

    <asp:Substitution runat="server"

        ID="Substitution1"

        MethodName="GetTime" />

    </p>

    <p>

    <asp:Button runat="server" ID="Button1" Text="Submit"/>

    </p>

    </div>

    </form>

</body>

</html>

三、Substitution 类

      使用 Substitution 控件指定输出缓存网页上要以动态内容替换该控件的部分。Substitution 控件为要缓存大部分内容的页提供了一种缓存局部页的简化解决方案。可以对整页进行输出缓存，然后使用 Substitution 控件指定页中免于缓存的部分。需要缓存的区域只执行一次，然后从缓存读取，直至该缓存项到期或被清除。动态区域则在每次请求页时执行。由于不必对这些部分进行封装以缓存在 Web 用户控件中，因此，此缓存模型简化了主要是静态内容的页的代码。例如，如果页包含静态内容（如新闻报道）和显示广告的 AdRotator 控件，这种情况下，此缓存模型就很有用。新闻报道不会更改，这意味着它们可以缓存。但是，您希望在用户每次请求该页时都显示一条新广告。AdRotator 控件直接支持缓存后替换，无论页是否缓存，都在该页回发时呈现一个新广告。

      说明：在缓存页包含的用户控件中可以放置 Substitution 控件。但是，在输出缓存用户控件中不能放置 Substitution 控件。

      Substitution 控件执行时，会调用一个返回字符串的方法。该方法返回的字符串即为要在页中的 Substitution 控件的位置上显示的内容。使用 MethodName 属性指定要在 Substitution 控件执行时调用的回调方法的名称。指定的回调方法必须是包含 Substitution 控件的页或用户控件的静态方法。回调方法的签名必须与接受 HttpContext 参数并返回字符串的 HttPResponseSubstitutionCallback 委托的签名匹配。

若要操作页的输出缓存，可使用 @ OutputCache 指令、HttpCachePolicy 类或 Cache 属性。

Substitution 控件的另一种使用方法是，使用 HttpResponseSubstitutionCallback 委托实现缓存替换行为。此外，还可以在直接支持缓存替换功能的控件（如 AdRotator 控件）上实现缓存替换行为。

示例

下面的代码示例演示如何以声明方式将 Substitution 控件添加到输出缓存网页。加载页面时，将在一个标签中向用户显示当前的日期和时间。页面中的此区域仅 60 秒便缓存和更新一次。当 Substitution 控件执行时，将调用 GetCurrentDateTime 方法。GetCurrentDateTime 返回的字符串将显示给用户。每次刷新页时，都不会缓存和更新页中的这一部分。

<%@ outputcache duration="60" varybyparam="none" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server" language="C#">

  void Page_Load(object sender, System.EventArgs e)

  {

    // Display the current date and time in the label.

    // Output caching applies to this section of the page.

    CachedDateLabel.Text = DateTime.Now.ToString();

  }

  // The Substitution control calls this method to retrieve

  // the current date and time. This section of the page

  // is exempt from output caching.

  public static string GetCurrentDateTime (HttpContext context)

  {

    return DateTime.Now.ToString ();

  }

</script>

<html  >

<head runat="server">

  <title>Substitution Class Example</title>

</head>

<body>

  <form id="form1" runat="server">

    <h3>Substitution Class Example</h3>

    <p>This section of the page is not cached:</p>

    <asp:substitution id="Substitution1"

      methodname="GetCurrentDateTime"

      runat="Server">

    </asp:substitution>

    <br />

    <p>This section of the page is cached:</p>

    <asp:label id="CachedDateLabel"

      runat="Server">

    </asp:label>

    <br /><br />

    <asp:button id="RefreshButton"

      text="Refresh Page"

      runat="Server">

    </asp:button>

  </form>

</body>

</html>

上一篇：ASP.NET - Panel Web 服务器控件概述

下一篇：Java 中带包的类的编译与执行