探讨微软ASP.NET AJAX控件开发技术(客户端)

作者:网络 来源:佚名 更新时间:2008-11-07 01:54:07 点击:

  本系列文章将通过具体的实例从客户端和服务端两个角度全面探讨asp.net ajax框架中的控件(control)开发所涉及的技术。

  一、 简介

  如今,asp.net ajax框架以其与asp.net 2.0系统的有机整合与完全面向对象的客户端javascript组件模型正在吸引着越来越多的人员。此外,这个框架还为基于asp.net 2.0平台的ajax 提供了一揽子方案(尽管尚嫌稚气)。

  首先,我们来回忆asp.net ajax框架设计的主要目标:其一,扩展现有的asp.net服务器端模型,让其能够生成支持富客户端的javascript代码;其二,为asp.net应用增加客户端编程模型,让纯粹的客户端编程变得更为容易。

  基于此,我们至少可以从如下两个方面来扩展asp.net ajax框架。第一,创建更为丰富的asp.net ajax服务器端扩展器控件,以便为这些控件提供丰富的客户端ajax行为。此部分的极好例证就是ajax control toolkit中的大部分控件。第二,创建纯粹的客户端组件/控件。这部分的例证就是框架已经实现的对于常规html元素的封装、高级客户端控件listview及客户端离线数据源datasource等。为此,控件开发者可以创建新的客户端组件/控件来封装典型的客户端功能,或者基于现有客户端组件/控件加以扩展。

  【说明】第一,事实上,我们可以进一步沿着asp.net ajax客户端与服务器端架构层次关系图进一步扩展其底层。第二,要开发asp.net ajax控件要求开发人员首先具备关于asp.net ajax框架的客户端和服务器器知识(相比而言,在具体编程的过程中要求掌握更多的客户端相关知识)。

  在本文中,我们将从客户端和服务端两个角度全面探讨asp.net ajax框架中的控件开发相关技术。首先,让我们从客户端开始。

  二、 控件开发客户端相关技术

|||
  • 本文来源于网页设计爱好者web开发社区http://www.html.org.cn收集整理,欢迎访问。
  •   微软ajax库的最伟大之处在于,它扩展了javascript的面向对象编程模型并且提供一个增强的类型系统(其中包含命名空间,类,接口,枚举,异常处理,反射及其它为.net开发者所熟悉的结构)。

      尽管ajax控件都是继承自sys.ui.control,但是,整个ajax控件的核心却是sys.comoponent类。这个类模拟了.net框架的system.componentmodel.comoponent类。图1展示了在ajax控件开发中继承类之间关系的示意图。

      探讨微软asp.net ajax控件开发技术(客户端)

      图1.ajax控件开发中所涉及的类关系图。

      (一) sys.idisposable

      这个接口类似于.net框架的idisposable接口。组件利用的所有资源都应该在dispose方法中释放。具体地说,这些资源包括事件处理器,大型数组,等等。

      (二) sys.inotifydisposing

      这个接口允许组件用户通过disposing事件检测该组件的释放情况。

      (三) sys.inotifypropertychange

      这个接口允许组件用户通过propertychanged事件检测有关属性的改变情况。在本文后面,我们还要对此展开详细的讨论。

      (四) sys.component

      该sys.component类要实现上面所有的接口。封装了复杂的逻辑或包含子dom元素的组件一般都要求使用一个中央位置用于初始化和清除类的实例。这通常是通过重载sys.component类的initialize和dispose方法实现的。下列图2展示了sys.component类的主要功能。

      探讨微软asp.net ajax控件开发技术(客户端)

    |||

      图2—sys.component类主要功能展示。

      进一步归纳来看,共存在两种类型的组件:

       nonvisual(非可视化的)

       visual(可视化的)

      一个非可视化的组件没有任何用户接口。一个典型的例子是asp.netajax框架内置的定时器控件或一个定制的对web服务进行队列调用的组件。非可视化组件类似于asp.net中的objectdatasource和tableadapter控件,但是没有任何用户接口。

      另一方面,可视化的组件则提供了一个用户接口。一个典型的例子是ajax control toolkit中的控件,updateprogress,以及ajaxgrid控件等等。其实,我们还可以把可视化组件进一步划分为:

       action(sys.ui.action)

       control(sys.ui.control)

      (五) sys.ui.action

      一个行为(action)的目的是用来扩展一个dom元素而不改变它的核心功能。ajax control toolkit中的大多数控件就属于行为,例如该autocompletetextbox,maskedit,dragpanel等。一个行为必须拥有一个相关联的dom元素。注意,单个dom元素可以拥有多个与之相关联的行为。既然本文的重点在讨论控件的开发技术,所以,我们不再进一步讨论行为的概念。如果你对此感兴趣的话,请访问ajax control toolkit站点。

      (六) sys.ui.control

      相对于上面的action而言,一个control(控件)本身就是一个dom元素。创建一个控件的主要目的是通过对一个现有控件加以包装进而提供新的功能。其典型的示例就是updatepanel,updateprogress或ajax control toolkit中新加入的tab控件。下列的代码向你展示了创建一个控件所要求的最少代码。

      列表1.构建一个客户端控件至少需要实现的javascript框架代码。

    |||

    最大的网站源码资源下载站,

    type.registernamespace('dummynamespace');
    dummynamespace.dummycontrol = function(element)
    {
    dummynamespace.dummycontrol.initializebase(this, [element]);
    }
    dummynamespace.dummycontrol.prototype =
    {
    initialize : function()
    {
    dummynamespace.dummycontrol.callbasemethod(this, 'initialize');
    },
    dispose : function()
    {
    dummynamespace.dummycontrol.callbasemethod(this, 'dispose');
    }
    }
    dummynamespace.dummycontrol.registerclass('dummynamespace.dummycontrol',
    sys.ui.control);
    if (typeof (sys) != 'undefined')
    {
    sys.application.notifyscriptloaded();
    }

      上面所列出的仅是一个控件的框架代码。如你所见,与之相关联的dom元素作为参数传入该控件的构造器函数中。我们还要重载initialize和dispose方法以便执行初始化和最后释放控件时的清理工作。因为在此列出的仅是一个虚构的控件,所以,除了调用基类的一些方法外我们什么也没有做。下列图3展示了sys.ui.control类提供的主要功能。

      探讨微软asp.net ajax控件开发技术(客户端)

       图3—sys.ui.control类提供的方法。

      一个控件和一个行为之间的另一个区别在于,一个行为允许你设置一个id而一个控件却不允许。事实上,一个控件的id与其相关联的dom元素是一致的。下面是这个类中常用方法(有些是父类提供)的详细解释。

    |||
    |||

      三、 实例分析

      在本示例中,我们将创建一个增强的客户端imagebutton控件。这个控件在鼠标移过时将显示一幅不同的图像。

      (一)创建示例ajax网站

      启动visual studio 2005,选择“文件→新建网站…”,然后选择“asp.net ajax-enabled web site”模板,命名工程为“ajaxclientctrltest”,并选择c#作为内置支持语言,最后点击ok。

      注意,此后系统将自动加入对于程序集system.web.extensions.dll的引用(因其被自动加入到gac中,所以默认情况下无法直接看到)。当然,你还会注意到,作为asp.net ajax控制中心的服务器控件scriptmanager被自动地添加到默认网页default.aspx中。然后,把一个html <image>元素拖动到此页面中,并稍加修改,得到如下图4所示布局。

      探讨微软asp.net ajax控件开发技术(客户端)

      图4.示例网站屏幕快照。

      (二)使用面向对象javascript设计控件类

      以鼠标右击工程添加一个javascript脚本文件imagebutton.js,内容如下列表2所示。

      列表2—脚本控件mycliimagebutton完整源码。  

    type.registernamespace('ajaximagebuttonnamespace');
    ajaximagebuttonnamespace.mycliimagebutton = function(element)
    {
    this._hoverimageurl = '';
    this._originalimageurl = '';
    this._mouseoverhandler = null;
    this._mouseouthandler = null;
    this._clickhandler = null;
    ajaximagebuttonnamespace.mycliimagebutton.initializebase(this, [element]);
    }
    ajaximagebuttonnamespace.mycliimagebutton.prototype =
    {
    get_hoverimageurl : function(){
    return this._hoverimageurl;
    },
    set_hoverimageurl : function(value) {
    var e = function._validateparams(arguments, [{name: 'value', type: string}]);
    if (e) throw e;
    if (this._hoverimageurl != value)
    {
    this._hoverimageurl = value;
    this.raisepropertychanged('hoverimageurl');
    }
    },
    initialize : function(){
    ajaximagebuttonnamespace.mycliimagebutton.callbasemethod(this, 'initialize');
    var target = this.get_element();
    this._originalimageurl = target.src;
    this._mouseoverhandler = function.createdelegate(this, this._onmouseover);
    this._mouseouthandler = function.createdelegate(this, this._onmouseout);
    this._clickhandler = function.createdelegate(this, this._onclick)
    $addhandlers(target, {'mouseover':this._mouseoverhandler, 'mouseout':this._mouseouthandler, 'click': this._clickhandler}, this);
    },
    dispose : function(){
    $clearhandlers(this.get_element());
    delete this._mouseoverhandler;
    delete this._mouseouthandler;
    delete this._clickhandler;
    ajaximagebuttonnamespace.mycliimagebutton.callbasemethod(this, 'dispose');
    },
    add_click : function(handler) {
    this.get_events().addhandler('click', handler);
    },
    remove_click : function(handler) {
    this.get_events().removehandler('click', handler);
    },
    _onmouseover : function(e) {
    e.target.src = this._hoverimageurl;
    },
    _onmouseout : function(e) {
    e.target.src = this._originalimageurl;
    },
    _onclick : function(e) {
    e.preventdefault();
    var handler = this.get_events().gethandler('click');
    if (handler != null) {
    handler(this, sys.eventargs.empty);
    }
    }
    }
    ajaximagebuttonnamespace.mycliimagebutton.registerclass('ajaximagebuttonnamespace.mycliimagebutton', sys.ui.control);
    if (typeof(sys) != 'undefined')
    sys.application.notifyscriptloaded();
    }

      如你所见,我们重载了initialize方法来“钩住”对应dom元素的mouseover,mouseout和click事件,以便我们可以在这些事件中设置合适的图像并激发click事件。我们还重载了dispose方法以分离我们在initialize方法中设置的事件处理器。后面,我们还要细致讨论。

    |||

      (三)使用控件

      有了上面的控件类,至于使用就很简单了。请切换到页面default.aspx的源码视图,然后在<head>区创建如下列表3所示内容。

      列表3 

    <script type="text/javascript">
    function pageload(){
    $create(ajaximagebuttonnamespace.mycliimagebutton, {'hoverimageurl':'images/updateh.gif'}, {'click':buttonclicked}, null, $get('clibtn'));
    }
    function buttonclicked(sender, e) {
    alert('i am clicked');
    return false;
    }
    </script>

      在此,我们使用asp.net ajax客户端全局方法$create创建控件ajaximagebuttonnamespace.mycliimagebutton的一个实例,指定其属性hoverimageurl取值、click事件的处理器函数,并把它与当前页面中的html <image>元素关联起来。当然,为了使得框架在运行时能够找到我们刚才建立的脚本文件,还要对scriptmanager的属性稍微设置一下,如下列表4所示。

      列表4—在scriptmanager控件内配置脚本文件。

      <asp:scriptmanager id="scriptmanager1" runat="server" >

      <scripts>

      <asp:scriptreference path="imagebutton.js" />

      </scripts>

      </asp:scriptmanager>

      现在,请按f5键运行此页面观察结果即可。下图5相应于当鼠标移动到图像按钮上时发生的变化(你还可以点击之自行观察效果)。

      探讨微软asp.net ajax控件开发技术(客户端)

    |||

    收集最实用的网页特效代码!

      图5.当鼠标移动到图像按钮上时图像切换成另一幅。

      下面,我们针对使用asp.net ajax框架提供的面向对象javascript进行客户端控件编程时有关概念作全面分析。

      四、 使用javascript进行客户端控件编程相关概念

      (七) 属性

      把属性添加到一个控件中是很简单的。在此,推荐使用的方法是在控件构造器中声明一个私有变量,并在prototype部分添加相应的getter及setter属性方法。当访问该属性时,asp.net ajax框架总是添加get_和set_前缀。因此,当添加getter/setter时,我们应该遵循get_propertyname和set_propertyname命名惯例。正如在上面的示例中相应于hoverimageurl属性所实现的,我们使用get_hoverimage()作为getter,set_hoverimage()作为setter。但是在上面的例子中当我们使用一个$create()语句创建该控件时,我们仅传递了hoverimageurl,因为asp.net ajax框架将会自动添加set_前缀。与属性有关的另外一个重要问题是,当它的属性改变时如何通知该控件的客户端。下列的代码片断展示了如何激发propertychanged事件。

    set_hoverimageurl : function(value){
    if (this._hoverimageurl != value)
    {
    //如果不同于当前值则仅设置新值
    this._hoverimageurl = value;
    //激发propertychanged事件
    //注意这是一个位于基类sys.component中的方法
    this.raisepropertychanged('hoverimageurl');
    }
    }

      (八) 方法

      使用javascript编写一个类的方法时,一般不作特殊考虑;但是,我们还是推荐在控件的原型(prototype)对象中添加它们。

      【注】就javascript本身编程而言,其表达形式多样,但建议你遵循这里推荐的格式(也正是框架相应js源码中所使用的格式)。

    ||| 国内最大的酷站演示中心!

      (九) 事件

      在控件类中添加事件类似添加属性。首先,在控件构造器中把事件处理器声明为一个私有变量并在原型对象中创建相应于该事件的一个add/delete方法对。尽管并不要求在模块级声明事件处理器变量,但是,这样做的确存在一些优点,我将在ajax框架的function.createdelegate()节讨论这个问题。当添加/删除事件时,ajax框架总是自动地添加上add_和remove_前缀。因此,当添加事件订阅代码时,该方法应该以add_eventname方式命名;反之,以remove_eventname方式命名。例如,在上面的click事件示例中,我们以add_click和remove_click形式添加事件订阅方法,但是在$create语句中,我们以click方式对它命名,由ajax框架负责添加add_前缀。如你在上面的示例所见,add_click和remove_click都引用了this.get_event()(继承自sys.component)。这个sys.component类维持着一个订阅事件的内部列表,存储于一个sys.eventhandlerlist类的实例(以及各自它们的处理器)中。

      除了这个get_event()方法对外,还推荐使用raiseeventname方法来激发事件。由于上面所举的仅是一个很基本的例子,所以,我没有在其中使用它。但是,当你想从多处激发同一个事件时你必须添加它。当激发一个事件时,我们可以传递一些称为事件参数的上下文数据。

      在事件中传递参数的推荐的方法是,创建一个继承自sys.eventargs的新类并构造器中传递要求的参数。针对每一个参数,它将在原型对象部分暴露getter和setter。因为本例非常简单,所以,没有使用这种更一般的方式。

      当前在该微软ajax库中相应于事件参数存在两个内置类—sys.eventargs和sys.canceleventargs。即使你有一个不需要任何事件参数的事件,那么,你也应该传递sys.eventargs.empty(例如在上面的imagebutton控件示例中),以便事件订阅者可以遵循相同的模式来处理所有的事件。

    ||| 国内最大的酷站演示中心!

      如果你细致研究框架源码,你会注意到,其中绝大部分的控件都遵循了相同的模式—使用函数handleevent(sender, e)来处理所有事件。注意,这与.net框架处理事件所实现的模式是相同的。而且,遵循这种方式给人的初始感觉过于复杂,但是却更遵循了一般性规律,便于以后的更复杂设计。

      五、 其它几个重要的全局客户端方法   下列,我们列出在开发客户端控件时,一些常用(有些是必用的)的重要方法。

      $get()

      这个方法是我们以前常用的document.getelementbyid方法的一个快捷方式。此方法使用一个可选的父级dom元素;如果没有指定这个父元素,那么,搜索操作将从document对象开始执行。

      $create()

      这个方法是sys.component.create方法的一个快捷方式,用于实例化一个客户端组件,行为或控件。这个方法的完整定义如下所示:

      $create(type, properties, events, references, element);

      举例:

      $create(ajaximagebuttonnamespace.mycliimagebutton, {'hoverimageurl':'images/updateh.gif'}, {'click':buttonclicked}, null, $get('clibtn'));

      在此,第一个参数使用了对象的完整类型名。例如,当创建一个mycliimagebutton控件时,我们需要传递ajaximagebuttonnamespace.mycliimagebutton。这个参数必须存在。

      第二个参数对应一个键/值对(每一个一个键/值对对应一个特定属性及其该属性的取值)数组。例如,当创建mycliimagebutton控件时,我们需要要传递hoverimageurl并给它赋值为{'hoverimageurl':' images/update-h.gif'}。如果我们想设置更多的属性,我们需要使用一个逗号来隔开这些键/值对。例如