Chinaunix首页 | 论坛 | 博客
  • 博客访问: 8582
  • 博文数量: 3
  • 博客积分: 130
  • 博客等级: 入伍新兵
  • 技术积分: 40
  • 用 户 组: 普通用户
  • 注册时间: 2008-04-11 08:06
文章分类
文章存档

2008年(3)

我的朋友
最近访客

分类: Java

2008-04-11 21:42:55

2.3  Prototype对Ajax的支持

作为一个Ajax开发框架,Prototype对 Ajax开发提供了有力的支持。在Prototype中,与Ajax相关的类和对象包括:Ajax、Ajax.Responsders、 Ajax.Base、Ajax.Request、Ajax. PeriodicalUpdater和Ajax.Updater,图2-3所示为这些类和对象之间的关系及其常用属性和方法,下面分别对这些类和对象进行 介绍。

图2-3  Prototype中Ajax相关类和对象关系示意图

2.3.1  Ajax对象

Ajax对象为其他的Ajax功能类提供了最基本的 支持,它的实现如2.2.7节中例2-10所示,其中包括一个方法getTransport和一个属性activeRequestCount。 getTransport方法返回一个XMLHttpRequest对象,activeRequestCount属性代表正在处理中的Ajax请求的个 数。

2.3.2  Ajax.Base类

Ajax.Base类是Ajax.Request类和Ajax.PeriodicalUpdater类的基类。它提供了3个方法:

l  setOptions:设置Ajax操作所使用的选项。

l  responseIsSuccess:判断Ajax操作是否成功。

l  responseIsFailure:判断Ajax操作是否失败(与responseIsSuccess相反)。

Ajax.Base类的主要作用是提取出一些公用的方法,其他类通过继承的方式使用这些方法,实现代码复用。

2.3.3  Ajax.Request类

这是Prototype中最经常使用的一个Ajax 相关类。Ajax.Request类的方法通常是内部使用的,因此这里就不一一列举,有兴趣的读者可以参考Prototype的源代码。这里重点讲讲如何 使用Ajax.Request类,首先给出一个最简单的Ajax.Request类的应用示例,如例2-11所示,注意示例中的黑体字。

例2-11  Ajax.Request类应用示例

Ajax.Request测试页面:

 "">

   

        chapter 3

       

       

   

   

   

   

   

data.html

Ajax.Request对象在初始化时需要提供两 个参数:第1个参数是将要请求页面的URL,这里使用的data.html是一个普通的HTML静态页面;第2个参数是Ajax操作的选项,在 Prototype中并没有专门为Ajax操作选项定义一个类,通常都是像例2-11这样,通过匿名对象的方式设置Ajax操作的参数。在例2-11中, Ajax操作选项具有两个属性:method表示HTTP请求方式,默认是POST方式;onComplete指定了Ajax操作完成以后(即 XMLHttpRequest对象的status属性为4时),页面将要执行的函数。当然,Ajax操作还包括很多其他选项,如表2-1所示。

表2-1  Ajax操作选项属性含义

属性名称

含义

method

HTTP请求方式(POST/GET/HEAD)。

parameters

在HTTP请求中传入的URL格式的值列表,即URL串中问号之后的部分。

asynchronous

是否做异步XMLHttpRequest请求。

postBody

在POST请求方式下,传入请求体中的内容。

requestHeaders

和请求一起被传入的HTTP头部列表,这个列表必须含有偶数个项目,因为列表中每两项为一组,分别代表自定义部分的名称和与之对应的字符串值。

onXXXXXXXX

在HTTP 请求、响应的过程中,当XMLHttpRequest对象状态发生变化时调用的响应函数。响应函数有5个:onUninitialized、 onLoading、onLoaded、onInteractive和onComplete。传入这些函数的参数可以有2个,其中第1个参数是执行 HTTP请求的XMLHttpRequest对象,第2个参数是包含被执行的X-JSON响应的HTTP头。

onSuccess

Ajax操作成功完成时调用的响应函数,传入的参数与onXXXXXXXX相同。

onFailure

Ajax操作请求完成但出现错误时调用的响应函数,传入的参数与onXXXXXXXX相同。

onException

Ajax操作发生异常情况时调用的响应函数,它可以接收2个参数,其中第1个参数是执行HTTP请求的XMLHttpRequest对象,第2个参数是异常对象。

2.3.4  Ajax.Updater类

例2-11使用Ajax.Request类实现了页 面的局部刷新效果,而这样类似的功能在Ajax应用中是经常使用的。因此,为了简化这种工作,Prototype框架从Ajax.Requet类中派生出 一个子类——Ajax.Updater。与Ajax.Request相比,Ajax.Updater的初始化多了一个container参数,该参数代表 将要更新的页面元素的id。例2-11的功能通过Ajax.Updater的实现,会变得更加简单,如例2-12所示。

例2-12  Ajax.Updater类的应用示例

 "">

   

        chapter 3

       

       

   

   

   

   

   

此外,Ajax.Updater类还有另外一个功 能,如果请求的页面内容中包括JavaScript脚本,Ajax.Updater类可以执行其中的脚本,只需要在Ajax操作选项中增加属性 “evalScripts: true”即可。对例2-11中的data.html进行修改,在其中加入JavaScript脚本,如例2-13所示。

例2-13  data.html

调用Ajax.Updater的JavaScript脚本修改为:

function test() {

    var myAjax = new Ajax.Updater(

        'divResult', // 更新的页面元素

        'data.html', // 请求的URL

        {

            method: 'get',

            evalScripts: true

        }

    );

}

这样就可以使用data.html页面的内容更新当前页面中的

元素divResult,并且执行data.html页面中包含的JavaScript脚本。

这里需要注意的是例2-13中sayHi函数的写法,如果写成

function sayHi() {

    alert("Hello, " + $F('name') + "!");

}

或者

var sayHi = function() {

    alert("Hello, " + $F('name') + "!");

}

程序是不能正常运行的。这是因为 Ajax.Updater执行脚本是通过eval的方式,而不是将脚本内容引入到当前页面,直接声明的function sayHi或者用var声明的sayHi函数,其作用域只是在这段脚本内部,外部的其他脚本不能访问sayHi函数。而按照例2-13的方式声明的函数, 其作用域是整个window。

2.3.5  Ajax.PeriodicalUpdater类

和Ajax.Request类相似, Ajax.PeriodicalUpdater类也继承自Ajax.Base类。在一些Ajax应用中,需要周期性地更新某些页面元素,例如天气预报、即 时新闻等等。实现这样的功能通常要使用JavaScript中的定时器函数setTimeout、clearTimeout等,而有了 Ajax.PeriodicalUpdater类可以很好地简化这类编码工作。

新建一个Ajax. PeriodicalUpdater类的实例需要指定3个参数:

l  container:将要更新的页面元素id;

l  url:请求的URL地址;

l  options:Ajax操作选项。

和Ajax.Updater类相似,Ajax.PeriodicalUpdater类也支持动态执行JavaScript脚本,只需在Ajax操作选项中增加(evalScripts: true)属性值即可。

Ajax.PeriodicalUpdater类支 持两个特殊的Ajax操作选项:frequency和decay。frequency参数很容易理解,既然是定时更新页面元素,或者定时执行脚本,那么多 长时间更新或者执行一次呢?frequency指的就是两次Ajax操作之间的时间间隔,单位是秒,默认值为2秒。

如果仅指定frequency参数,程序会按照固定 的时间间隔执行Ajax操作。这样的更新策略合理吗?答案取决于请求URL中数据的更新频率。如果请求的数据会很有规律地按照固定频率改变,那么只要设置 一个合适的frequency值,就可以很有效地实现页面的定时更新。然而实际应用中的数据往往不会那么理想,例如新闻,可能在一天中只有特定的一段时间 更新频率会很高,而在其他时间则几乎没有变化。经常遇到这样的情况该怎么办呢?Ajax.PeriodicalUpdater类支持的decay属性就是 为了解决这个问题而产生的。当option中带有decay属性时,如果请求返回的数据与上次相同,那么下次进行Ajax操作的时间间隔会乘以一个 decay的系数。

为了比较明显地看到decay属性的效果,在请求的测试页面中加入记录时间的脚本,代码如例2-14所示。

例2-14  Ajax.PeriodicalUpdater类应用示例

ex10.html

 "">

   

        chapter 3

       

       

   

   

   

   

   

   

script1.html:

例2-14的运行结果如图2-4所示。

图2-4  Ajax.PeriodicalUpdater类应用示例

可以看到,由于请求返回的数据一直没有发生变化,每次请求时间的间隔是上一次的2倍(decay=2)。如果某一次请求返回的数据发生了变化,那么执行请求的时间间隔则恢复到初始值。

2.3.6  Ajax.Responders对象

Ajax.Responders对象维护了一个正在 运行的Ajax对象列表,在需要实现一些全局的功能时就可以使用它。例如,在Ajax请求发出以后需要提示用户操作正在执行中,而操作返回以后则取消提 示。利用Ajax.Responders对象就可以实现这样的功能,如例2-15所示。

例2-15  Ajax.Responders对象应用示例

 "">

   

        chapter 3

       

       

   

   

   

   

   

   

例2-15中定义了一个handle对象,其中包含onCreate和onComplete函数。页面中发出任何一个Ajax请求时都会调用onCreate方法,而请求完成时都会调用onComplete方法。例2-15的运行结果如图2-5所示。

图2-5  Ajax.Responders对象应用示例





通过这个JS类库,将很容易的应用AJAX技术
ajax.updater应用
new Ajax.Updater('id',"url",{options});
id:你要更新的目标id
url:你要执行的操作,也可以是cgi
options:
属性 类型 默认 描述
method Array 'post' HTTP 请求方式。
parameters String '' 在HTTP请求中传入的url格式的值列表。
asynchronous Boolean true 指定是否做异步 AJAX 请求。
postBody String undefined 在HTTP POST的情况下,传入请求体中的内容。
requestHeaders Array undefined 和请求一起被传入的HTTP头部列表, 这个列表必须含有偶数个项目, 任何奇数项目是自定义的头部的名称,接下来的偶数项目使这个头部项目的字符串值。 例子:['my-header1', 'this is the value', 'my-other-header', 'another value']
onXXXXXXXX Function(XMLHttpRequest) undefined 在AJAX请求中,当相应的事件/状态形成的时候调用的自定义方法。 例如 var myOpts = {onComplete: showResponse, onLoaded: registerLoaded};. 这个方法将被传入一个参数, 这个参数是携带AJAX操作的 XMLHttpRequest对象。
onSuccess Function(XMLHttpRequest) undefined 当AJAX请求成功完成的时候调用的自定义方法。 这个方法将被传入一个参数, 这个参数是携带AJAX操作的 XMLHttpRequest对象。 字串6


onFailure Function(XMLHttpRequest) undefined 当AJAX请求完成但出现错误的时候调用的自定义方法。 这个方法将被传入一个参数, 这个参数是携带AJAX操作的 XMLHttpRequest对象。
insertion Function(Object, String) null 为了把返回的文本注入到一个元素中而执行的方法。 这个方法将被传入两个参数,要被更新的对象并且只应用于 Ajax.Updater的响应文本 。
evalScripts Boolean undefined, false 决定当响应到达的时候是否执行其中的脚本块,只在 Ajax.Updater 对象中应用。 即要用到目标对象的JS代码必须设定true。
decay Number undefined,1 决定当最后一次响应和前一次响应相同时在 Ajax.PeriodicalUpdater 对象中的减漫访问的次数,例如,如果设为2,后来的刷新和之前的结果一样, 这个对象将等待2个设定的时间间隔进行下一次刷新, 如果又一次一样, 那么将等待4次,等等。不设定这个只,或者设置为1,将避免访问频率变慢。
(参考https://compdoc2cn.dev.java.net/prototype/html/prototype.js.cn.html#options_reference)

简单例子:
一:
index.html: 

 

ajax.html 

using ajax!

说明:为了使ajax.html中test()方法运行,首先必须设定evalScripts:true,其次在test函数的命名方式修改为“函数名字=function()”的方式。另外也可以将js之前放至index.html也能运行,不需要修改函数。

二:
表单的提交可以无刷新的方式


以上这段代码是我在wiki.script.aculo.us上看到的,有兴趣可以去看看原文。

具体应用可以根据需要修改,总之AJAX应用还是满好玩的。异步更新虽然好,但是网速慢的情况下,多次点击总感觉有问题。


2.2  常用函数

2.2.1  $()函数

DOM提供了 document.getElementById方法,可以根据传入的页面元素的id返回相应的元素对象。$()函数是 document.getElementById函数的一个简化写法,它比DOM中的方法功能更加强大,比如$()函数可以接受多个参数,返回满足条件的 Array对象。在Prototype中$()函数的实现代码如例2-1所示。

例2-1  $()函数

function $() {

  var results = [], element;

  for (var i = 0; i < arguments.length; i++) { // 可以传入多个参数

    element = arguments[i];

    

     // 如果参数的类型是字符串

    if (typeof element == 'string')

      element = document.getElementById(element);

   

    results.push(Element.extend(element)); // 将得到的对象加入results数组

  }

  // 如果只返回一个对象,直接返回该对象,如果返回了多个对象,则返回包含所有这些对象的数组

  return results.length < 2 ? results[0] : results;

}

从例2-1中可以看到,当$()只有1个输入参数 时,它和document.getElementById是等效的,而当$()拥有多个输入参数时,其返回值是一个Array对象,这个数组包含了所有符 合条件的对象。例2-2中分别用1个和多个参数调用了$()方法,注意示例中的黑体字。

例2-2  $()函数应用示例

 "">

   

        chapter 3

       

       

   

   

   

        div1

   

   

        div2

   

   

   

   

2.2.2  $A()函数

$A()函数可以将一个可枚举的对象转换为一个Array对象,它和Array.from()是等效的。例2-3是Prototype中$A()函数的实现代码。

例2-3  $A()函数

var $A = Array.from = function(iterable) {

  if (!iterable) return [];// 如果iterable对象不存在,返回空数组

  if (iterable.toArray) { // 如果iterable有toArray方法,返回iterable.toArray()

    return iterable.toArray();

  } else {

    var results = [];

    for (var i = 0; i < iterable.length; i++)

      results.push(iterable[i]);

    return results;//返回对象数组

  }

}

可以看到,$A()函数是通过两种方式返回 Array对象的。第一种方式是如果传入的对象已经实现了toArray方法,那么则直接调用其toArray方法;第二种方式是通过循环的方式返回对象 的数组。使用第二种方式的前提是传入的对象具有length属性,并且可以通过序号索引其内部的所有对象。例2-4是$A()函数的应用示例,注意示例中 的黑体字。

例2-4  $A()函数应用示例

 "">

    chapter 3

   

   

   

       

       

   

图2-1  $A函数应用示例

例2-4是通过点击“Show the options”按钮触发onclick事件的响应函数showOptions,函数showOptions使用$A方法将lstFramework 的option对象集合转换为数组输出,相应的输出结果如图2-1所示。

2.2.3  $F()函数

$F()是另一个经常使用的快捷方式,它是 Form.Element.getValue()函数的缩写。$F()函数用来求得页面中输入控件的输入值,它的输入参数可以是目标控件的id值,也可以 是目标控件对象本身。$F支持的输入控件包括系列(即type=submit / hidden / password / text / checkbox / radio)、下拉列表'; tpl += '

'; tpl += '
'; tpl += '
'; tpl += ''; tpl += '
'; tpl += '
'; tpl += '
'; $('.z_move_comment').html(''); $(this).parents('.Blog_right1_8').find('.z_move_comment').html(tpl).show(); }); //引用的评论提交 $('#quota_sbumit').live('click' , function(){ if(isOnLine == '' ) { //showErrorMsg('登录之后才能进行此操作' , '消息提示'); showErrorMsg('操作失败,您需要先登录!', '消息提示', 'http://account.chinaunix.net/login'); return false; } var bid = $(this).attr('bid'); var tid = $(this).attr('tid');//被引用人的id var qid = $(this).attr('cid');//引用的id var url = $(this).attr('url'); var text = $('#rmsg').val(); var tname = $(this).attr('tname'); if(text == '' || text=='文明上网,理性发言...') { showErrorMsg('评论内容不能为空!' , '消息提示'); return false; } else { if(mb_strlen(text) > 1000){ showErrorMsg('评论内容不能超过500个汉字' , '消息提示'); return false; } } $.ajax({ type: "post", url: url , data: {'bid': bid , 'to' : tid , 'qid' : qid , 'text': text , 'tname' : tname }, dataType: 'json', success: function(data){ if(data.code == 1){ var tpl = '
'; tpl+= ''; tpl+= '
'; tpl+= '

' + data.info.username + '' + data.info.dateline + '

'; tpl+= '

' + data.info.quota.username + ':'+ data.info.quota.content + '

'; tpl+= '

' + data.info.content + '

回复 |  删除 |  举报
'; tpl+= ''; tpl+= '
'; $('#replyList .Blog_right1_8:first').before(tpl); $('.z_move_comment').html('').hide(); } else if(data.code == -1){ //showErrorMsg(data.info , '消息提示'); showErrorMsg('操作失败,您需要先登录!', '消息提示', 'http://account.chinaunix.net/login'); } }, error: function(){//请求出错处理 } }); }); //底部发表评论 $('#submitmsg').click(function(){ if(allowComment == 1) { showErrorMsg('该博文不允许评论' , '消息提示'); return false; } var bid = $(this).attr('bid'); var toid = $(this).attr('toid'); var text = $('#reply').val(); var url = $(this).attr('url'); if(text == '' || text=='文明上网,理性发言...') { showErrorMsg('评论内容不能为空!' , '消息提示'); return false; } else { if(mb_strlen(text) > 1000){ showErrorMsg('评论内容不能超过500个汉字' , '消息提示'); return false; } } $.ajax({ type: "post", url: url , data: {'bid': bid , 'to' : toid ,'text': text}, dataType: 'json', success: function(data){ if(data.code == 1) { var tpl = '
'; tpl += ''; tpl += '
'; tpl += '

' + data.info.username + '' + data.info.dateline + '

'; tpl += '

' + data.info.content + '

'; tpl += '
回复 |  删除 |  举报
'; tpl += ''; tpl += '
'; $('.Blog_tit3:first').after(tpl); $('#reply').val('文明上网,理性发言...'); } else if(data.code == -1) { showErrorMsg(data.info , '消息提示'); } }, error: function(){//请求出错处理 } }); }); //底部评论重置 $('#reset_comment').click(function(){ $('#reply').val('文明上网,理性发言...'); }); //取消回复 $('#qx_comment').live('click' , function(){ $('.z_move_comment').html('').hide(); }); $('#rmsg, #reply').live({ focus:function(){ if($(this).val() == '文明上网,理性发言...'){ $(this).val(''); } }, blur:function(){ if($(this).val() == ''){ $(this).val('文明上网,理性发言...'); } } }); //删除留言确认 $('.comment_del_mark').live('click' , function(){ var url = $(this).attr('url'); asyncbox.confirm('删除留言','确认', function(action){ if(action == 'ok') { location.href = url; } }); }); //删除时间确认 $('.del_article_id').click(function(){ var delurl = $(this).attr('delurl'); asyncbox.confirm('删除文章','确认', function(action){ if(action == 'ok') { location.href = delurl; } }); }); /* //字数限制 $('#rmsg, #reply').live('keyup', function(){ var id = $(this).attr('id'); var left = Util.calWbText($(this).val(), 500); var eid = '#errmsg'; if(id == 'reply') eid = '#rerrmsg'; if (left >= 0) $(eid).html('您还可以输入' + left + '字'); else $(eid).html('您已超出' + Math.abs(left) + ''); }); */ //加载表情 $('#face').qqFace({id : 'facebox1', assign : 'reply', path : '/image/qqface/'}); $('#mface').qqFace({id : 'facebox', assign : 'rmsg', path:'/image/qqface/'}); /* $('#class_one_id').change(function(){ alert(123213); var id = parseInt($(this).val() , 10); if(id == 0) return false; $('.hidden_son_class span').each(function( index , dom ){ if( dom.attr('cid') == id ) { } }); }); */ //转载文章 var turn_url = "/blog/viewClassPart.html"; $('#repost_bar').click(function(){ if(isOnLine == '' ) { //showErrorMsg('登录之后才能进行此操作' , '消息提示'); showErrorMsg('操作失败,您需要先登录!', '消息提示', 'http://account.chinaunix.net/login'); return false; } var id = $(this).attr('bid'); asyncbox.open({ id : 'turn_class_thickbox', url : turn_url, title : '转载文章', width : 330, height : 131, scroll : 'no', data : { 'id' : id }, callback : function(action){ if(action == 'close'){ $.cover(false); } } }); }); /* //转发文章 $('#repost_bar').live('click' , function(){ if(isOnLine == '' ) { //showErrorMsg('登录之后才能进行此操作' , '消息提示'); showErrorMsg('操作失败,您需要先登录!', '消息提示', 'http://account.chinaunix.net/login'); return false; } var bid = $(this).attr('bid'); var url = $(this).attr('url'); asyncbox.confirm('转载文章','确认', function(action){ if(action == 'ok'){ $.ajax({ type:"POST", url:url, data: { 'bid' : bid }, dataType: 'json', success:function(msg){ if(msg.error == 0){ showSucceedMsg('转发成功!', '消息提示'); }else if(msg.error == 1){ //location.href = '/index.php?r=site/login'; showErrorMsg('操作失败,您需要先登录!', '消息提示', 'http://account.chinaunix.net/login'); }else{ showErrorMsg(msg.error_content, '消息提示'); } } }); } }); }); */ });