AjaxAnyWhere中文帮助文档

1、AjaxAnywhere简介1、AjaxAnywhere使用“分区刷新”的思路，其工作原理如下。

（1）使用AjaxAnywhere自定义标签库将一个Web页面划分为几个可重载的区域（reload-capable zones）。

（2）使用AjaxAnywhere Javascript应用编程接口（API）替代传统通信机制下表单提交方式。

（3）当请求在服务器端处理的时候，决定那些页面区域可以刷新（refresh）。

这个过程可以使用基于客户端的Javascript或者基于服务器端的AjaxAnywhere应用编程接口（API）。

（4）在服务器端，AjaxAnywhere会生成包含即将更新的HTML代码的XML文档。

（5）在客户端，AjaxAnywhere Javascript接受这个XML文档，解析文档，并更新指定的页面区域。

2、如果要将AjaxAnywhere集成到自己的Web应用程序中，可以通过以下5个步骤来完成简单的配置。

第一步：下载最新的AjaxAnywhere开发包或者二进制分发版本。

从AjaxAnywhere官方网站下载最新的开发包，包括jar包--ajaxanywhere-1.1.0.6.jar、js--aa.js文件等。

第二步：获取必要的Javascript文件。

从下载的开发包中获取Javascript文件aa.js，放到Web应用程序根目录中。

第三步：将下载下来的jar包复制到/WEB-INF/lib目录中。

第四步：修改web.xml，添加AAFilter过滤器。

修改部署描述文件web.xml，在该文件中添加AAFilter过滤器。

映射部分的部署代码如例程11-22所示。

例程11-22web.xml添加AAFilter过滤器<filter><filter-name>AjaxAnywhere</filter-name><filter-class>org.ajaxanywhere.AAFilter</filter-class></filter><filter-mapping><filter-name>AjaxAnywhere</filter-name><url-pattern>*.jsp</url-pattern></filter-mapping><filter-mapping><filter-name>AjaxAnywhere</filter-name><url-pattern>*.do</url-pattern><!--default Struts mapping--></filter-mapping><filter-mapping><filter-name>AjaxAnywhere</filter-name><url-pattern>*.htm</url-pattern><!--other framewords mapping--></filter-mapping>例程11-22将Web应用程序中的URL以后缀.jsp，do，htm结尾的请求全部有过滤器AAFilter过滤。

而在实际项目中，可以根据项目实际需求来修改url-pattern的值，定制要应用AjaxAnywhere的请求类型，即只有特定的请求才应用AjaxAnywhere处理。

AjaxAnywhere的类库及其用法AjaxAnywhere使用一个名为aa.js的Javascript文件来处理客户端的全部Ajax操作，包括初始化XMLHttpRequest、获取表单内容、发送Ajax请求、执行回调函数等。

aa.js也是使用AjaxAnywhere之前必须了解的，至少应该知道其经常用到的API。

Ajax Anywhere的官方网站提供了相应的Javascript Document，方便快速查找和了解这些API。

1．AjaxAnywhere的初始化aa.js中定义了一个AjaxAnywhere对象，针对Ajax的各种操作被抽象成AjaxAnywhere对象的方法，通过这些对象方法完成所需的操作。

必要的时候，可以重载这些方法，以便满足个性化的需求。

在aa.js文件的末端，AjaxAnywhere对象使用默认的构造方法完成对象实例化。

ajaxAnywhere=new AjaxAnywhere();ajaxAnywhere.bindById();所以，所有引用aa.js的页面都可以在Javascript代码段中使用AjaxAnywhere对象的实例ajaxAnywhere。

当AjaxAnywhere初始化的时候，它在默认的构造函数中完成XMLHttpRequest对象的创建，并保存在AjaxAnywhere对象属性req中。

AjaxAnywhere对象默认的构造方法如例程11-23所示。

例程11-23AjaxAnywhere对象的默认构造方法function AjaxAnywhere(){this.id=AjaxAnywhere.defaultInstanceName;//id,用于生成更新区域的编号等用途this.formName=null;//页面表单名称this.notSupported=false;//是否支持Ajaxthis.delayBeforeContentUpdate=true;//在更新页面内容之前是否延迟this.delayInMillis=100;//延迟时间//初始化XMLHttpRequest对象--reqif(window.XMLHttpRequest){this.req=new XMLHttpRequest();}else if(window.ActiveXObject){try{this.req=new ActiveXObject("Msxml2.XMLHTTP");}catch(e){try{this.req=new ActiveXObject("Microsoft.XMLHTTP");}catch(e1){this.notSupported=true;/*XMLHTTPRequest not supported*/}}}//确定浏览器是否支持Ajaxif(this.req==null||typeof this.req=="undefined")this.notSupported=true;}2．AjaxAnywhere处理Ajax请求AjaxAnywhere提供两个公共方法处理Ajax请求的发送：submitAJAX(additionalPost Data,submitButton)和getAJAX(url,zonesToRefresh)。

前者用于发送POST类型的Ajax请求，后者则用于发送GET类型的请求，可以直接在Web页面的表单中或者Javascript代码段直接使用ajaxAnywhere.submitAJAX(additionalPostData, submitButton)或者ajaxAny where.getAJAX(url,zonesToRefresh)向服务器发送Ajax请求。

ajaxAnywhere对象的属性formName保存Ajax所指向的表单名称，只要为其指定表单名称（如果未指定，则默认是Web页面中的第一个表单），submitAJAX(additionalPost Data,submitButton)就能够自动获取指定表单的全部表单域及其值，组成parameterName1=value1&parameterName2=value2字符串，这个过程由私有（private）方法preparePostData(submitButton)完成；preparePostData(submitButton)方法遍历表单中的全部元素，将下拉列表、文本框、复选框、单选框等的值自动加入字符串中；submitAJAX方法的参数additionalPostData代表除了表单域值外还要发送给服务器的内容，submitButton则是代表发送操作是否由提交按钮触发的。

SubmitAJAX()方法的代码如例程11-24所示。

例程11-24submitAJAX()方法发送POST类型请求AjaxAnywhere.prototype.submitAJAX=function(additionalPostData,submitButton){//如果浏览器不支持Ajaxif(this.notSupported)return this.onSubmitAjaxNotSupported(additionalPostData);//附加参数为空if(additionalPostData==null||typeof additionalPostData=="undefined")additionalPostData="";//id绑定this.bindById();//获取当前表单对象var form=this.findForm();//获取表单的action，确定表单提交目标的urlvar actionAttrNode=form.attributes.getNamedItem("action");var url=actionAttrNode==null?null:actionAttrNode.nodeV alue;//如果表单action未设置，则url为当前页面if((url==null)||(url==""))url=location.href;//确定请求成功后要重载刷新的页面区域var zones=this.getZonesToReload(url,submitButton);//如果未设置重载刷新区域，则刷新整个页面if(zones==null){if(typeof form.submit_old=="undefined")form.submit();elseform.submit_old();return;}//放弃上一次未完成的请求this.dropPreviousRequest();//设置请求参数，发送类型为POST，请求为异步方式this.req.open("POST",url,true);this.req.setRequestHeader("Content-Type","application/x-www-form-urlencoded");this.req.setRequestHeader("Accept","text/xml");//确定要发送给服务器的内容var postData=this.preparePostData(submitButton);//已设置要重载刷新的区域，将区域名称附加在发送内容中if(zones!="")postData='&aazones='+encodeURIComponent(zones)+"&"+postData+"&"+additionalPostData;elsepostData+="&"+additionalPostData;//发送Ajax请求this.sendPreparedRequest(postData);}显然，如果使用AjaxAnywhere自定义标签为Web页面划分指定了刷新区域，则submitAJAX()方法也会将其包含在参数中发送到服务器端。