ajax技术:构建动态的java应用程序
页面重载提出了一个在web应用开发中最大的可用性障碍,对于java开发来说也是一个重大的挑战。在本系列中,作者philip mccarthy介绍了通过后台通道的方法来创建动态web应用的经验。ajax(asynchronous javascript and xml)是一个结合了java技术、xml、以及javascript的编程技术,可以让你构建基于java技术的web应用,并打破了使用页面重载的惯例。
ajax,异步javascript与xml,是使用客户端脚本与web服务器交换数据的web应用开发方法。这样,web页面不用打断交互流程进行重新加裁,就可以动态地更新。使用ajax,你可以创建接近本地桌面应用的,直接的、高可用的、更丰富的、更动态的web用户接口界面。
ajax不是一个技术,它更像是一个模式—标志并描述有用的设计技巧的一种方法。对于刚了解它的许多开发人员来说,它是一种新的感觉,但是实现ajax的所有组件都已存在了许多年。当前的热闹是因为在2004与2005年出现了一些基于ajax的非常动态的webui,尤其是google的gmail与maps应用系统、与照片共享网站flickr。这些ui充分地使用了后台通道,也被一些开发者称为“web 2.0”,并导致了大家对ajax应用兴趣的猛涨。
在本系列中,我将给出所有你需要的开发你自己的ajax应用的工具。在文章中,我将解释在ajax背后的概念,示范为基于web的应用系统创建一个ajax接口的基本步骤。我将使用示例代码来示范实现ajax动态接口的服务器端java代码与客户端javascript脚本。最后,我将指出一些ajax方法中易犯的错误,以及在创建ajax应用时应该考虑的广泛范围内的可用性与易访问性方面的问题。
一个更好的购物车
你可以使用ajax来加强传统的web应用,通过消除页面载入来使交互更流畅。为了示范它,我将使用一个简单的,能动态更新加入的物品购物车。结合一个在线商店,这个方法可以不用等待点击后的页面重载,而让我们继续浏览并挑选物品到购物车中。虽然,本文中的代码针对购物车例子,但其中展示的技术可以用到其它的ajax应用中。列表1中展示了购物车示例所使用的html代码。在整篇文章中,我都将会引用到这些html代码。
列表1:购物车示例的相关代码片断
table of products from store's catalog, one row per item -->
th>nameth> th>descriptionth> th>priceth> th>th>
tr>
item details -->
td>hattd> td>stylish bowler hattd> td>$19.99td>
td>
click button to add item to cart via ajax request -->
button οnclick="addtocart('hat001')">add to cartbutton>
td>
tr>
representation of shopping cart, updated asynchronously -->
ul id="cart-contents">
list-items will be added here for each item in the cart -->
ul>
total cost of items in cart displayed inside span element -->
total cost: span id="total">$0.00span>
ajax处理过程
一个ajax交互从一个称为xmlhttprequest的javascript对象开始。如同名字所暗示的,它允许一个客户端脚本来执行http请求,并且将会解析一个xml格式的服务器响应。ajax处理过程中的第一步是创建一个xmlhttprequest实例。使用http方法(get或post)来处理请求,并将目标url设置到xmlhttprequest对象上。
现在,记住ajax如何首先处于异步处理状态?当你发送http请求,你不希望浏览器挂起并等待服务器的响应,取而代之的是,你希望通过页面继续响应用户的界面交互,并在服务器响应真正到达后处理它们。要完成它,你可以向xmlhttprequest注册一个回调函数,并异步地派发xmlhttprequest请求。控制权马上就被返回到浏览器,当服务器响应到达时,回调函数将会被调用。
在java web服务器上,到达的请求与任何其它httpservletrequest一样。在解析请求参数后,servlet执行必需的应用逻辑,将响应序列化到xml中,并将它写回httpservletresponse。
回到客户端,注册在xmlhttprequest上的回调函数现在会被调用来处理由服务器返回的xml文档。最后,通过更新用户界面来响应服务器传输过来数据,使用javascript来操纵页面的html dom。
现在,你应该对ajax处理过程有了一个高层视图。我将进入其中的每一步看看更细节的内容。如果你找不到自己的位置时,就回头再看看图1,加—因为ajax方法的异步本质,所以时序图并不是笔直向前的。
发送一个xmlhttprequest
我将从ajax时序图的起点开始:从浏览器创建并发送一个xmlhttprequest。不幸的是,在不同的浏览器中创建xmlhttprequest的方法都不一样。列表2中示例的javascript函数消除了这些与浏览器种类相关的问题,正确检测与当前浏览器相关的方法,并返回一个可以使用的xmlhttprequest。最好将它看成备用代码,将它简单拷贝到你的javascript库中,在需要一个xmlhttprequest时使用它即可。
列表2:跨浏览器创建一个xmlhttprequest
/**//*
* 返回一个新建的xmlhttprequest对象,若浏览器不支持则失败
*/
function newxmlhttprequest() {
var xmlreq = false;
if (window.xmlhttprequest) {
// 在非microsoft浏览器中创建xmlhttprequest对象
xmlreq = new xmlhttprequest();
} else if (window.activexobject) {
//通过ms activex创建xmlhttprequest
try {
// 尝试按新版internetexplorer方法创建
xmlreq = new activexobject("msxml2.xmlhttp");
} catch (e1) {
// 创建请求的activex对象失败
try {
// 尝试按老版internetexplorer方法创建
xmlreq = new activexobject("microsoft.xmlhttp");
} catch (e2) {
// 不能通过activex创建xmlhttprequest
}
}
}
return xmlreq;
}
稍后,我将讨论如何对待不支持xmlhttpreauest的浏览器的一些技巧。现在,列表2中展示的示例函数将总是可以返回一个xmlhttpreauest实例。
回到购物车例子的场景中,只要用户针对某一个目录条目点击了add to cart按钮,我就要调用一个ajax交互。名为addtocart()的onclick函数通过ajax调用(如列表1中所示)来负责更新购物车的状态。在列表3中,addtocart()要做的第一件事就是通过调用newxmlhttpreauest函数(如列表2中所示)来获取一个xmlhttprequest的实例,并且注册一个回调函数来接受服务器响应(我将在稍后详细解释,请参见列表6)。
因为,此请求将会修改服务器状态,我将使用一个http post来处理它。通过post传送数据需要三个步骤:首先,我需要打开一个到进行通讯的服务器资源的post连接—在现在例子中是一个url映射为cart.do的服务器端servlet。下一步,设置xmlhttprequest的头信息,以标志请求的内容为form-encoded。最后,将form-encoded数据作为请求体,并发送此请求。
列表3中集中展示了这些步骤。
列表3:发送一个添加到购物车xmlhttprequest
/结合以上内容,你可以了解到ajax处理过程的第一部分—就是在客户端创建并发送http请求。下一步是用来处理请求的java servlet代码。
servlet请求处理
*
* 通过产品编码,在购物车中添加一个条目
* itemcode – 需要添加条目的产品编码
*/
function addtocart(itemcode) {
// 获取一个xmlhttprequest实例
var req = newxmlhttprequest();
// 设置用来从请求对象接收回调通知的句柄函数
var handlerfunction = getreadystatehandler(req, updatecart);
req.onreadystatechange = handlerfunction;
// 打开一个联接到购物车servlet的http post联接
// 第三个参数表示请求是异步的
req.open("post", "cart.do", true);
// 指示请求体包含form数据
req.setrequestheader("content-type",
"application/x-www-form-urlencoded");
// 发送标志需要添加到购物车中条目的form-encoded数据
req.send("action=add&item="+itemcode);
}
通过一个servlet来处理xmlhttprequest与处理一个来自浏览器的普通的http请求基本上相似。可以通过调用httpservletrequest.getparameter()来获取由post请求体传送过来的form-encoded数据。ajax请求也与普通的web请求样都成为此应用同一httpsession会话进程的一部分。这对于购物车例子来说很有肜,因为我们可以通过会话将多个请求的状态都保存到同一个javabean购物车对象中,并可以序列化。
列表4是处理ajax请求并更新购物车的简单servlet的代码片断。从用户会话中检索出一个cart bean,并按请求的参数更新它。之后cart bean被序列化到xml,并被写回servletrespone。注意,一定要将响应内容的类型设置为application/xml,否则,xmlhttprequest将不能将响应内容解析为一个xml dom。
列表4:处理ajax请求的servlet代码
public void dopost(httpservletrequest req, httpservletresponse res)
throws java.io.ioexception {
cart cart = getcartfromsession(req);
string action = req.getparameter("action");
string item = req.getparameter("item");
if ((action != null)&&(item != null)) {
// 在购物车中添加或移除一个条目
if ("add".equals(action)) {
cart.additem(item);
} else if ("remove".equals(action)) {
cart.removeitems(item);
}
}
// 将购物车状态序列化到xml
string cartxml = cart.toxml();
// 将xml写入response.
res.setcontenttype("application/xml");
res.getwriter().write(cartxml);
}
列表5展示了由cart.toxml()方法生成的xml。注意到生成的cart元素的属性,是一个通过system.currenttimemillis()生成的时间戳。
列表5:cart对象序列化得到的xml
xml version="1.0"?>
cart generated="1123969988414" total="$171.95">
item code="hat001">
name>hatname>
quantity>2quantity>
item>
item code="cha001">
name>chairname>
quantity>1quantity>
item>
item code="dog001">
name>dogname>
quantity>1quantity>
item>
cart>
如果你观察一下下载站点提供的例子应用源码中的cart.java,你将会看到它通过简单地追加字符串来生成xml。对于本例子来说,它已经足够了,我将会在本系统文章的以后一期中介绍一些更好的方法。
现在你知道了cartservlet如何响应一个xmlhttprequest。下一步是返回到客户端,如何用服务器响应来更新页面状态。
通过javascript来处理服务器响应
xmlhttprequest的readystate属性是一个给出请求生命周期状态的数字值。它从表示“未初始化”的0变化到表示“完成”的4。每次readystate改变时,都会引发readystatechange事件,通过onreadystatechange属性配置回调处理函数将会被调用。
在列表3中,你已看到通过调用函数getreadystatehandler()创建了一个处理函数,并被配置给onreadystatechange属性。getreadystatehandler()使用了这样的事实:函数是javascript中的主要对象。这意味着,函数可以作为参数被传递到其它函数,并且可以创建并返回其它函数。getreadystatehandler()要做是就是返回一个函数,来检查xmlhttprequet是否已经完成处理,并传递xml服务器响应到由调用者指定的处理函数。列表6是getreadystatehandler()的代码。
列表6:函数getreadystatehandler()
/**//*
* returns a function that waits for the specified xmlhttprequest
* to complete, then passes its xml response to the given handler function.
* req - the xmlhttprequest whose state is changing
* responsexmlhandler - function to pass the xml response to
*/
function getreadystatehandler(req, responsexmlhandler) {
// 返回一个监听xmlhttprequest实例的匿名函数
return function () {
// 如果请求的状态是“完成”
if (req.readystate == 4) {
// 检查是否成功接收了服务器响应
if (req.status == 200) {
// 将载有响应信息的xml传递到处理函数
responsexmlhandler(req.responsexml);
} else {
// 有http问题发生
alert("http error: "+req.status);
}
}
}
}
http状态码
在列表6中,xmlhttprequest的status属性被测试用来确定请求是否成功完成。当处理简单的get与post请求,你可以认为只要不是200(ok)的状态就表示发生了错误。若服务器发送了一个重定向响应(例如,301或302),浏览器会透明地完成重定向并从新位置获取相应的资源;xmlhttprequest不会看到重定向状态码。同时,浏览器自动添加一个缓存控制:对于所有xmlhttprequest都使用no-cache header,这样客户端代码就可以不用处理304(not-modified)响应。
关于getreadystatehandler()
getreadystatehandler()是相对比较复杂的一段代码,特别当你不能熟悉阅读javascript时。折中方案是在你的javascript库中包含此函数,你可以简单地处理ajax服务器响应,而不用去注意xmlhttprequest的内部细节。重要是你自己要理解在代码中如何使用getreadystatehandler()。
在列表3中,你看到getreadystatehandler()被这样调用:
handlerfunction=getreadystatehandler(req,updatecart)。
由它返回的函数将会检查在req变量中的xmlhttprequest是否已完成,并调用由updatecart指定的回调方法处理响应xml。
提取购物车数据
列表7中展示了updatecart()中的代码。此函数使用dom来解析购物车xml文档,并更新web页面(参见列表1)来反映新的购物车内容。注意对用来提取数据的xml dom的调用。cart元素上生成的属性,即序列化时生成的时间戳,通过检测它可以保证不会用老的数据来覆盖新的购物车数据。ajax请求天生就是异步的,通过这个检测可以有效避免在过程外到达的服务器响应的干扰。
列表7:更新页面来反映出购物车xml文档内容
function updatecart(cartxml) {
// 从文档中获取根元素“cart”
var cart = cartxml.getelementsbytagname("cart")[0];
// 保证此文档是最新的
var generated = cart.getattribute("generated");
if (generated > lastcartupdate) {
lastcartupdate = generated;
// 清除html列表,用来显示购物车内容
var contents = document.getelementbyid("cart-contents");
contents.innerhtml = "";
// 在购物车内按条目循环
var items = cart.getelementsbytagname("item");
for (var i = 0 ; iitems.length ; i++) {
var item = items[i];
// 从name与quantity元素中提取文本节点
var name = item.getelementsbytagname("name")[0].firstchild.nodevalue;
var quantity = item.getelementsbytagname("quantity")[0].firstchild.nodevalue;
// 为条目创建并添加到html列表中
var li = document.createelement("li");
li.appendchild(document.createtextnode(name+" x "+quantity));
contents.appendchild(li);
}
}
// 更新购物车的金额累计
document.getelementbyid("total").innerhtml = cart.getattribute("total");
}
到现在,关于ajax处理过程的教程已经结束,也许你想让应用运行起来,并看看它的实际运作(参见下载部分)。这个例子非常简单,有非常大的改进的余地。比如,我在服务器端代码中包含了从购物车中移除条目的代码,但从客户端ui中没有访问的途径。作为一个练习,尝试在现有的javascript基础上实际这个功能。
使用ajax的挑战
与任何技术一样,使用ajax在相当多的方面都可能范错误。我在这儿讨论的问题目前都缺少解决方案,并将会随着ajax的成熟而解决或提高。随着开发ajax应用经验的不断获取,开发者社区中将会出现最好的实践经验与指导方针。
xmlhttprequest的有效性
ajax开发者面对的一个最大问题是当xmlhttprequest不可用时如何反应。虽然大部分现代浏览器支持xmlhttprequest,但还是有少量的用户,他们的浏览器不能支持,或由于浏览器安全设置而阻止对xmlhttprequest的使用。若你的web应用发布于公司内部的intranet上,你很可能可以指定支持哪种浏览器,并可以确保xmlhttprequest是可用的。若你在公共web上发布,则你必须意识到由于假定xmlhttprequest是可用的,所有就阻止了老浏览器、手持设备浏览器等等用户来使用你的系统。
然而,你应该尽力保证应用系统“正常降级”使用,在系统中保留适用于不支持xmlhttprequest的浏览器的功能。在购物车例子中,最好的方法是有一个add to cart按钮,可以进行常规的提交处理,并刷新页面来反映购物车状态的变化。ajax行卫可以在页面被载入时通过javascript添加到页面中,只在xmlhttprequest可用的情况下,为每个add to cart按钮加上javascript处理函数。另一个方法是在用户登录时检测xmlhttprequest,再决定是提供ajax版本还是常规基于form提交的版本。
可用性考虑
围绕着ajax应用的大部分问题都是很普通的问题。例如,让用户知道他们的输入已经被注册并处理,是很重要的,因为在xmlhttprequest处理过程中并不能提供通常的漏斗旋转光标。一种方法是将“确认”按扭上的文本替换为“正在更新中…”,以避免用户在等待响应时多次点击按钮。
另一个问题是,用户可能没有注意到他们正在观看的页面已经被更新。可以通过使用各种视觉技巧来将用户的眼光吸引到页面的更新区域。还有一个问题是通过ajax更新页面打断了浏览器“退回前页”按钮的正常工作,地址栏中的url不能反映页面的全部状态,并且不能使用书签功能。参见resource章节中列出的网站地址上的文章来了解更多ajax应用关于可用性方面的问题。
服务器负载
使用ajax界面代替传统的基于form的界面可能戏剧性地增加传递到服务器的请求数量。例如,一个普通的google搜索给服务器造成一次命中,并在用户确认搜索表单时发生。然而,google suggest,将会试图自动完成你的搜索词,在用户打字时将会往服务器发送多个请求。在开发一个ajax应用时,要注意到你将会发送多少请求到用户器端,以及服务器的负载指标。你可以通过在客户端适当地缓存请求、与服务器响应来缓减负载压力。你也应该在设计ajax应用时尽量在客户端处理更多的逻辑,而不用与服务器端通讯。
处理异步
一定要记住,没有任何东西可以保证xmlhttprequest将会按照它们被发送的顺序来依次结束。实际上,你在设计系统时,脑子里应该始终假定它们不会按原来顺序结束。在购物车例子中,使用了一个最后更新的时间戳来保证最新的数据不会被改写。这个非常基本的方法可以在购物车场景中工作,但可能不能在其它情况下工作。在设计时刻就要考虑你该如何处理异步服务器响应。
结论
你现在应该对于ajax的基本原则有了一个良好的了解,另外,你应该理解一些更高级的随ajax方法而来的设计问题。创建一个成功的ajax应用需要一系列的方法—从javascript ui设计到服务器端架构—但是你现在应该已经具备了需要使用到的ajax核心知识。