net

优质

小牛编辑

134浏览

2023-12-01

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

对象：

XMLHttpRequest: 跨域网络请求对象
ProgressEvent: HTTP请求进度事件

回调方法：

XhrStateChangeCallback: 网络请求状态变化的回调函数
XhrProgressEventCallback: 网络请求进度事件的回调函数

权限：

5+功能模块（permissions）


{
// ...
"permissions":{
	// ...
	"XMLHttpRequest": {
		"description": "跨域网络连接"
	}
}
}

XMLHttpRequest

跨域网络请求对象

构造：

XMLHttpRequest(): 创建一个XMLHttpRequest 对象，对象创建时不触发任何时间和网络请求，需和open，send方法配合使用。

属性：

readyState: HTTP 请求的状态
response: 请求从服务器接收到的响应数据
responseText: 请求从服务器接收到的响应数据（字符串数据）
responseType: 请求响应数据response的类型
responseXML: 请求响应的Document对象
status: 服务器返回的状态码
statusText: 服务器返回的状态描述
timeout: 请求服务器的超时时间，单位为毫秒（ms）
withCredentials: 是否支持跨域请求

方法：

abort: 取消当前响应，关闭连接并且结束任何未决的网络活动
getAllResponseHeaders: 获取HTTP响应头部信息
getResponseHeader: 获取指定的HTTP响应头部的值
open: 初始化HTTP/HTTPS请求参数，但是并不发送请求
overrideMimeType: 重写服务器返回的MIME类型
send: 发送HTTP请求
setRequestHeader: 指定一个HTTP请求的Header

事件：

onreadystatechange: 网络请求状态发生变化事件
onloadstart: 网络请求开始事件
onprogress: 网络请求传输数据事件
onabort: 网络请求取消事件
onerror: 网络请求错误事件
onload: 网络请求成功事件
ontimeout: 网络请求超时事件
onloadend: 网络请求结束事件

当XMLHttpRequest 初次创建时，这个属性的值从 0 开始，直到接收到完整的 HTTP 响应，这个值增加到 4。 5 个状态中每一个都有一个相关联的非正式的名称，下表列出了状态、名称和含义： 0 - Uninitialized，未初始化状态。XMLHttpRequest对象已创建或已被abort()方法重置。 1 - Open，open()方法已调用，但是send()方法未调用。请求还没有被发送。 2 - Sent，send()方法已调用，HTTP/HTTPS 请求已发送到服务器，但未接收到响应。 3 - Receiving，所有响应头部都已经接收到，响应体开始接收但未完成。 4 Loaded，HTTP响应已经完全接收。

response

请求从服务器接收到的响应数据

说明：

String 类型只读属性

如果没有从服务器接收到数据，则为null；否则根据responseType类型决定：如果responseType设置为空字符串或"text"，则返回空字符串；如果responseType设置为"document"，则返回Document对象；如果responseType设置为"json"，则返回JSON对象；若服务器返回的数据与设置的responseType类型不区配，则返回null。

responseText

请求从服务器接收到的响应数据（字符串数据）

说明：

String 类型

如果还没有接收到数据的话，此属性值为空字符串；如果readyState小于3，此属性值为空字符串；如果readyState为3，此属性值返回目前已经接收的HTTP响应部分数据值；如果readyState为4，此属性值保存了完整的HTTP响应数据体。如果HTTP请求返回的数据头中包含了Content-Type值中指定字符编码，就使用该编码，否则，使用UTF-8字符集。

responseType

请求响应数据response的类型

说明：

String 类型

默认值为空字符串，即reponse为String，类型可设置："document"表示Document对象，"json"表示JSON对象，"text"表示字符串。此值必须在调用send方法之前设置，否则设置的值不生效，仍使用之前设置的值。

responseXML

请求响应的Document对象

说明：

String 类型

对请求的响应，解析为 XML 并作为 Document 对象返回。如果请求未成功，或响应的数据无法被解析为XML，则返回null。

status

服务器返回的状态码

说明：

Number 类型

服务器返回的HTTP状态代码，如200表示成功，而404表示"Not Found"错误；当readyState小于3的时候此属性值为0。

statusText

服务器返回的状态描述

说明：

String 类型

此属性值用名称而不是数字指定了请求的HTTP的状态代码。也就是说，当状态为200的时候它是"OK"；当状态为404的时候它是"Not Found"。和status属性类似，当readyState小于3的时候此属性值为空字符串。

timeout

请求服务器的超时时间，单位为毫秒（ms）

说明：

Number 类型

数值类型，单位为ms，其默认值为120秒。超时时间为服务器响应请求的时间（不是Http请求完成的总时间），如果设置为0则表示永远不超时。必须在请求发起前设置，否则当前请求将不生效，在当前请求完成后重新发起新请求时生效。

withCredentials

是否支持跨域请求

说明：

Boolean 类型只读属性

此对象创建的HTTP请求都支持跨域，所以永远返回true。

abort

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


void xhr.abort();

说明：

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

参数：

无

返回值：

void : 无

示例：


<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8"/>
		<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
		<meta name="HandheldFriendly" content="true"/>
		<meta name="MobileOptimized" content="320"/>
		<title>XMLHttpRequest</title>
		<script type="text/javascript">
var xhr=null;
function testXHR(){
	if(xhr){
		return;
	}
	xhr=new plus.net.XMLHttpRequest();
	xhr.onreadystatechange=function(){
		console.log("onreadystatechange: "+xhr.readyState);
	}
	xhr.open( "GET", "http://www.dcloud.io/" );
	xhr.send();
}
function abortXHR(){
	if(xhr){
		xhr.abort();
		xhr=null;
	}
}
		</script>
	</head>
	<body>
		<button onclick="testXHR()">XMLHttpRequest</button><br/>
		<button onclick="abortXHR()">Abort</button>
	</body>
</html>

net

对象：

回调方法：

权限：

构造：

属性：

方法：

事件：

参数：

返回值：

示例：

说明：

说明：

说明：

说明：

说明：

说明：

说明：

说明：

说明：

说明：

参数：

返回值：

示例：

说明：

参数：

返回值：

示例：

说明：

参数：

返回值：

示例：

说明：

参数：

返回值：

示例：

说明：

参数：

返回值：

示例：

说明：

参数：

返回值：

示例：

说明：

参数：

返回值：

平台支持：

示例：

说明：

示例：

说明：

示例：

说明：

示例：

说明：

示例：

说明：

示例：

说明：

示例：

说明：

示例：

说明：

示例：

属性：

参数：

返回值：

示例：

参数：

返回值：

示例：