uni-app 系列 二 网络请求 从后台API拿数据

官方文档

https://uniapp.dcloud.io/api/request/request

uni.request(OBJECT)
发起网络请求。

在各个小程序平台运行时,网络相关的 API 在使用前需要配置域名白名单。

OBJECT 参数说明

参数名 类型 必填 默认值 说明 平台差异说明
url String 是 开发者服务器接口地址
data Object/String/ArrayBuffer 否 请求的参数 5+App(自定义组件编译模式)不支持ArrayBuffer类型
header Object 否 设置请求的 header,header 中不能设置 Referer。
method String 否 GET 有效值详见下方说明
dataType String 否 json 如果设为 json,会尝试对返回的数据做一次 JSON.parse
responseType String 否 text 设置响应的数据类型。合法值:text、arraybuffer 5+App和支付宝小程序不支持
sslVerify Boolean 否 true 验证 ssl 证书 仅5+App安卓端支持(HBuilderX 2.3.3+)
success Function 否 收到开发者服务成功返回的回调函数
fail Function 否 接口调用失败的回调函数
complete Function 否 接口调用结束的回调函数(调用成功、失败都会执行)
method 有效值

必须大写,有效值在不同平台差异说明不同。

method 5+App H5 微信小程序 支付宝小程序 百度小程序 头条小程序
GET √ √ √ √ √ √
POST √ √ √ √ √ √
PUT √ √ √ x √ √
DELETE √ √ √ x √ x
CONNECT √ √ √ x x x
HEAD √ √ √ x √ x
OPTIONS √ √ √ x √ x
TRACE √ √ √ x x x
success 返回参数说明

参数 类型 说明
data Object/String/ArrayBuffer 开发者服务器返回的数据
statusCode Number 开发者服务器返回的 HTTP 状态码
header Object 开发者服务器返回的 HTTP Response Header
data 数据说明

最终发送给服务器的数据是 String 类型,如果传入的 data 不是 String 类型,会被转换成 String。转换规则如下:

对于 GET 方法,会将数据转换为 query string。例如 { name: ‘name’, age: 18 } 转换后的结果是 name=name&age=18。
对于 POST 方法且 header[‘content-type’] 为 application/json 的数据,会进行 JSON 序列化。
对于 POST 方法且 header[‘content-type’] 为 application/x-www-form-urlencoded 的数据,会将数据转换为 query string。
示例

uni.request({
url: ‘https://www.example.com/request’, //仅为示例,并非真实接口地址。
data: {
text: ‘uni.request’
},
header: {
‘custom-header’: ‘hello’ //自定义请求头信息
},
success: (res) => {
console.log(res.data);
this.text = ‘request success’;
}
});
返回值

如果希望返回一个 requestTask 对象,需要至少传入 success / fail / complete 参数中的一个。例如:

var requestTask = uni.request({
url: ‘https://www.example.com/request’, //仅为示例,并非真实接口地址。
complete: ()=> {}
});
requestTask.abort();
如果没有传入 success / fail / complete 参数,则会返回封装后的 Promise 对象:Promise 封装

通过 requestTask,可中断请求任务。

requestTask 对象的方法列表

方法 参数 说明
abort 中断请求任务
offHeadersReceived 取消监听 HTTP Response Header 事件,仅微信小程序平台支持,文档详情
onHeadersReceived 监听 HTTP Response Header 事件。会比请求完成事件更早,仅微信小程序平台支持,文档详情
示例

const requestTask = uni.request({
url: ‘https://www.example.com/request’, //仅为示例,并非真实接口地址。
data: {
name: ‘name’,
age: 18
},
success: function(res) {
console.log(res.data);
}
});

// 中断请求任务
requestTask.abort();
Tips

请求的 header 中 content-type 默认为 application/json。
网络请求的 超时时间 可以统一在 manifest.json 中配置 networkTimeout。
H5 端本地调试需注意跨域问题,参考:调试跨域问题解决方案
注意由于百度小程序iOS客户端,请求失败时会进入fail回调,需要针对百度增加相应的处理以解决该问题。
注意非 H5 端不支持 cookie,服务器应避免验证 cookie。如果服务器无法修改,也可以使用一些模拟手段,比如这样的工具https://github.com/charleslo1/weapp-cookie
按照 W3C 规范,H5 端无法获取 response header 中 Set-Cookie、Set-Cookie2 这2个字段,对于跨域请求,允许获取的 response header 字段只限于“simple response header”和“Access-Control-Expose-Headers”(详情)
uni-app 插件市场有flyio、axios等三方封装的拦截器可用
低版本手机自身不支持 ipv6,如果服务器仅允许 ipv6,会导致老手机无法正常运行或访问速度非常慢
localhost、127.0.0.1等服务器地址,只能在电脑端运行,手机端连接时不能访问。请使用标准IP并保证手机能连接电脑网络
debug 模式,安卓端暂时无法获取响应头,url中含有非法字符(如未编码为%20的空格)时会请求失败
iOS App第一次安装启动后,会弹出是否允许联网的询问框,在用户点击同意前,调用联网API会失败。请注意判断这种情况。比如官方提供的新闻模板示例(HBuilderX新建项目可选择),会判断如果无法联网,则提供一个错误页,提示用户设置网络及下拉刷新重试。
良好体验的App,还会判断当前是否处于飞行模式(参考)、是wifi还是3G(参考)
部分安卓设备,真机运行或debug模式下的网络,低于release模式很多。
使用一些比较小众的证书机构(如:CFCA OV OCA)签发的 ssl 证书在安卓设备请求会失败,因为这些机构的根证书不在系统内置根证书库,可以更换其他常见机构签发的证书(如:Let’s Encrypt),或者配置 sslVerify 为 false 关闭 ssl 证书验证(不推荐)。
单次网络请求数据量建议控制在50K以下(仅指json数据,不含图片),过多数据应分页获取,以提升应用体验。

测试列子

uni.request({
				    url: 'http://localhost:9081/mixmall/product/showCategory', //仅为示例,并非真实接口地址。
				    data: {
				        text: 'uni.request'
				    },
					dataType:"jsonp",
				    header: {
						 
				        'custom-header': 'hello' //自定义请求头信息
				    },
				    success: (res) => {
				        console.log(res);
				       
				    }
				});

测试页面-成功拿到API数据

在这里插入图片描述

原文链接:加载失败,请重新获取