以上@ OutputCache指令設置頁面輸出緩存的有效期是100秒,並且根據查詢字符串參數location或者firstname來設置輸出緩存。例如,假設客戶端請求是“http://localhost/default.aspx?location=beijing”,那麼該頁面將被作爲緩存處理。
使用頁面輸出緩存API
上文介紹了使用@ OutputCache指令實現對於輸出緩存的各項設置。這種方法簡單易行,深得開發人員青睞。另外,ASP.NET 2.0還從ASP.NET 1.x中繼承和擴展了一種使用輸出緩存API來編程設置頁面輸出緩存的方法。該方法的核心是調用System.Web.HttpCachePolicy。該類主要包含用於設置緩存特定的HTTP標頭的方法和用於控制ASP.NET頁面輸出緩存的方法。與.NET Framework 1.x中的HttpCachePolicy類相比,.NET Framework 2.0中的HttpCachePolicy類得到了擴充和發展。主要是增加了一些重要方法,例如,SetOmitVarStar方法等。由於HttpCachePolicy類方法衆多,下面簡要說明一些常用方法。
SetExpires方法
用於設置緩存過期的絕對時間。它的參數是一個DataTime類的實例,表示過期的絕對時間。
SetLastModified方法
用於設置頁面的Last-Modified HTTP標頭。Last-Modified HTTP標頭表示頁面上次修改時間,緩存將依靠它來進行計時。如果違反了緩存限制層次結構,此方法將失敗。該方法的參數是一個DataTime類的實例。
SetSlidingExpiration方法
該方法將緩存過期從絕對時間設置爲可調時間。其參數是一個布爾值。當參數爲true時,Cache-Control HTTP標頭將隨每個響應而更新。此過期模式與相對於當前時間將過期標頭添加到所有輸出集的IIS配置選項相同。當參數爲false時,將保留該設置,且任何啓用可調整過期的嘗試都將靜態失敗。此方法不直接映射到HTTP標頭。它由後續模塊或輔助請求來設置源服務器緩存策略。
SetOmitVaryStar方法
ASP.NET 2.0新增的方法。用於指定在按參數進行區分時,響應是否應該包含vary:*標頭。方法參數是一個布爾值,若要指示HttpCachePolicy不對其VaryByHeaders屬性使用*值,則爲true;否則爲false。
SetCacheability方法
用於設置頁面的Cache-Control HTTP標頭。該標頭用於控制在網絡上緩存文檔的方式。該方法有兩種重載方式,所不同的是參數。一種重載方法的參數是HttpCacheability枚舉值,包括NoCache、Private、Public、Server、ServerAndNoCache和ServerAndPrivate(有關這些枚舉值的定義,可參考MSDN)。另一種方法的參數有兩個,一個參數是HttpCacheability枚舉值,另一個參數是字符串,表示添加到標頭的緩存控制擴展。需要注意的是,僅當與Private或NoCache指令一起使用時,字段擴展名纔有效。如果組合不兼容的指令和擴展,則此方法將引發無效參數異常。
下面舉例說明頁面緩存API的HttpCachePolicy類的使用方法。
HttpCachePolicy類示例源代碼
Response.Cache.SetExpires(DateTime.Now.AddSeconds(60));
Response.Cache.SetExpires(DateTime.Parse("6:00:00PM"));
Response類的Cache屬性用於獲取頁面緩存策略。該屬性的數據類型是HttpCachePolicy。可通過調用Response.Cache來獲取HttpCachePolicy實例,進而實現對於當前頁面輸出緩存的設置。如上代碼所示,第一行代碼表示輸出緩存時間是60秒,並且頁面不隨任何GET或POST參數改變,等同於“<%@ OutputCache Duration="60" VaryByParam="none" %>”。第二行代碼設置緩存過期的絕對時間是當日下午6時整。
頁面輸出緩存應用
以上兩小節分別介紹了使用@ OutputCache指令和API設置頁面輸出緩存功能的內容。實際上,兩種方法各有優點,使用@ OutputCache指令方法比較簡潔,但靈活性較差。使用API方法,能夠在運行時動態地修改緩存配置,處理更多的複雜需求。本節將利用這些知識,實現一個簡單的頁面輸出緩存應用的示例,其中既涉及@ OutputCache指令應用,又涉及頁面輸出緩存API。示例效果如圖12-1和圖12-2所示。
圖1 停止緩存的效果圖 圖12-2 執行緩存的效果圖
如圖1所示,應用程序初始顯示的是停止執行緩存的時間。當用戶刷新頁面(URL地址是http://localhost:5159/Code%2012-1/Default.aspx,其中5159是服務器臨時端口號)時,時間值將隨時變化,以便顯示當前的最新時間。如圖12-2所示,單擊“緩存時間”超鏈接後,頁面重定向到http://localhost:5159/Code%2012-1/Default.aspx?location=beijing。這時,頁面顯示的時間被緩存,數據過期時間爲5秒。如果不斷地刷新該頁,那麼每隔5秒鐘時間值才變化一次。
本節示例存在兩個關鍵點。一是在運行時實現停止緩存,二是配置@ OutputCache指令。這兩點都已經在應用程序Default.aspx文件中予以實現,下面列舉了該文件源代碼。
Default.aspx文件源代碼
<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
<%@ OutputCache Duration="5" VaryByParam="location" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<script language="C# " runat="server">
void Page_Load(object sender, EventArgs e)
{
//設置僅將緩存數據存儲在服務器上
Response.Cache.SetCacheability(HttpCacheability.Server);
string temp_location = Request.QueryString["location"];
//如果location爲空,則不緩存,否則根據@ OutputCache指令聲明執行緩存
if (temp_location == null)
{
//停止當前響應的所有服務器緩存
Response.Cache.SetNoServerCaching();
Label1.Text = "停止緩存的時間:" + DateTime.Now.ToString();
}
else
{
Label1.Text = "設置了緩存的時間:" + DateTime.Now.ToString();
}
}
</script>
<head id="Head1" runat="server">
<title>示例12-1</title>
<link id="InstanceStyle" href="StyleSheet.css" type="text/css" rel="stylesheet" />
</head>
<body>
<form id="form1" runat="server">
<div>
<fieldset style="width: 240px">
<legend class="mainTitle">設置頁面輸出緩存</legend>
<br />
<center><asp:Label ID="Label1" runat="server" CssClass="commonText"></asp:Label></center>
<br />
<a href="Default.aspx?location=beijing" class="littleMainTitle" >緩存時間</a><br />
</fieldset>
</div>
</form>
</body>
</html>
如上粗體代碼所示,代碼頭部的@ OutputCache指令設置了Duration和VaryByParam屬性,其指示數據過期時間爲5秒。同時,緩存根據參數location發生變化。另外,代碼還實現了Page_Load事件處理程序。在該程序中,首先,使用SetCacheability方法設置數據緩存必須存儲在服務器上,然後,獲取QueryString的location參數值,最後,根據location參數值進行判斷。如果location參數值爲空,則調用SetNoServerCaching方法停止當前響應的所有服務器緩存,並顯示當前時間值。雖然@ OutputCache指令配置了頁面輸出緩存,但是,不會執行頁面輸出緩存功能。如果location參數值不爲空,則直接顯示當前時間值。在這種情況下,將執行@ OutputCache指令的配置內容。