jQuery.get()

类别: Ajax > 简写方法

jQuery.get( url [, data ] [, success ] [, dataType ] )返回值: jqXHR

描述: 使用 HTTP GET 请求从服务器加载数据。

这是一个简化的 Ajax 函数，等同于

1
2
3
4
5
6
 
$.ajax({
  url: url,
  data: data,
  success: success,
  dataType: dataType
});

success 回调函数将传递返回的数据，该数据将是 XML 根元素、文本字符串、JavaScript 文件或 JSON 对象，具体取决于响应的 MIME 类型。它还将传递响应的文本状态。

从 jQuery 1.5 开始，success 回调函数还将传递一个 "jqXHR" 对象（在 jQuery 1.4 中，它传递的是 XMLHttpRequest 对象）。但是，由于 JSONP 和跨域 GET 请求不使用 XHR，因此在这些情况下，传递给成功回调的 jqXHR 和 textStatus 参数将是未定义的。

大多数实现将指定一个成功处理程序

1
2
3
4
 
$.get( "ajax/test.html", function( data ) {
  $( ".result" ).html( data );
  alert( "Load was performed." );
});

此示例获取请求的 HTML 代码片段并将其插入页面。

jqXHR 对象

从 jQuery 1.5 开始，所有 jQuery 的 Ajax 方法都返回 XMLHTTPRequest 对象的超集。此 jQuery XHR 对象（或“jqXHR”）由 $.get() 返回，它实现了 Promise 接口，使其具有 Promise 的所有属性、方法和行为（有关更多信息，请参见 Deferred 对象）。jqXHR.done()（用于成功）、jqXHR.fail()（用于错误）和 jqXHR.always()（用于完成，无论成功还是错误；在 jQuery 1.6 中添加）方法接受一个函数参数，该参数在请求终止时被调用。有关此函数接收的参数的信息，请参见 $.ajax() 文档的 jqXHR 对象 部分。

Promise 接口还允许 jQuery 的 Ajax 方法（包括 $.get()）在一个请求上链接多个 .done()、.fail() 和 .always() 回调，甚至可以在请求可能已完成之后分配这些回调。如果请求已完成，则立即触发回调。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
// Assign handlers immediately after making the request,
// and remember the jqxhr object for this request
var jqxhr = $.get( "example.php", function() {
  alert( "success" );
})
  .done(function() {
    alert( "second success" );
  })
  .fail(function() {
    alert( "error" );
  })
  .always(function() {
    alert( "finished" );
  });
 
// Perform other work here ...
 
// Set another completion function for the request above
jqxhr.always(function() {
  alert( "second finished" );
});

弃用通知

jqXHR.success()、jqXHR.error() 和 jqXHR.complete() 回调方法从 jQuery 3.0 开始被移除。您可以使用 jqXHR.done()、jqXHR.fail() 和 jqXHR.always() 代替。

其他说明

  • 由于浏览器安全限制，大多数“Ajax”请求都受 同源策略 的约束；请求无法成功从不同的域、子域、端口或协议检索数据。
  • 如果使用 jQuery.get() 的请求返回错误代码，除非脚本也调用了全局 ajaxError 事件，否则它将静默失败。或者，从 jQuery 1.5 开始，也可以使用 jQuery.get() 返回的 jqXHR 对象的 .error() 方法进行错误处理。
  • 脚本和 JSONP 请求不受同源策略限制。

示例

请求 test.php 页面，但忽略返回结果。

1
 
$.get( "test.php" );

请求 test.php 页面并发送一些附加数据（同时仍然忽略返回结果）。

1
 
$.get( "test.php", { name: "John", time: "2pm" } );

将数据数组传递给服务器（同时仍然忽略返回结果）。

1
 
$.get( "test.php", { "choices[]": ["Jon", "Susan"] } );

提醒请求 test.php 的结果（HTML 或 XML，取决于返回的内容）。

1
2
3
 
$.get( "test.php", function( data ) {
  alert( "Data Loaded: " + data );
});

提醒请求 test.cgi 以及附加数据负载的结果（HTML 或 XML，取决于返回的内容）。

1
2
3
4
 
$.get( "test.cgi", { name: "John", time: "2pm" } )
  .done(function( data ) {
    alert( "Data Loaded: " + data );
  });

获取 test.php 页面内容，该内容已以 json 格式返回（<?php echo json_encode( array( "name"=>"John","time"=>"2pm" ) ); ?>），并将其添加到页面中。

1
2
3
4
5
 
$.get( "test.php", function( data ) {
  $( "body" )
    .append( "Name: " + data.name ) // John
    .append( "Time: " + data.time ); //  2pm
}, "json" );

获取同一域上的另一个页面。在控制台中输出返回的数据和返回的数据类型。

1
2
3
4
5
6
 
// If this was sent on https://api.jqueryjs.cn/jQuery.get/ you will
// get the response result of https://api.jqueryjs.cn/jQuery.ajax/
$.get( "/jQuery.ajax/", function( data ) {
  console.log( typeof data ); // string
  console.log( data ); // HTML content of the jQuery.ajax page
});