已定稿
感谢DCloud等1人做出了贡献
常见问题 我要提意见 赞(56)

XMLHttpRequest

XMLHttpRequest模块管理网络请求,与标准HTML中的XMLHttpRequest用途一致,差别在于前者可以进行跨域访问。通过plus.net可获取网络请求管理对象。

对象:

回调方法:

XMLHttpRequest

跨域网络请求对象

说明:

跨域网络请求对象

方法:

事件:

属性:

abort

取消当前响应,关闭连接并且结束任何未决的网络活动

void abort();

说明:

这个方法把XMLHttpRequest对象重置为readyState为0的状态,并且取消所有未决的网络活动。 例如,如果请求用了太长时间,而且响应不再必要的时候,可以调用这个方法。

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="UTF-8"/>
		<script type="text/javascript">
var xhr=null;
function testXHR(){
	if(xhr){
		return;
	}
	xhr=new plus.net.XMLHttpRequest();
	xhr.onreadystatechange=xhrStatechange;
	xhr.open( "GET", "http://www.baidu.com/" );
	xhr.send();
}
function xhrStatechange(){
	switch( xhr.readyState ) {
		case 0:
			console.log( "xhr请求已初始化" );
		break;
		case 1:
			console.log( "xhr请求已打开" );
		break;
		case 2:
			console.log( "xhr请求已发送" );
		break;
		case 3:
			console.log( "xhr请求已响应");
			break;
		case 4:
			if ( xhr.status == 200 ) {
				console.log( "xhr请求成功:"+xhr.responseText );
			} else {
				console.log( "xhr请求失败:"+xhr.readyState );
			}
			break;
		default :
			break;
	}
}
function abortXHR(){
	if(xhr){
		xhr.abort();
		xhr=null;
	}
}
		</script>
	</head>
	<body>
		<button onclick="testXHR()">Test XMLHttpRequest</button><br/>
		<button onclick="abortXHR()">Abort XMLHttpRequest</button>
	</body>
</html>

getAllResponseHeaders

获取HTTP响应头部信息

说明:

把HTTP响应头部作为未解析的字符串返回。 如果readyState小于3,这个方法返回null。 否则,它返回服务器发送的所有 HTTP 响应的头部。头部作为单个的字符串返回,一行一个头部。每行用换行符"rn"隔开。

返回值:

HTTP 响应头

getResponseHeader

获取指定的HTTP响应头部的值

void getResponseHeader( headerName );

说明:

其参数是要返回的 HTTP 响应头部的名称。可以使用任何大小写来制定这个头部名字,和响应头部的比较是不区分大小写的。 该方法的返回值是指定的 HTTP 响应头部的值,如果没有接收到这个头部或者readyState小于3则为空字符串。 如果接收到多个有指定名称的头部,这个头部的值被连接起来并返回,使用逗号和空格分隔开各个头部的值。

参数:

返回值:

HTTP响应头数据值

open

初始化HTTP请求参数,例如URL和HTTP方法,但是并不发送请求

void open( method, url, username, password );

说明:

这个方法初始化请求参数以供 send() 方法稍后使用。它把readyState设置为1,删除之前指定的所有请求头部,以及之前接收的所有响应头部,并且把responseText、responseXML、status 以及 statusText 参数设置为它们的默认值。 当readyState为0的时候(当XMLHttpRequest对象刚创建或者abort()方法调用后)以及当readyState为4时(已经接收响应时),调用这个方法是安全的。 当针对任何其他状态调用的时候,open()方法的行为是为指定的。 除了保存供send()方法使用的请求参数,以及重置 XMLHttpRequest 对象以便复用,open()方法没有其他的行为。 要特别注意,当这个方法调用的时候,实现通常不会打开一个到Web服务器的网络连接。

参数:

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="UTF-8"/>
		<script type="text/javascript">
var xhr=null;
function testXHR(){
	if(xhr){
		return;
	}
	xhr=new plus.net.XMLHttpRequest();
	xhr.onreadystatechange=xhrStatechange;
	xhr.open( "GET", "http://www.baidu.com/" );
	xhr.send();
}
function xhrStatechange(){
	switch( xhr.readyState ) {
		case 0:
			console.log( "xhr请求已初始化" );
		break;
		case 1:
			console.log( "xhr请求已打开" );
		break;
		case 2:
			console.log( "xhr请求已发送" );
		break;
		case 3:
			console.log( "xhr请求已响应");
			break;
		case 4:
			if ( xhr.status == 200 ) {
				console.log( "xhr请求成功:"+xhr.responseText );
			} else {
				console.log( "xhr请求失败:"+xhr.readyState );
			}
			break;
		default :
			break;
	}
}
		</script>
	</head>
	<body>
		<button onclick="testXHR()">Test XMLHttpRequest</button>
	</body>
</html>

send

发送一个HTTP请求

void send( body );

说明:

这个方法导致一个 HTTP 请求发送。如果之前没有调用 open(),或者更具体地说,如果 readyState 不是 1,send() 抛出一个异常。否则,它发送一个 HTTP 请求,该请求由以下几部分组成: 之前调用 open() 时指定的 HTTP 方法、URL 以及认证资格(如果有的话)。 之前调用 setRequestHeader() 时指定的请求头部(如果有的话)。 传递给这个方法的 body 参数。 一旦请求发布了,send() 把 readyState 设置为 2,并触发 onreadystatechange 事件句柄。 如果服务器响应带有一个 HTTP 重定向,send() 方法或后台线程自动遵从重定向。当所有的 HTTP 响应头部已经接收,send() 或后台线程把 readyState 设置为 3 并触发 onreadystatechange 事件句柄。如果响应较长,send() 或后台线程可能在状态 3 中触发 onreadystatechange 事件句柄。最后,当响应完成,send() 或后台线程把 readyState 设置为 4,并最后一次触发事件句柄。

参数:

返回值:

setRequestHeader

指定一个HTTP请求的Header

void setRequestHeader( headerName, headerValue );

说明:

这个Http Header应该包含在通过后续send()调用而发起的请求中。这个方法只有当readyState为1的时候才能调用,例如,在调用了open()之后,但在调用send()之前。 如果带有指定名称的头部已经被指定了,这个头部的新值就是:之前指定的值,加上逗号、以及这个调用指定的值(形成一个数组)。 如果open()调用指定了认证资格,XMLHttpRequest 自动发送一个适当的 Authorization 请求头部。但是,你可以使用setRequestHeader()来添加这个头部。类似地,如果Web服务器已经保存了和传递给open()的URL相关联的cookie,适当的Cookie或Cookie2头部也自动地包含到请求中。可以通过调用setRequestHeader()来把这些cookie添加到头部。XMLHttpRequest也可以为User-Agent头部提供一个默认值。如果它这么做,你为该头部指定的任何值都会添加到这个默认值后面。

参数:

返回值:

onreadystatechange

网络请求状态发生变化事件

xhr.onreadystatechange = function(){
	// 判断xhr状态
};

说明:

网络请求状态发生变化时触发,通常在函数中判断对象的state属性值来获取当前请求的状态。

XhrStateChangeCallback

网络请求状态变化的回调函数

void onSuccess() {
	// State changed code.
}

说明:

网络请求状态变化的回调函数

参数: