ajax函數有哪些引數

2022-01-19 19:01:23

ajax函數的引數有:options、async、cache、contentType、context、data、dataFilter、dataType、error、global、ifModified、jsonp、processData等。

本教學操作環境:windows7系統、jquery1.10.2版本、Dell G3電腦。

ajax() 函數通過 HTTP 請求載入遠端資料。

該方法是 jQuery 底層 AJAX 實現。簡單易用的高層實現見 $.get, $.post 等。$.ajax() 返回其建立的 XMLHttpRequest 物件。大多數情況下你無需直接操作該函數,除非你需要操作不常用的選項,以獲得更多的靈活性。

最簡單的情況下,$.ajax() 可以不帶任何引數直接使用。

注意:所有的選項都可以通過 $.ajaxSetup() 函數來全域性設定。

語法:

jQuery.ajax([settings])
引數描述
settings

可選。用於設定 Ajax 請求的鍵值對集合。

可以通過 $.ajaxSetup() 設定任何選項的預設值。

引數:

options

  • 型別:Object

  • 可選。AJAX 請求設定。所有選項都是可選的。

async

  • 型別:Boolean

  • 預設值: true。預設設定下,所有請求均為非同步請求。如果需要傳送同步請求,請將此選項設定為 false。

  • 注意,同步請求將鎖住瀏覽器,使用者其它操作必須等待請求完成才可以執行。

beforeSend(XHR)

  • 型別:Function

  • 傳送請求前可修改 XMLHttpRequest 物件的函數,如新增自定義 HTTP 頭。

  • XMLHttpRequest 物件是唯一的引數。

  • 這是一個 Ajax 事件。如果返回 false 可以取消本次 ajax 請求。

cache

  • 型別:Boolean

  • 預設值: true,dataType 為 script 和 jsonp 時預設為 false。設定為 false 將不快取此頁面。

  • jQuery 1.2 新功能。

complete(XHR, TS)

  • 型別:Function

  • 請求完成後回撥函數 (請求成功或失敗之後均呼叫)。

  • 引數: XMLHttpRequest 物件和一個描述請求型別的字串。

  • 這是一個 Ajax 事件。

contentType

  • 型別:String

  • 預設值: "application/x-www-form-urlencoded"。傳送資訊至伺服器時內容編碼型別。

  • 預設值適合大多數情況。如果你明確地傳遞了一個 content-type 給 $.ajax() 那麼它必定會傳送給伺服器(即使沒有資料要傳送)。

context

  • 型別:Object

  • 這個物件用於設定 Ajax 相關回撥函數的上下文。也就是說,讓回撥函數內 this 指向這個物件(如果不設定這個引數,那麼 this 就指向呼叫本次 AJAX 請求時傳遞的 options 引數)。比如指定一個 DOM 元素作為 context 引數,這樣就設定了 success 回撥函數的上下文為這個 DOM 元素。

  • 就像這樣:

$.ajax({ url: "test.html", context: document.body, success: function(){
        $(this).addClass("done");
      }});

data

  • 型別:String

  • 傳送到伺服器的資料。將自動轉換為請求字串格式。GET 請求中將附加在 URL 後。檢視 processData 選項說明以禁止此自動轉換。必須為 Key/Value 格式。如果為陣列,jQuery 將自動為不同值對應同一個名稱。如 {foo:["bar1", "bar2"]} 轉換為 '&foo=bar1&foo=bar2'。

dataFilter

  • 型別:Function

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

dataType

  • 型別:String

  • 預期伺服器返回的資料型別。如果不指定,jQuery 將自動根據 HTTP 包 MIME 資訊來智慧判斷,比如 XML MIME 型別就被識別為 XML。在 1.4 中,JSON 就會生成一個 JavaScript 物件,而 script 則會執行這個指令碼。隨後伺服器端返回的資料會根據這個值解析後,傳遞給回撥函數。可用值:

    • "xml": 返回 XML 檔案,可用 jQuery 處理。

    • "html": 返回純文字 HTML 資訊;包含的 script 標籤會在插入 dom 時執行。

    • "script": 返回純文字 JavaScript 程式碼。不會自動快取結果。除非設定了 "cache" 引數。注意:在遠端請求時(不在同一個域下),所有 POST 請求都將轉為 GET 請求。(因為將使用 DOM 的 script標籤來載入)

    • "json": 返回 JSON 資料 。

    • "jsonp": JSONP 格式。使用 JSONP 形式呼叫函數時,如 "myurl?callback=?" jQuery 將自動替換 ? 為正確的函數名,以執行回撥函數。

    • "text": 返回純文字字串

error

  • 型別:Function

  • 預設值: 自動判斷 (xml 或 html)。請求失敗時呼叫此函數。

  • 有以下三個引數:XMLHttpRequest 物件、錯誤資訊、(可選)捕獲的異常物件。

  • 如果發生了錯誤,錯誤資訊(第二個引數)除了得到 null 之外,還可能是 "timeout", "error", "notmodified" 和 "parsererror"。

  • 這是一個 Ajax 事件。

global

  • 型別:Boolean

  • 是否觸發全域性 AJAX 事件。預設值: true。設定為 false 將不會觸發全域性 AJAX 事件,如 ajaxStart 或 ajaxStop 可用於控制不同的 Ajax 事件。

ifModified

  • 型別:Boolean

  • 僅在伺服器資料改變時獲取新資料。預設值: false。使用 HTTP 包 Last-Modified 頭資訊判斷。在 jQuery 1.4 中,它也會檢查伺服器指定的 'etag' 來確定資料沒有被修改過。

jsonp

  • 型別:String

  • 在一個 jsonp 請求中重寫回撥函數的名字。這個值用來替代在 "callback=?" 這種 GET 或 POST 請求中 URL 引數裡的 "callback" 部分,比如 {jsonp:'onJsonPLoad'} 會導致將 "onJsonPLoad=?" 傳給伺服器。

jsonpCallback

  • 型別:String

  • 為 jsonp 請求指定一個回撥函數名。這個值將用來取代 jQuery 自動生成的隨機函數名。這主要用來讓 jQuery 生成度獨特的函數名,這樣管理請求更容易,也能方便地提供回撥函數和錯誤處理。你也可以在想讓瀏覽器快取 GET 請求的時候,指定這個回撥函數名。

password

  • 型別:String

  • 用於響應 HTTP 存取認證請求的密碼

processData

  • 型別:Boolean

  • 預設值: true。預設情況下,通過data選項傳遞進來的資料,如果是一個物件(技術上講只要不是字串),都會處理轉化成一個查詢字串,以配合預設內容型別 "application/x-www-form-urlencoded"。如果要傳送 DOM 樹資訊或其它不希望轉換的資訊,請設定為 false。

scriptCharset

  • 型別:String

  • 只有當請求時 dataType 為 "jsonp" 或 "script",並且 type 是 "GET" 才會用於強制修改 charset。通常只在本地和遠端的內容編碼不同時使用。

success

  • 型別:Function

  • 請求成功後的回撥函數。

  • 引數:由伺服器返回,並根據 dataType 引數進行處理後的資料;描述狀態的字串。

  • 這是一個 Ajax 事件。

traditional

  • 型別:Boolean

  • 如果你想要用傳統的方式來序列化資料,那麼就設定為 true。請參考工具分類下面的 jQuery.param 方法。

timeout

  • 型別:Number

  • 設定請求超時時間(毫秒)。此設定將覆蓋全域性設定。

type

  • 型別:String

  • 預設值: "GET")。請求方式 ("POST" 或 "GET"), 預設為 "GET"。注意:其它 HTTP 請求方法,如 PUT 和 DELETE 也可以使用,但僅部分瀏覽器支援。

url

  • 型別:String

  • 預設值: 當前頁地址。傳送請求的地址。

username

  • 型別:String

  • 用於響應 HTTP 存取認證請求的使用者名稱。

xhr

  • 型別:Function

  • 需要返回一個 XMLHttpRequest 物件。預設在 IE 下是 ActiveXObject 而其他情況下是 XMLHttpRequest 。用於重寫或者提供一個增強的 XMLHttpRequest 物件。這個引數在 jQuery 1.3 以前不可用。

案例程式碼:

$(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);
                      }
         });
    });
});

【相關教學推薦:AJAX視訊教學

以上就是ajax函數有哪些引數的詳細內容,更多請關注TW511.COM其它相關文章!