在这篇文章里，你将建立一个简单的ajax。这个练习适合于大多数没有耐心从asap开始编码的读者，但是假定你已经熟悉javascript，php和xml。
在这篇文章里，你将建立一个简单的ajax(asynchronous javascript and xml，异步javascript和xml)。这个练习适合于大多数没有耐心从asap开始编码的读者，但是假定你已经熟悉javascript，php和xml。
你将创建一个名为quickstart简单的ajax web应用。在这个应用中，用户要填写他/她的名字，同时在用户填写的过程中服务器及时返回响应。图1显示了用户装载的初始界面，index.html(注意当请求quickstart web文件夹时，index.html被默认装载，即使文件名没有被显示得提及)。
图1
当用户在输入的时候，以一定的间隔异步联系服务器以检查它此时能否识别。服务器自动地被呼叫，大概一秒钟一次。这就说明了我们不需要在输入完后点击按钮(如send按钮)来进行验证(这种方法或许不适合实际的登入机制，但是确实能很好地展示ajax的一些功能)。
根据不同的输入名字，服务器返回的信息会不同，参见图2中的例子。
图2
可以在本文后面的资源中得到这个例子。
大概看第一眼的时候觉得没有什么特别之处。我们刻意把第一个例子写的简单，使得它易于理解。这个应用的特别之处就是自动显示来自服务器的消息而不需要打断用户的动作(消息在用户输入名字的同时被显示)。显示这些数据不需要页面重新装载，即使一个服务器连接被建立以获得这些数据。使用非ajax web开发技术完成这并不是一个简单的任务。
这个应用包含下面三个文件：
- 1. index.html是用户请求的初始html文件
- 2. quickstart.js是包含了javascript代码的文件，随着index.html在客户端的装载而装载。当需要服务器端的功能时，这个文件就处理向服务器发送异步请求
- 3. quickstart.php是驻留在服务器上的php脚本，处理来自客户端quickstart.js文件里javascript代码的请求。
图3 显示了运行该应用时发生的动作：
图3
1到5步是典型的http请求。在做出这个请求后，用户需要等待直到页面被装载。通过使用xmlhttprequest对象服务器在后台被访问。在这段时间内，用户可以继续正常使用这个页面，就像它是一个桌面程序。从服务器重新获得数据和用这些数据更新页面不需要刷新和重载。
现在是时候在你自己的机子上实现这个代码了。在开始之前，确定你已经像附录a中显示的那样准备好工作环境。附录a中指导你如何安装、设置php和apache，以及如何安装本书中例子用到的数据库(在这个quickstart例子中你不需要数据库)。
开始行动――quickstart ajax
- 1. 在附录a中，指导你建立一个web服务器并创建一个名为ajax的web文件夹。在这个文件夹里存放了这本书的代码。
- 1. 在ajax目录下创建一个名为quickstart的子目录。
- 2. 在quickstart目录下，创建一个名为index.html的文件，在文件中添加如下代码：
| <!doctype html public "-//w3c//dtd xhtml 1.0 transitional//en" "http://www.w3.org/tr/xhtml1/dtd/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>ajax with php: quickstart</title> <script type="text/javascript" src="quickstart.js"></script> </head> <body onload='process()'> server wants to know your name: <input type="text" id="myname" /> <div id="divmessage" /> </body> </html> |
- 3. 创建一个名为quickstart.js的文件，并添加如下代码：
|
// stores the reference to the xmlhttprequest object
|
- 4. 创建一个名为qucikstart.php的文件，并添加如下代码：
| <?php // we'll generate xml output header('content-type: text/xml'); // generate xml header echo '<?xml version="1.0" encoding="utf-8" standalone="yes"?>'; // create the <response> element echo '<response>'; // retrieve the user name $name = $_get['name']; // generate output depending on the user name received from client $usernames = array('cristian', 'bogdan', 'filip', 'mihai', 'yoda'); if (in_array(strtoupper($name), $usernames)) echo 'hello, master ' . htmlentities($name) . '!'; else if (trim($name) == '') echo 'stranger, please tell me your name!'; else echo htmlentities($name) . ', i don\'t know you!'; // close the <response> element echo '</response>'; ?> |
- 5. 现在你就可以使用你喜欢的浏览器，通过装载http://localhost/ajax/quickstart来访问新写的程序。装载这个页面，你将得到像图1和图2那样的页面。如果你在运行这个程序的过程中遇到任何问题，检查你是否按照附录a中描述的那样安装和配置。大多数错误的发生都是诸如输入之类的小错误。
刚才发生了什么?
下面就是比较有趣的部分。你将理解在那些代码里发生了什么。让我们从用户首先交互的文件，index.html，开始。这个文件引用了一个神奇的名为quickstart.js的javascript文件，并且建立了一个非常简单的客户端交换。下面的代码片断是取自index.html，注意下用粗体标出的元素。
| <body onload='process()'> server wants to know your name: <input type="text" id="myname" /> <div id="divmessage" /> </body> |
当页面装载的时候，quickstart.js中一个名为process()的函数就会被执行。这以某种方式引起<div>元素被服务器上的消息填充。在看process()函数内部发生了什么之前让我们看看在服务器内发生了什么。在服务器上，你有一个名为quickstart.php的脚本。它用来创建发往客户端的xml消息。这个xml消息包含一个<response>元素。这个元素封装了服务器发往客户端的消息：
| <?xml version="1.0" encoding="utf-8" standalone="yes"?> <response> ... message the server wants to transmit to the client ... </response> |
如果从客户端获取的信息是空的，那么返回的信息就是“stranger，please tell me your name!”。如果名字是cristian，bogdan，filip，mihai或者yoda，服务器返回“hello，master<user name>!”。如果是其他的，那么消息就是“<user name>
| <?xml version="1.0" encoding="utf-8" standalone="yes"?> <response> mickey mouse, i don't know you! </response> |
quickstart.php脚本的开头产生xml文档的头和<response>
| <?php // we'll generate xml output header('content-type: text/xml'); // generate xml header echo '<?xml version="1.0" encoding="utf-8" standalone="yes"?>'; // create the <response> element echo '<response>'; |
加粗的部分把输出标记为xml文档，这很重要。因为客户端期待接受xml(如果头没有设置content-type为text/xml，那么客户端解析xml的api会抛出一个错误)。在设置头之后，代码就开始连接字符串生成xml响应。实际要返回给客户端的信息被封装在<response>元素内。这是个根元素。<response>元素里的信息是基于客户端通过get参数传来的名字：
| // retrieve the user name $name = $_get['name']; // generate output depending on the user name received from client $usernames = array('cristian', 'bogdan', 'filip', 'mihai', 'yoda'); if (in_array(strtoupper($name), $usernames)) echo 'hello, master ' . htmlentities($name) . '!'; else if (trim($name) == '') echo 'stranger, please tell me your name!'; else echo htmlentities($name) . ', i don\'t know you!'; // close the <response> element echo '</response>'; |
用户输入的内容(假定是用户的名字)通过使用get参数从客户端传送到服务器端。当把这个信息回传给客户端时，我们使用了php里的函数htmlentities来取代html代码里的特殊字符(如&,>)，以确保在浏览器里能够安全地显示这些信息，消除潜在的问题和安全风险。
注意：
在服务器端为客户端格式化信息(而不是直接在客户端来做)在编写商业代码时实际上是个不好的做法。一般来讲，服务器的职责就是以普通的格式发送数据，而由接受端来处理安全和格式化事务。如果你想某一天你要往数据库中插入完全相同的信息，但是数据库需要不同的格式化的序列(在这种情况下，应该由数据库来格式化数据而不是服务器)，这样似乎更有意义。对于quickstart，在php中格式化html可以使得我们保持代码简短，易于理解和解释。
如果你好奇，想测试quickstart.php看看它产生了什么，你可以在你的浏览器里装载http://localhost/ajax/quickstart/quickstart.php?name=yoda。在客户端通过get传递参数的好处是在你的浏览器它可以简单地产生个类似的请求，因为get只是意味着你在url查询字符串中附加了name/value这么一对参数。你将得到类似下面的东西：
这个xml消息在客户端通过quickstart.js的handleserverresponse()方法处理。更明确地说，是下面几行代码提取了“hello,master yoda”消息：
| // extract the xml retrieved from the server xmlresponse = xmlhttp.responsexml; // obtain the document element (the root element) of the xml structure xmldocumentelement = xmlresponse.documentelement; // get the text message, which is in the first child of // the document element hellomessage = xmldocumentelement.firstchild.data; |
这里xmlhttp是xmlhttprequest的对象，用来在客户端调用服务器上的quickstart.php脚本文件。它的responsexml属性处理得到的xml文档。xml的结构天然就是层次的。xml文件的根元素被称为文档元素。在我们这个例子中，文档元素是
| // update the client display using the data received from the server document.getelementbyid('divmessage').innerhtml = hellomessage; |
document是javascript里的默认对象，允许你对页面的html代码里的元素进行操作。
quickstart.js里的其他代码用来向服务器产生请求以或得xml消息。createxmlhttprequestobject()方法创建并返回xmlhttprequest对象。这个方法要比它本来的要长些，这是因为我们要保持它对各个浏览器兼容。xmlhttprequest的实例，即xmlhttp在process()方法里被使用以向产生服务器产生异步请求：
| // make asynchronous http request using the xmlhttprequest object function process() { // proceed only if the xmlhttp object isn't busy if (xmlhttp.readystate == 4 || xmlhttp.readystate == 0) { // retrieve the name typed by the user on the form name = encodeuricomponent(document.getelementbyid("myname").value); // execute the quickstart.php page from the server xmlhttp.open("get", "quickstart.php?name=" + name, true); // define the method to handle server responses xmlhttp.onreadystatechange = handleserverresponse; // make the server request xmlhttp.send(null); } else // if the connection is busy, try again after one second settimeout('process()', 1000); } |
你在这里看到的实际上是ajax的核心部分，即向服务器产生异步请求的代码。
为什么向服务器发异步请求很重要呢?异步请求，它们的本性就是在请求发出的时候不中断处理(还有用户的体验)，直到响应返回。在事件驱动的模型中也应用了异步处理。这是图形用户界面构建的一个好方式。没有事件，你或许得实时检查用户是否点击了一个按钮或者改变了窗口大小。使用事件，当按钮被点击的时候会自动地触发相应的处理程序，同时你也可以在事件处理方法里采取相应的动作。在ajax中，这个理论起作用当你向服务器发送了一个请求，在响应消息返回的时候你会被自动通知。
如果你对这个应用如果使用异步请求工作好奇的话，你可以象下面这样把xmlhttp.open的第三个参数改为false，然后手动地调用handleserverresponse。如果你这样做了，假定你输入你的名字的输入框就会在连接服务器的时候锁定(在这个情况下，锁定的时间取决于连接速度，如果服务器就在本机上的话这个会是很短的)。
| // function calls the server using the xmlhttprequest object function process() { // retrieve the name typed by the user on the form name = encodeuricomponent(document.getelementbyid("myname").value); // execute the quickstart.php page from the server xmlhttp.open("get", "quickstart.php?name=" + name, false); // make synchronous server request (freezes processing until completed) xmlhttp.send(null); // read the response handleserverresponse(); } |
process()方法是通过使用xmlhttprequest对象来初始化一个服务器请求。然而这凑效仅仅是在xmlhttprequest对象没有忙于其他请求。在我们这个例子里，如果服务器的响应超过了1秒钟，这种情况是可能发生的。服务器响应延迟大可能是由于网络连接非常慢。所以，在process()的开始需要验证创建新请求是否是可行的：
| // make asynchronous http request using the xmlhttprequest object function process() { // proceed only if the xmlhttp object isn't busy if (xmlhttp.readystate == 4 || xmlhttp.readystate == 0) { |
如果连接很忙，我们使用settimeout来在1秒钟之后重试(这个方法的第二个参数用来指定执行由第一个参数指定的代码前要等待的毫秒数)：
| // if the connection is busy, try again after one second settimeout('process()', 1000); |
如果这行很清楚了，那么你就可以很安全地创建一个新请求。准备服务器请求但是不提交的代码如下：
| // execute the quickstart.php page from the server xmlhttp.open("get", 'quickstart.php?name=' + name, true); |
第一个参数指定了向服务器发送用户姓名的方法。你可以在get和post之间选择。第二个参数是你要访问的服务器页面。当第一个参数是get是，你以name/value对的形式在查询串中传递参数。如果你希望调用是异步的话，第三个参数就是true。当做异步调用的时候，你不必等待响应。相反，你可以另外定义一个方法，它在请求的状态发生改变的时候自动地被调用：
| // define the method to handle server responses xmlhttp.onreadystatechange = handleserverresponse; |
一旦你设定了这个选项，你就可以安静地休息了――在你的请求发生了任何变化的时候，handleserverresponse方法都会被执行。在一切都设置好之后，你可以通过调用xmlhttprequest的send方法来初始化请求：
| // make the server request xmlhttp.send(null); } |
让我们来看看handleserverresponse方法：
| // executed automatically when a message is received from the server function handleserverresponse() { // move forward only if the transaction has completed if (xmlhttp.readystate == 4) { // status of 200 indicates the transaction completed successfully if (xmlhttp.status == 200) { |
无论什么时候请求的状态发生了变化，handleserverresponse方法都会被多次执行。只有当xmlhttp.readystate的值为4时，服务器请求才完成，此时你就可以继续读取结果。你也可以检查http传输，如果报告状态是200的话，就意味着在http请求过程中没有出错。当这些条件满足后，你可以自由地读取服务器响应和向用户显示信息。在接受和使用服务器响应之后，通过使用settimeout方法可以再次开始这个过程，也就是使process()方法在1秒钟之后被执行(注意，尽管这个是不必要的，甚至也不是ajax特别要求的在你的客户端代码中要有重复性的任务)：
| // restart sequence settimeout('process()', 1000); |
最后，我们再重复下用户装载页面之后发生了什么(你可以参考图3，它是对这一过程的图形描述)：
- 1. 用户装载index.html(这个相当于图3中的1到4步)
- 2. 用户开始(或者继续)输入他/她的名字(这个相当于图3中的第5步)
- 3. 当quickstart.js中的process()方法被执行时，它将异步调用服务器端的quickstart.php脚本。用户输入的文本作为查询字符串的参数在调用的时候传送(它是通过get被传递的)。指定handleserverresponse方法来处理请求状态的改变
- 4. 在服务器端执行quickstart.php。它合成一个封装了服务器要传输给客户端的信息的xml文档。
- 5. 在请求的状态发生了变化时，handleserverresponse方法都会被多次执行。它最后一次被调用实在响应信息被正确地接受了。读取xml文档，抽取其中的信息，然后在页面上显示。
- 6. 当有新消息从服务器端传来时，用户显示就被更新。但是用户可以继续输入而不被打断。在延迟1秒之后，从步骤2又重新开始这个过程。
总结
这篇文章是对ajax的一个简介。为了学习如何创建ajax应用，理解他们为什么有用和在哪里有用是很重要的。就像是其他技术一样，ajax并不是所有问题的解决方法，它只是提供了解决其中一部分的途径。
ajax把客户端和服务器端按照功能结合起来了，增强了用户对你的网站的体验。xmlhttprequest对象是使得客户端javascript代码能够异步调用服务器其他页面的一个关键元素。
闽公网安备 35060202000074号