ajax如何處理伺服器返回的3種資料格式

jeffcott_lu發表於2017-05-15

這篇東西本身是非常基礎的,但是經常在處理ajax返回值的時候還是會犯各種小錯誤,所以就想到把這些方法結合以前寫過的程式碼片段整理一下,方便以後複習和使用。另外呢,雖然能搜到很多類似的文件,但是整理一份自己的還是墜吼的= ̄ω ̄=

ajax方法的引數

常用的ajax引數比如url,data,type,包括預期返回型別dataType,傳送到伺服器的資料的編碼型別contentType,成功方法,失敗方法,完成方法。除了這些以外還有很多其他內建的引數
需要注意的是:
1.url:
要求為String型別的引數,(預設為當前頁地址)傳送請求的地址。
2.type:
要求為String型別的引數,請求方式(post或get)預設為get。注意其他http請求方法,例如put和delete也可以使用,但僅部分瀏覽器支援。
3.timeout:
要求為Number型別的引數,設定請求超時時間(毫秒)。此設定將覆蓋$.ajaxSetup()方法的全域性設定。
4.async:
要求為Boolean型別的引數,預設設定為true,所有請求均為非同步請求。如果需要傳送同步請求,請將此選項設定為false。注意,同步請求將鎖住瀏覽器,使用者其他操作必須等待請求完成才可以執行。
5.cache:
要求為Boolean型別的引數,預設為true(當dataType為script時,預設為false),設定為false將不會從瀏覽器快取中載入請求資訊。
6.data:
要求為Object或String型別的引數,傳送到伺服器的資料。如果已經不是字串,將自動轉換為字串格式。get請求中將附加在url後。防止這種自動轉換,可以檢視  processData選項。物件必須為key/value格式,例如{foo1:”bar1″,foo2:”bar2″}轉換為&foo1=bar1&foo2=bar2。如果是陣列,JQuery將自動為不同值對應同一個名稱。例如{foo:[“bar1″,”bar2”]}轉換為&foo=bar1&foo=bar2。
7.dataType:
要求為String型別的引數,預期伺服器返回的資料型別。如果不指定,JQuery將自動根據http包mime資訊返回responseXML或responseText,並作為回撥函式引數傳遞。可用的型別如下:
xml:返回XML文件,可用JQuery處理。
html:返回純文字HTML資訊;包含的script標籤會在插入DOM時執行。
script:返回純文字JavaScript程式碼。不會自動快取結果。除非設定了cache引數。注意在遠端請求時(不在同一個域下),所有post請求都將轉為get請求。
json:返回JSON資料。
jsonp:JSONP格式。使用SONP形式呼叫函式時,例如myurl?callback=?,JQuery將自動替換後一個“?”為正確的函式名,以執行回撥函式。
text:返回純文字字串。
8.beforeSend:
要求為Function型別的引數,傳送請求前可以修改XMLHttpRequest物件的函式,例如新增自定義HTTP頭。在beforeSend中如果返回false可以取消本次ajax請求。XMLHttpRequest物件是惟一的引數。

        function(XMLHttpRequest){
           this;   //呼叫本次ajax請求時傳遞的options引數
        }

9.complete:
要求為Function型別的引數,請求完成後呼叫的回撥函式(請求成功或失敗時均呼叫)。引數:XMLHttpRequest物件和一個描述成功請求型別的字串。

      function(XMLHttpRequest, textStatus){
         this;    //呼叫本次ajax請求時傳遞的options引數
      }

10.success:要求為Function型別的引數,請求成功後呼叫的回撥函式,有兩個引數。

     (1)由伺服器返回,並根據dataType引數進行處理後的資料。
     (2)描述狀態的字串。
     function(data, textStatus){
        //data可能是xmlDoc、jsonObj、html、text等等
        this;  //呼叫本次ajax請求時傳遞的options引數
     }

11.error:
要求為Function型別的引數,請求失敗時被呼叫的函式。該函式有3個引數,即XMLHttpRequest物件、錯誤資訊、捕獲的錯誤物件(可選)。ajax事件函式如下:

   function(XMLHttpRequest, textStatus, errorThrown){
      //通常情況下textStatus和errorThrown只有其中一個包含資訊
      this;   //呼叫本次ajax請求時傳遞的options引數
   }

12.contentType:
要求為String型別的引數,當傳送資訊至伺服器時,內容編碼型別預設為”application/x-www-form-urlencoded”。該預設值適合大多數應用場合。
13.dataFilter:
要求為Function型別的引數,給Ajax返回的原始資料進行預處理的函式。提供data和type兩個引數。data是Ajax返回的原始資料,type是呼叫jQuery.ajax時提供的dataType引數。函式返回的值將由jQuery進一步處理。

        function(data, type){
            //返回處理後的資料
            return data;
        }

14.dataFilter:
要求為Function型別的引數,給Ajax返回的原始資料進行預處理的函式。提供data和type兩個引數。data是Ajax返回的原始資料,type是呼叫jQuery.ajax時提供的dataType引數。函式返回的值將由jQuery進一步處理。

        function(data, type){
            //返回處理後的資料
            return data;
        }

15.global:
要求為Boolean型別的引數,預設為true。表示是否觸發全域性ajax事件。設定為false將不會觸發全域性ajax事件,ajaxStart或ajaxStop可用於控制各種ajax事件。
16.ifModified:
要求為Boolean型別的引數,預設為false。僅在伺服器資料改變時獲取新資料。伺服器資料改變判斷的依據是Last-Modified頭資訊。預設值是false,即忽略頭資訊。
17.jsonp:
要求為String型別的引數,在一個jsonp請求中重寫回撥函式的名字。該值用來替代在”callback=?”這種GET或POST請求中URL引數裡的”callback”部分,例如{jsonp:‘onJsonPLoad‘}會導致將”onJsonPLoad=?”傳給伺服器。
18.username:
要求為String型別的引數,用於響應HTTP訪問認證請求的使用者名稱。
19.password:
要求為String型別的引數,用於響應HTTP訪問認證請求的密碼。
20.processData:
要求為Boolean型別的引數,預設為true。預設情況下,傳送的資料將被轉換為物件(從技術角度來講並非字串)以配合預設內容型別”application/x-www-form-urlencoded”。如果要傳送DOM樹資訊或者其他不希望轉換的資訊,請設定為false。
21.scriptCharset:
要求為String型別的引數,只有當請求時dataType為”jsonp”或者”script”,並且type是GET時才會用於強制修改字符集(charset)。通常在本地和遠端的內容編碼不同時使用。
案例程式碼:

$(function(){
    $(‘#send‘).click(function(){
        $.ajax({
            type: "GET",
            url: "test.json",
            data: {username:$("#username").val(), content:$("#content").val()},
            dataType: "json",
            success: function(data){
                $(‘#resText‘).empty();  //清空resText裡面的所有內容
                var html = ‘‘;
                $.each(data, function(commentIndex, comment){
                      html += ‘<div class="comment"><h6>‘ + comment[‘username‘]
                                + ‘:</h6><p class="para"‘ + comment[‘content‘]
                                + ‘</p></div>‘;
                });
                $(‘#resText‘).html(html);
            }
        });
    });
});

22.順便說一下$.each()函式:
$.each()函式不同於JQuery物件的each()方法,它是一個全域性函式,不操作JQuery物件,而是以一個陣列或者物件作為第1個引數,以一個回撥函式作為第2個引數。回撥函式擁有兩個引數:第1個為物件的成員或陣列的索引,第2個為對應變數或內容。


需要注意的地方:

1. 如果不指定dataType的話,會根據返回的頭部資訊判斷(就是Content-type)。

綜論

ajax返回3種資料格式:html文字格式,xml通用格式,json格式,
資料型別:整數,字串,陣列,物件

ajax返回整數型別

/**
 * ajax_delete
 */
$(".delete").click(function(){
  var id = $(this).attr(`id`);
  var flag = confirm("確定要刪除第"+id+"條資訊嗎?");
  if(flag){
    var tr = $(this).parent().parent();
    $.get("index.php?r=demo1/delete",{id:id},function(data){
      console.log(data);
      if(data==1){
        tr.remove();
        alert("刪除成功");
      }else{
        alert("刪除失敗");
      }
    })
  }
})

這樣,後臺一個判斷,執行則返回1就好了,可以說是最簡單的ajax了。
通常返回整形都是做判斷用。是否刪除啊,…..,雖然簡單,但是很常用。

ajax返回Html/text(字串型別)

與上面返回int相對應的呢…比如ajax新增,就會返回html或者text,也就是string型別的資料。

ajax返回json

因為json沒有格式,相同內容佔用空間少處理快,所以較xml,字串(text/html)而言,我們更經常處理json。

$.ajax({
      type:"GET",
      url:"address_do.php",
      //dataType:"json",
      data:{postcode:postcode},

      success:function(data){
      console.log(data);
      location.href="address_do.php";
        if(data.success == 1){
          var str = "";
          str += "<p>"+data.result.lists[0].simcall+"</p>";
          str += "<p>"+data.result[`asc`]+"</p>";
          $("button").after("<span>"+str+"</span>");
        }
      }
})
$(function(){
    $("#search").click(function(){
      var title = $("#title").val();/*alert(title);*/
      $.ajax({
        type:"GET",
        url:"index_baidu_do.php",//
        dataType:"json",
        data:{"title":title},

        success:function(data){
          var str = "";
          if(data == 0){
            str+="<tr>沒有搜尋到相關資料</tr>";
          }else{
            for(var i=0;i<data.length;i++){
              str+=`<tr>`;
              str+=`<td>`+data[i].title+`</td>`;
              str+=`<td>`+data[i].content+`</td>`;
              str+=`<td>`+data[i].website+`</td>`;
              str+=`<td>`+data[i].time+`</td>`;
              str+=`<tr>`;
            }
          }
          $("#table").html(str);
        }
      })
    })
  })
$.get(url,data,function(msg){
  msg = eval("("+msg+")");
  if(!(/^[0-9][0-9]{5}$/.test(postcode))){
    str += "<p>您輸入的郵政編碼不正確</p>";
    $("button").after("<span>"+str+"</span>");
  }else{
    str += "<p>"+msg.result.lists[0].simcall+"</p>";
    str += "<p>"+msg.result[`asc`]+"</p>";
    $("button").after("<span>"+str+"</span>");
  }
},`json`);alert(data);
success:function(data){
  console.log(data);
  var result = data[`result`];
  var str = "";
  str += "<table border=`1`><tr><td>手機號</td><td>歸屬地</td><td>區號</td><td>資料來源</td></tr><tr><td>"+result[`phone`]+"</td><td>"+result[`att`]+"</td><td>"+result[`postno`]+"</td><td></td></tr></table>";
  $("#click").after(str);
}
$.ajax({
    type: "GET",
    url: "Ajax/Test.ashx",
    data: "HandleType=GetList&PName=" + escape($("#localvalue").val()), //要傳送的資料   
    dataType: "text",
    success: function (data) {
        if (data != null && data != "") {
            var dataObj = eval("(" + data + ")"); //轉換為json物件 
            var html = "";
            for (var i = 0; i < dataObj.length; i++) {            
                html += "<tr style=`cursor:pointer;` onclick="InfoWindow(`" + dataObj[i].Name + "`,`" + dataObj[i].ID + "`,`" + dataObj[i].Code + "`);">";
                html += "<td>" + (parseInt(i) + parseInt(1)) + "</td><td>" + dataObj[i].Name + "</td>";
                html += "</tr>";             
            }
            $("#table").html(html);
        }
    }
})


html部分
 <table id="table"  style="line-height:25px; margin:2px; "></table>

eval的使用

PS:紅色部分是容易出錯的地方,也就是ajax返回資料的拼接,也是ajax的難點之一
另外,需要注意的是,這段程式碼裡設定返回資料型別是text,所以需要用eval把返回資料處理
參考http://blog.csdn.net/ztzy520/…
用eval()方法把返回來的json資料轉換成陣列
data=eval(`(`+data+`)`);

$("#search").click(function(){
      var obj = $(this);
      var searchContent = obj.prev().val();
      alert(searchContent);
      $.ajax({
        url:"index.php?r=news/search",
        type:"post",
        dataType:"json",
        data:{searchContent:searchContent},
        success:function(data){
          var str = "";
          str+=`<table border="1" id="table">`;
          str+=`<tr>`;
          str+=`<td>ID</td>`;
          str+=`<td>新聞標題</td>`;
          str+=`<td>新聞內容</td>`;
          str+=`<td>分類</td>`;
          str+=`<td>圖片</td>`;
          str+=`<td>操作</td>`;
          str+=`</tr>`;
          if(data == 0){
            str+="<tr>沒有搜尋到相關資料</tr>";
          }else{
            for(var i=0;i<data.length;i++){

              str+=`<tr>`;
              str+=`<td>`+data[i].news_id+`</td>`;
              str+=`<td>`+data[i].newsTitle+`</td>`;
              str+=`<td>`+data[i].newsContent+`</td>`;
              str+=`<td>`+data[i].cate_name+`</td>`;
              str+=`<td><img src="`+data[i].img_name+`" alt="" width="100px" height="60"></td>`;
              str+=`<td><a href="`+data[i].news_id+`">刪除</a>/<a href="`+data[i].news_id+`">修改</a></td>`;
              str+=`</tr>`;
            }
          }
          $("#table").html(str);

        }
      })
    })

說實話,即使把這個掌握了,即使是處理一些最簡單的專案也並不是能輕易拿下,因為實際生產環境涉及到的業務邏輯啊,框架啊(比如yii框架會預設載入模板,這樣返回值會很難處理)等等一些我們意想不到的東西。但是我目前的看法是,ajax處理的話程式碼邏輯會非常清晰,再者說ajax的確是作為一個碼農最基本的技能之一。
第一次寫部落格兼學識有限,以後還會有修改,求輕拍。

相關文章