AJAX随笔

写在前面：第一次用到ajax进行异步调用，所以想写一个文档来整理一下ajax和所遇到的问题。

1.简单说一下ajax是什么？

　　　　ajax 是一种在无需重新加载整个网页的情况下，能够更新部分网页的技术，ajax = 异步 javascript 和 xml，它通过在后台与服务器进行少量数据交换，ajax 可以使网页实现异步更新。这意味着可以在不重新加载整个网页的情况下，对网页的某部分进行更新。

ajax 基本上就是把 javascript 技术和 xmlhttprequest 对象放在 web 表单和服务器之间，如图所示：当用户填写表单发送数据，javascript会接收数据，然后进行异步的发送url请求来获得数据，而不用去刷新整个页面来等待服务器的响应，当服务器接收到数据后，会返回一个javascript数据内容，可以通过多种方式接收，我采用的是xml。

2.ajax 参数类型详解（本表格转载于http://www.cnblogs.com/qiufuwu618/archive/2012/12/20/2826190.html，可以过去详细看看，这里只列举如下参数）

参数名	类型	描述
url	string	(默认: 当前页地址) 发送请求的地址。
type	string	(默认: "get") 请求方式 ("post" 或 "get")， 默认为 "get"。注意：其它 http 请求方法，如 put 和 delete 也可以使用，但仅部分浏览器支持。
timeout	number	设置请求超时时间（毫秒）。此设置将覆盖全局设置。
async	boolean	(默认: true) 默认设置下，所有请求均为异步请求。如果需要发送同步请求，请将此选项设置为 false。注意，同步请求将锁住浏览器，用户其它操作必须等待请求完成才可以执行。
beforesend	function	发送请求前可修改 xmlhttprequest 对象的函数，如添加自定义 http 头。xmlhttprequest 对象是唯一的参数。 function (xmlhttprequest) { this; // the options for this ajax request }
cache	boolean	(默认: true) jquery 1.2 新功能，设置为 false 将不会从浏览器缓存中加载请求信息。
complete	function	请求完成后回调函数 (请求成功或失败时均调用)。参数： xmlhttprequest 对象，成功信息字符串。 function (xmlhttprequest, textstatus) { this; // the options for this ajax request }
contenttype	string	(默认: "application/x-www-form-urlencoded") 发送信息至服务器时内容编码类型。默认值适合大多数应用场合。
data	object, string	发 送到服务器的数据。将自动转换为请求字符串格式。get 请求中将附加在 url 后。查看 processdata 选项说明以禁止此自动转换。必须为 key/value 格式。如果为数组，jquery 将自动为不同值对应同一个名称。如 {foo:["bar1", "bar2"]} 转换为 '&foo=bar1&foo=bar2'。
datatype	string	预期服务器返回的数据类型。如果不指定，jquery 将自动根据 http 包 mime 信息返回 responsexml 或 responsetext，并作为回调函数参数传递，可用值: "xml": 返回 xml 文档，可用 jquery 处理。 "html": 返回纯文本 html 信息；包含 script 元素。 "script": 返回纯文本 javascript 代码。不会自动缓存结果。 "json": 返回 json 数据 。 "jsonp": jsonp 格式。使用 jsonp 形式调用函数时，如 "myurl?callback=?" jquery 将自动替换 ? 为正确的函数名，以执行回调函数。
error	function	(默认: 自动判断 (xml 或 html)) 请求失败时将调用此方法。这个方法有三个参数：xmlhttprequest 对象，错误信息，（可能）捕获的错误对象。 function (xmlhttprequest, textstatus, errorthrown) { // 通常情况下textstatus和errorthown只有其中一个有值 this; // the options for this ajax request }
global	boolean	(默认: true) 是否触发全局 ajax 事件。设置为 false 将不会触发全局 ajax 事件，如 ajaxstart 或 ajaxstop 。可用于控制不同的ajax事件
ifmodified	boolean	(默认: false) 仅在服务器数据改变时获取新数据。使用 http 包 last-modified 头信息判断。
processdata	boolean	(默认: true) 默认情况下，发送的数据将被转换为对象(技术上讲并非字符串) 以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 dom 树信息或其它不希望转换的信息，请设置为 false。
success	function	请求成功后回调函数。这个方法有两个参数：服务器返回数据，返回状态 function (data, textstatus) { // data could be xmldoc, jsonobj, html, text, etc... this; // the options for this ajax request }

 

3.应用

js代码如图所示：

function getbuyercodebyjson(){
        var sellercode = document.forms[0].elements['searchcriteria.sellercode'].value;
        var url = "getbuyercodebyjson.do?searchcriteria.sellercode=" + sellercode ; //调用url
        var prop = {
                action: url,
                success: function(obj) {//返回一个success
                    var responsexml = obj.data; //如需获得来自服务器的响应，请使用 xmlhttprequest 对象的 responsetext 或 responsexml 属性。
                    var responses = responsexml.getelementsbytagname( "response" ); //获得响应数据                
                    if (responses != null && responses.length ) {//响应数据不为空
                        var result = responses[0].getattribute("result");
                        if (result == 'success') {//返回一个success，返回值是一个xml信息
                            var msg = responsexml.getelementsbytagname("cause")[0].childnodes;
                            var buyercode = msg[0].firstchild.nodevalue;//获取第一个子节点的value值
                              document.forms[0].elements['searchcriteria.buyercode'].value = buyercode;//对页面上的html进行赋值
                              
                              getprodandsourchbranchbyjson();
                        }else if(result == 'failure'){
                            
                        } else if (result == 'fail') {
                            
                        }                                
                    }
                }
            };
            jaf.ajaxsend(prop);
        
    }

jaf.ajaxsend = function(prop) {
    var p = {
        action  : location.href,
        method  : "get",
        contenttype :  "application/x-www-form-urlencoded",
        async   : true,
        params  : null,
        datatype: "xml",
        success : null,
        error   : null
    }
    if (prop) {
        p = jaf.merge(prop, p);
    }
    var csrftokenurl = p.action;
    if(typeof(addtokentourl)!='undefined'){
        csrftokenurl = addtokentourl(csrftokenurl);
    }
    p.action = csrftokenurl;
    var regquery = /\?/; // regular expression for query string
    // if params is available, append params to action url for get requests
    if (p.params && p.method === "get") {
        p.action += (regquery.test(p.action) ? "&" : "?") + p.params;
    }
    // build the request object
    var xhr = jaf.buildxhr();
    if (!xhr) return;
    xhr.open(p.method, p.action, p.async);
    // set the correct header, if params is being sent
    if (p.params || p.contenttype) {
        xhr.setrequestheader("content-type", p.contenttype);
    }
    
    // wait for a response to come back
    var onreadystatechange = xhr.onreadystatechange = function( ) {
        if (xhr && xhr.readystate === 4) {
            if (xhr.status === 0 || xhr.status === 200) {
                var data = (p.datatype === "xml") ? xhr.responsexml : xhr.responsetext;
                success({
                    data : data
                });
            }
            // stop memory leaks
            if (p.async) xhr = null;
        }
    };
    
    // send params
    try {
        if(p.params)
        xhr.send(p.method === "post" ? p.params : null);
    } catch(e) {}
    
    /**
     * to be invoked when ajax send success
     * @param obj json
     *            data : return data
     */
    function success(obj) {
        // if call-back for sccuss is specified, fire it and pass it an object with return data
        if (p.success) {
            p.success.call(null, obj);
        }
    }
    
    return xhr;
}

 

responsetext ：获得字符串形式的响应数据。

responsexml ：获得 xml 形式的响应数据。

java代码：

　　　　　　　　　companygridform lookupform = (companygridform)form;
                arsellerbuyersearchcriteria criteria = lookupform.getsearchcriteria2();
                if (lookupform.getfirsttimeopen().equals(baseconstants.yes)) {
                    lookupform.getsearchcriteria().setpagesize(10);
                }
                if(null == lookupform.getsellercode()||stringutil.isempty(lookupform.getsellercode())){
                     lookupform.setsellercode(lookupform.getsearchcriteria().getsellercode());
                }
                criteria = poiextclsinterface.getarbuyerlistbysitecodeandseller(criteria, lookupform.getsellercode());
                string buyercode = "";
                string sellercode = lookupform.getsellercode();
                string importfactor = "";
                voarprofile voarprofile = null;
                voarsellerbuyer[] voarsellerbuyers = criteria.getsellerbuyers();
                lookupform.setsearchcriteria2(criteria);
                string responsexml = null;
                string checkmessage = null;
                    if(voarsellerbuyers != null && voarsellerbuyers.length == 1){//页面需求为，如果每个seller对应的只有一个buyer可选，那么会自动进行页面局部刷新
　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　所以长度为1
                         buyercode = voarsellerbuyers[0].getbuyercustcode();   //得到一个buyer
                        checkmessage = "<buyercode>"+buyercode+"</buyercode>";//组装xml信息
                    }
                    if(!stringutil.isempty(checkmessage)){//如果xml不为空，返回一个success
                        responsexml = "<response result=\"success\"><cause>"+checkmessage+"</cause></response>";
                    } else {   　　　　　　　　　　　　　　　　//否则返回failure
                        responsexml = "<response result=\"failure\"></response>";
                    }
                    this.printwriterxml(response,responsexml);
                    return null;

private void printwriterxml(final httpservletresponse response, final string responsexml)
            throws wafexception {
            try {
                // response.setcharacterencoding("utf-8");
                response.setcontenttype("text/xml;charset=utf-8");
                response.setheader("cache-control", "no-cache");
                printwriter out = response.getwriter();
                out.println(responsexml);
                out.close();
            } catch (ioexception e) {
                throw new wafexception(e.getmessage());
            }