uni.request(OBJECT)
发起网络请求。
OBJECT 参数说明
参数名 | 类型 | 必填 | 默认值 | 说明 | 平台差异说明 |
---|---|---|---|---|---|
url | String | 是 | 开发者服务器接口地址 | ||
data | Object/String/ArrayBuffer | 否 | 请求的参数 | App(自定义组件编译模式)不支持ArrayBuffer类型 | |
header | Object | 否 | 设置请求的 header,header 中不能设置 Referer。 | H5端会自动带上cookie不可手动覆盖 | |
method | String | 否 | GET | 有效值详见下方说明 | |
timeout | Number | 否 | 30000 | 超时时间,单位 ms | 微信小程序(2.10.0)、支付宝小程序 |
dataType | String | 否 | json | 如果设为 json,会尝试对返回的数据做一次 JSON.parse | |
responseType | String | 否 | text | 设置响应的数据类型。合法值:text、arraybuffer | App和支付宝小程序不支持 |
sslVerify | Boolean | 否 | true | 验证 ssl 证书 | 仅App安卓端支持(HBuilderX 2.3.3+) |
withCredentials | Boolean | 否 | false | 跨域请求时是否携带凭证(cookies) | 仅H5支持(HBuilderX 2.6.15+) |
firstIpv4 | Boolean | 否 | false | DNS解析时优先使用ipv4 | 仅 App-Android 支持 (HBuilderX 2.8.0+) |
success | Function | 否 | 收到开发者服务器成功返回的回调函数 | ||
fail | Function | 否 | 接口调用失败的回调函数 | ||
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
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‘; } });
config: { baseUrl: "https://www.baidu.com/", header: { ‘Content-Type‘: ‘application/json;charset=UTF-8‘, ‘Content-Type‘: ‘application/x-www-form-urlencoded‘, }, data: {}, method: "GET", dataType: "json", /* 如设为json,会对返回的数据做一次 JSON.parse */ responseType: "text", success() {}, fail() {}, complete() {} },