ASP.NET下的Page Controller以及Template Method
2024-07-10 12:57:13
供稿：網友
您要在 asp.net 中構建 web 應用程序，您希望通過使用內置的 page controller（頁面控制器）來利用 asp.net 的事件驅動特性。
實現策略
默認情況下，page controller 模式中所描述的概念是在 asp.net 中實現的。asp.net 頁面框架實現這些概念所采取的方式使得在客戶端上捕獲事件、將其傳輸到服務器并調用適當方法這一系列操作的基本機制是自動進行的，并且對實現者來說是不可見的。頁面控制器是可擴展的，因為它會在生命周期的特定點上公開各種事件（請參閱此模式后面的"頁面生命周期"），因此，與應用程序具體相關的操作可以在適當的時候運行。
例如，假定用戶正在與包含一個按鈕服務器控件的 web 窗體頁進行交互（請參閱此模式后面的"簡單頁面示例"）。當用戶單擊按鈕控件時，一個事件將作為 http 投遞內容傳送到服務器，在那里，asp.net 頁面框架會解釋投遞的信息，并將引發的事件與適當的事件處理程序相關聯。框架自動調用該按鈕的適當事件處理程序，作為框架的正常處理的一部分。因此，您不再需要實現此功能。此外，您還可以使用內置控制器，或者，您可以用自己自定義的控制器來代替內置控制器（請參閱 front controller）。
頁面生命周期
下面按發生順序列出了頁面生命周期中最常見的各個階段。其中還包括引發的特定事件，以及處理請求時在各個階段可能執行的一些典型操作：
asp.net 頁面框架初始化（事件：init）。這是生命周期的第一個步驟，該步驟將初始化 asp.net 運行庫以便為響應請求做好準備。
用戶代碼初始化（事件：load）。您應該執行與應用程序具體相關的常見任務，例如，當頁面控制器引發 load 事件時打開數據庫連接。您可以假設：引發 load 事件后，服務器控件已創建并完成初始化、狀態已還原并且窗體控件反映了客戶端的更改。 [reilly02]
與應用程序相關的事件處理。在此階段，您應該執行與應用程序相關的處理，以響應控制器引發的事件。 .
清理（事件：unload）。該頁面已完成生成，現在可以丟棄。您應該關閉 load 事件打開的任何數據庫連接，丟棄任何不再需要的對象。在連接對象被作為垃圾回收后，microsoft?.net framework 將自動關閉數據庫連接。不過，您對何時進行垃圾回收沒有任何控制權。因此，顯式關閉數據庫連接以充分利用數據庫連接池是一個很好的做法。
注意：還有幾個頁面處理階段沒有在這里列出。不過，這些階段不用于大多數頁面處理情況。
簡單頁面示例
第一個示例是一個簡單頁面，它接受來自用戶的輸入，然后在屏幕上顯示該輸入。該示例說明了 asp.net 用于實現服務器控件的事件驅動模型。
圖 1: 簡單頁面
當用戶鍵入他或她的名字、然后單擊"click here"按鈕后，鍵入的名字將直接出現在按鈕下面，如圖 2 所示。
圖 2: 顯示用戶輸入的簡單頁面
在 asp.net 網頁中，用戶界面編程分為兩個不同的部分：可視組件（或視圖）和結合了模型和控制器的邏輯。這種劃分將頁面的可視部分（視圖）同與頁面交互的、頁面后面的代碼（模型和控制器）分離開來。
可視元素稱為 web 窗體頁。該頁面由包含靜態 html 服務器控件或 asp.net 服務器控件（或同時包含這兩種控件）的文件構成。在此示例中，web 窗體頁名為 simplepage.aspx，它由以下代碼組成：
<%@ page language="c#" codebehind="simplepage.aspx.cs" autoeventwireup="false" inherits="simplepage" %>
<html>
<body>
<form id="form1" runat="server">
name:<asp:textbox id="name" runat="server" />
<p />
<asp:button id="mybutton" text="click here" onclick="submitbtn_click" runat="server" />
<p />
<span id="myspan" runat="server"></span>
</form>
</body>
</html>
web 窗體頁的邏輯由為了與窗體進行交互而創建的代碼構成。編程邏輯放在一個與用戶界面文件分離的文件中。此文件被稱為"代碼隱藏"文件，文件名是 simplepage.aspx.cs：
using system;
using system.web.ui;
using system.web.ui.webcontrols;
using system.web.ui.htmlcontrols;
public class simplepage : system.web.ui.page
{
protected system.web.ui.webcontrols.textbox name;
protected system.web.ui.webcontrols.button mybutton;
protected system.web.ui.htmlcontrols.htmlgenericcontrol myspan;
public void submitbtn_click(object sender, eventargs e)
{
myspan.innerhtml = "hello, " + name.text + ".";
}
}
此代碼的用途是通知頁面控制器：當用戶單擊按鈕后，將向服務器發送一個請求，并執行 submitbtn_click 函數。
此實現顯示了連接到控制器所提供的事件是多么簡單。它還說明，用這種方式編寫的代碼更易于理解，因為應用程序邏輯沒有與管理事件調度的低級代碼結合起來。
公用外觀示例
下面的示例使用頁面控制器的典型實現策略來提供顯示動態內容的橫幅，該橫幅在應用程序的每一頁上顯示已驗證的用戶的電子郵件地址（該地址是從數據庫檢索的）。
站點內的所有頁面對象所繼承的基類中包含了公用實現。圖 3 顯示了站點中的一個網頁。
圖 3: 顯示動態內容的橫幅
站點中的各個頁面負責呈現自己的內容，而基類則負責呈現頭信息。因為各個頁面是從基類繼承的，所以它們都具有相同的功能。
此實現使用了稱為 template method的設計模式。該模式在一個操作中定義了一個算法的框架，而將一些步驟交給子類完成。template method 允許子類重新定義算法的某些步驟，而不必更改該算法的結構。 [gamma95]
將 template method 應用于此問題需要將公用代碼從各個頁面移到一個基類中。這樣可以確保公用代碼放在一個地方，并且很容易維護。在此示例中，基類名為 basepage 并負責將 page_load 方法連接到 load 事件。與 basepage 相關的工作（即從數據庫檢索用戶的電子郵件地址和設置站點名）完成后，page_load 函數將調用名為 pageloadevent 的方法。子類實現 pageloadevent，以執行它們自己的特定 load 功能。圖 4 顯示了此解決方案的結構。
圖 4: 代碼隱藏頁面實現的結構
請求網頁時，asp.net 運行庫會觸發 load 事件，該事件再調用 basepage 的 page_load 方法。basepage 方法檢索所需數據，然后對所請求的特定頁面調用 pageloadevent，以執行任何與頁面相關的所需加載。圖 5 顯示了頁面請求序列。
圖 5: 頁面請求序列
通過以這種方式實現公用功能，頁面不必設置頭信息，并且還可以很容易地進行整個站點的更改。如果頭信息呈現和初始化代碼不包含在一個文件中，則必須對包含與頭信息有關的代碼的所有文件進行更改。
basepage.cs
基類代碼實現了以下功能：
將 load 事件連接到 page_load 方法，以便進行與請求具體相關的初始化。
從請求上下文檢索已驗證的用戶的名字，并使用 databasegateway 類在數據庫中查找該用戶的記錄。該代碼將 email 標簽分配給用戶的電子郵件地址。
將站點名分配給 sitename 標簽。
調用 pageloadevent 方法，可以由派生類實現該方法以進行任何與頁面相關的加載。
注意：最好將 basepage 類定義為抽象類，因為這樣可以強制實現者提供 pageloadevent 的實現。不過，在 microsoft visual studio® .net 中，不可能將此基類定義為抽象類。相反，該類提供可由派生類覆蓋的默認實現。
using system;
using system.web.ui;
using system.web.ui.webcontrols;
public class basepage : page
{
protected label email;
protected label sitename;
virtual protected void pageloadevent(object sender, system.eventargs e)
{}
protected void page_load(object sender, system.eventargs e)
{
if(!ispostback)
{
string name = context.user.identity.name;
email.text = databasegateway.retrieveaddress(name);
sitename.text = "micro-site";
pageloadevent(sender, e);
}
}
#region web form designer generated code
override protected void oninit(eventargs e)
{
//
//
// codegen: 此調用是 asp.net web 窗體設計器所必需的。
//
initializecomponent();
base.oninit(e);
}
/// <summary>
/// 設計器支持所必需的方法 - 不要使用代碼編輯器修改
/// 此方法的內容。
/// </summary>
private void initializecomponent()
{
this.load += new system.eventhandler(this.page_load);
}
#endregion
}
basepage.inc
您不僅必須為頁面后面的邏輯代碼提供公用基類，而且還必須提供用來保存視圖或 ui 的呈現代碼的公用文件。該代碼包括在每個 .aspx 頁面中。此 html 文件不是為了用于進行獨立顯示。通過使用公用文件，您可以在一個地方進行更改，并將這些更改傳播到包括該文件的所有網頁。下面的示例代碼顯示了此示例的公用文件，文件名為 basepage.inc：
<table width="100%" cellspacing="0" cellpadding="0">
<tr>
<td align="right" bgcolor="#9c0001" cellspacing="0" cellpadding="0" width="100%" height="20">
<font size="2" color="#ffffff">歡迎：
<asp:label id="email" runat="server">username</asp:label> </font>
</td>
</tr>
<tr>
<td align="right" width="100%" bgcolor="#d3c9c7" height="70">
<font size="6" color="#ffffff">
<asp:label id="sitename" runat="server">micro-site banner</asp:label> </font>
</td>
</tr>
</table>
databasegateway.cs
該類封裝了這些頁面對數據庫的所有訪問。這是 table data gateway [fowler03] 的一個例子，它提供了此應用程序中的頁面的模型代碼。
using system;
using system.collections;
using system.data;
using system.data.sqlclient;
public class databasegateway
{
public static string retrieveaddress(string name)
{
string address = null;
string selectcmd =
string.format("select * from webuser where (id = '{0}')",
name);
sqlconnection myconnection =
new sqlconnection("server=(local);database=webusers;trusted_connection=yes");
sqldataadapter mycommand = new sqldataadapter(selectcmd, myconnection);
dataset ds = new dataset();
mycommand.fill(ds,"webuser");
if(ds.tables["webuser"].rows.count == 1)
{
datarow row = ds.tables["webuser"].rows[0];
address = row["address"].tostring();
}
return address;
}
}
page1.aspx
下面是如何在頁面中使用公用功能的示例：
<%@ page language="c#" codebehind="page1.aspx.cs" autoeventwireup="false" inherits="page1" %>
<html>
<head>
<title>page-1</title>
</head>
<body>
<!-- #include virtual="basepage.inc" -->
<form id="page1" method="post" runat="server">
<h1>page:
<asp:label id="pagenumber" runat="server">nn</asp:label></h1>
</form>
</body>
</html>
該文件中的以下指令用于加載頭信息的公用 html：
<!-- #include virtual="basepage.inc" -->
page1.aspx.cs
代碼隱藏類必須從 basepage 類繼承，然后實現 pageloadevent 方法來進行任何與頁面具體相關的加載。在此示例中，與頁面具體相關的活動是將數字 1 分配給 pagenumber 標簽。
using system;
using system.web.ui;
using system.web.ui.webcontrols;
public class page1 : basepage
{
protected system.web.ui.webcontrols.label pagenumber;
protected override void pageloadevent(object sender, system.eventargs e)
{
pagenumber.text = "1";
}
}
測試考慮事項
對 asp.net 運行庫的依賴性使實現的測試變得很困難。不可能對從 system.web.ui.page 或環境中包含的其他各種類繼承而來的類進行實例化。這樣就不可能對應用程序的各個部分單獨進行單元測試。自動測試此實現的唯一方法是，生成 http 請求，然后檢索 http 響應，確定響應是否正確。此方法容易產生錯誤，因為您是將響應的文本與預期的文本進行比較。
結果上下文
內置的 asp.net 頁面控制器功能具有以下優缺點：
優點
充分利用框架功能。頁面控制器功能內置在 asp.net 中，通過將與應用程序具體相關的動作連接到由控制器公開的事件，可以輕松地對它進行擴展。另外，通過使用代碼隱藏功能，還可以很容易地將與控制器具體相關的代碼與模型和視圖代碼分離開來。
顯式 url。用戶輸入的 url 引用了應用程序中的實際網頁。這意味著這些網頁可以作為書簽，并在以后輸入。url 還傾向于使用更少的參數，以便讓用戶更容易輸入它們。
增加了模塊性和重用性。"公用外觀"示例說明了您可以如何對許多頁面重用 basepage，而不必修改 basepage 類或 html 文件。
缺點
需要更改代碼。正如"公用外觀"示例中說明的那樣，為了共享公用功能，必須對各個網頁進行修改，以便繼承新定義的基類而不是 system.web.ui.page。intercepting filter 模式描述了通過更改 web.config 文件而不是網頁本身來添加公用功能的機制。
使用繼承。"公用外觀"示例通過使用繼承來讓多個網頁共享實現。學習面向對象編程方法的大多數程序員一開始會喜歡繼承。不過，使用繼承來共享實現常常會導致軟件很難更改。如果基類因條件邏輯而變得復雜，最好引入幫助器類或者考慮使用 front controller 。
難以測試。由于頁面控制器是在 asp.net 中實現的，因此很難單獨測試。要提高可測試性，您應該將同樣多的功能從 asp.net 專用代碼中分隔到不依賴于 asp.net 的類中。這樣，不必啟動 asp.net 運行庫就能進行測試。
相關模式
有關詳細信息，請參閱以下相關模式：
template method [gamma95]。basepage 類和 page_load 方法是此模式的示例實現。
intercepting filter.
front controller.
致謝
[gamma95] gamma, helm, johnson, and vlissides. design patterns: elements of reusable object-oriented software. addison-wesley, 1995.
[reilly02] reilly, douglas j. designing microsoft asp.net applications. microsoft press, 2002.
[fowler03] fowler, martin. patterns of enterprise application architecture. addison-wesley, 2003.
中國最大的web開發資源網站及技術社區，
