Asp.net组件设计浅论

** Asp.net ** ** 组件设计浅论 ** ** **

一、什么是组件？

查看 MSDN ，微软是这样给组件定义的：在 .NET Framework 中，组件是指实现 System.ComponentModel.IComponent 接口的一个类，或从实现 IComponent 的类中直接或间接派生的类。这是从纯语言（技术）角度下的定义，通俗的讲，组件是“可独立运作的软件单元”，这里强调独立运作，也就代表着组件必须拥有低耦合性、高重用性等特点。微软将软件划分为两部分：其一是 Component ，意指具备特定功能、可独立运作、不具备 UI 接口的单元；其二是 Control ，也就是我们常说的控件，意指具备特定功能、可独立运作的 UI 接口单元。

二、学习 Asp.net 组件需要掌握的知识

任意掌握一门 .net 语言，建议使用 C# ， C# 是一门全新的语言，但又借鉴了 C++ 和 JAVA 的语法，同时引入了一些新概念，在程序员中口啤不错。

理解 IIS 的运行机制和 asp.net 的运行模式。

熟练掌握 javascript ，该脚本语言强大的功能在处理客户端动作时表现非常出色，基本上所有的自定义组件都离不开 javascript ，同时， CSS 和 DHTML 也是要心知肚明的。没办法，他们很少会单独出现，总是喜欢集体演出。

三、组件设计的难度

这个问题不用问，也许您猜出了几分，一个字：难。

您也许会有所察觉，在编写 asp.net 应用程序时，很少会对 viewstate 作深入的研究，原因很简单，因为 ViewState 本身设计的用户对象本来就不是应用程序员，而是组件设计员。如果不是因为客户端需要，您也不会在 asp.net 中编写大量的 javascript 脚本，而在组件设计中，很难逃脱干系。不止这些，是否设计成服务器组件？我们的组件是继承 Control 、还是继承 WebControl 或是继承 Component ？在组件中，需要自定义 Attribute 吗？需要实现数据绑定吗？如何绘制组件的外观？如何和 IIS 通讯？需要 post-back 吗？很多很多的问题，都需要组件设计者——辛苦的您去一一考虑。

所以，如果您不屑一顾地说：不就是设计一个组件吗？这有何难！那么，我会嘿嘿一笑，因为我知道，您一定在开玩笑。

但是，千万别怕，“程序员需要探索精神哦！”

四、基类的选择

如果我们设计的是一个 WEB 可视控件，并且构成 WEB 页的一部分，那么可以继承 Control 类或者 WebControl 类。如果是一个非可视控件，可以继承 Component ，继承此类的控件设计时不会出现在页面上，而是出现在 Component Tray 中。还记得 OpenFileDialog 控件吗？这个文件打开对话框控件就是出现在 Component Tray 控件中的。

如果我们只是在已有的控件基础上增强功能，那么就继承该已有的控件吧。

五、实践出真知

假设我们要设计一个组件，该组件只允许用户输入数字，该验证工作自然应该放到客户端，客户端的验证脚本可以这样写：

 1<html>
 2<head>
 3<meta content="Microsoft Visual Studio 6.0" name="GENERATOR"/>
 4<title></title>
 5<script language="javascript">
 6
 7function Virty(ctrl) 
 8
 9{ 
10
11if (event.keyCode == 13) 
12
13return true 
14
15if (event.keyCode < 48 || event.keyCode > 57) 
16
17return false; 
18
19else 
20
21return true; 
22
23} 
24
25</script>
26</head>
27<body>
28<form method="POST">
29<p>
30<input name="T1" onkeypress="javascript:return Virty(this);" size="20" type="text"/>
31</p>
32</form>
33</body>
34</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=

1<script language='\"JavaScript1.2\"'>\nfunction Virty (ctrl)\n{{\n"+ 
2
3"if (event.keyCode == 13)\n return true;\n if (event.keyCode < 48 || event.keyCode > 57)\n return false;\n else\n return true;\n}}"+ 
4
5"</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();

}

大家应该注意到，该脚本需要事件触发才会执行，当用户从浏览器输入数据时，如果是非数字，则忽略该动作，否则才接受输入。这就需要 OnKeyPress= "javascript:return Virty(this);" 这段代码了。那么，这段代码怎么向客户端输出呢？重写 AddAttributesToRender（）方法吧，该方法负责绘制组件的属性。于是，我们写了下面一段代码：

protected override void AddAttributesToRender(HtmlTextWriter writer)

{

base.AddAttributesToRender(writer);

writer.AddAttribute("OnKeyPress",SCP_NUMBER_ONLY_HOOK);

}

最后的源码如下：

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

/// 在此表示感谢他写的书《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

{

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

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

private const string SCP_NUMBER_ONLY_SCRIPT=

1<script language='\"JavaScript1.2\"'>\nfunction NumberEditor_KeyPress_Handle(ctrl)\n{{\n"  \+ 
2
3"if (event.keyCode == 13)\n return true;\n if (event.keyCode < 48 || event.keyCode > 57)\n return false;\n else\n return true;\n}}"  \+ 
4
5"</script>

" ;

//rending number-limit javaScript.

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));

}

protected override void AddAttributesToRender(HtmlTextWriter writer)

{

base .AddAttributesToRender(writer);

writer.AddAttribute( "OnKeyPress" ,SCP_NUMBER_ONLY_HOOK);

}

protected override void OnPreRender(EventArgs e)

{

base .OnPreRender (e);

RenderJavaScript();

}

public NumberEditor(): base ()

{

}