Asp.net組件設計淺論

liuqg 2006-03-09

展開全文

一、什么是組件？

查看MSDN，微軟是這樣給組件定義的：在 .NET Framework 中，組件是指實現(xiàn) System.ComponentModel.IComponent 接口的一個類，或從實現(xiàn) IComponent 的類中直接或間接派生的類。這是從純語言（技術）角度下的定義，通俗的講，組件是“可獨立運作的軟件單元”，這里強調(diào)獨立運作，也就代表著組件必須擁有低耦合性、高重用性等特點。微軟將軟件劃分為兩部分：其一是Component，意指具備特定功能、可獨立運作、不具備UI接口的單元；其二是Control，也就是我們常說的控件，意指具備特定功能、可獨立運作的UI接口單元。

二、學習Asp.net組件需要掌握的知識

任意掌握一門.net語言，建議使用C#，C#是一門全新的語言，但又借鑒了C++和JAVA的語法，同時引入了一些新概念，在程序員中口啤不錯。

理解IIS的運行機制和asp.net的運行模式。

熟練掌握javascript，該腳本語言強大的功能在處理客戶端動作時表現(xiàn)非常出色，基本上所有的自定義組件都離不開javascript，同時，CSS和DHTML也是要心知肚明的。沒辦法，他們很少會單獨出現(xiàn)，總是喜歡集體演出。

三、組件設計的難度

這個問題不用問，也許您猜出了幾分，一個字：難。

您也許會有所察覺，在編寫asp.net應用程序時，很少會對viewstate作深入的研究，原因很簡單，因為ViewState本身設計的用戶對象本來就不是應用程序員，而是組件設計員。如果不是因為客戶端需要，您也不會在asp.net中編寫大量的javascript腳本，而在組件設計中，很難逃脫干系。不止這些，是否設計成服務器組件？我們的組件是繼承Control、還是繼承WebControl或是繼承Component？在組件中，需要自定義Attribute嗎？需要實現(xiàn)數(shù)據(jù)綁定嗎？如何繪制組件的外觀？如何和IIS通訊？需要post-back嗎？很多很多的問題，都需要組件設計者——辛苦的您去一一考慮。

所以，如果您不屑一顧地說：不就是設計一個組件嗎？這有何難！那么，我會嘿嘿一笑，因為我知道，您一定在開玩笑。

但是，千萬別怕，“程序員需要探索精神哦！”

四、基類的選擇

如果我們設計的是一個WEB可視控件，并且構(gòu)成WEB頁的一部分，那么可以繼承Control類或者WebControl類。如果是一個非可視控件，可以繼承Component，繼承此類的控件設計時不會出現(xiàn)在頁面上，而是出現(xiàn)在Component Tray中。還記得OpenFileDialog控件嗎？這個文件打開對話框控件就是出現(xiàn)在Component Tray控件中的。

如果我們只是在已有的控件基礎上增強功能，那么就繼承該已有的控件吧。

五、實踐出真知

假設我們要設計一個組件，該組件只允許用戶輸入數(shù)字，該驗證工作自然應該放到客戶端，客戶端的驗證腳本可以這樣寫：

<HTML>

<HEAD>

function Virty(ctrl)

{

if (event.keyCode == 13)

return true

if (event.keyCode < 48 || event.keyCode > 57)

return false;

else

return true;

}

</script>

</HEAD>

<BODY>

<p>

</p>

</form>

</BODY>

</HTML>

當然，這些驗證代碼不能由用戶去寫，應該由組件設計者去寫，也就是說，當用戶把該組件從工具箱中拖到頁面上后，運行時應該自動生成驗證代碼。向WEB頁繪制代碼，我們重寫OnPreRender()方法就可以了。

在重寫OnPreRender()方法之前，先寫定義幾個常量：

private const string SCP_NUMBER_ONLY_SCRIPT_ID="{29FD7A41-49FD-4fc4-AFA9-6A0B875A1A51}";

private const string SCP_NUMBER_ONLY_HOOK="return Virty(this);";

private const string SCP_NUMBER_ONLY_SCRIPT=

"<script language=\"JavaScript1.2\">\nfunction Virty (ctrl)\n{{\n"+

"if (event.keyCode == 13)\n return true;\n if (event.keyCode < 48 || event.keyCode > 57)\n return false;\n else\n return true;\n}}"+

"</script>";

下面的方法用于驗證代碼的生成：

private void RenderJavaScript()

{

if(!Page.IsClientScriptBlockRegistered(SCP_NUMBER_ONLY_SCRIPT_ID)) Page.RegisterClientScriptBlock(SCP_NUMBER_ONLY_SCRIPT_ID,string.Format(SCP_NUMBER_ONLY_SCRIPT,base.ID));

}

為什么會有Page.IsClientScriptBlockRegistered(SCP_NUMBER_ONLY_SCRIPT_ID)呢？我們想象一下，如果在WEB頁中有十個該控件，那是不是就要輸出十個這樣的腳本？顯然，這是畫蛇添足了，所以，我們要用IsClientScriptBlockRegistered（）判斷該腳本是否在客戶端輸出，如果腳本在客戶端已注冊，則不再輸出了。

接下來就是重寫OnPreRender()方法了，該方法負責向客戶端繪制腳本。

protected override void OnPreRender(EventArgs e)

{

base.OnPreRender (e);

RenderJavaScript();

}

大家應該注意到，該腳本需要事件觸發(fā)才會執(zhí)行，當用戶從瀏覽器輸入數(shù)據(jù)時，如果是非數(shù)字，則忽略該動作，否則才接受輸入。這就需要OnKeyPress="javascript:return Virty(this);"這段代碼了。那么，這段代碼怎么向客戶端輸出呢？重寫AddAttributesToRender（）方法吧，該方法負責繪制組件的屬性。于是，我們寫了下面一段代碼：

protected override void AddAttributesToRender(HtmlTextWriter writer)

{

base.AddAttributesToRender(writer);

writer.AddAttribute("OnKeyPress",SCP_NUMBER_ONLY_HOOK);

}

最后的源碼如下：

/////////////////////////////////////////////////////////////////////////////

/// 注意，本代碼版權(quán)所有者為黃忠成先生。

/// 在此表示感謝他寫的書《ASP.NET組件設計》

////////////////////////////////////////////////////////////////////////////

using System;

using System.Text;

using System.Drawing;

using System.Web;

using System.Web.UI;

using System.Web.UI.WebControls;

namespace PowerAsp.NET.Controls

{

[ToolboxBitmap(typeof(NumberEditor),"PowerAsp.NET.Controls.NumberEditor.bmp")]

public class NumberEditor:BaseEditor

{