uni.request(param)

发起网络请求。

Parameters

name	type	required	default	description
param	RequestOptions<T>	YES	-	网络请求参数

RequestOptions<T> Values

name	type	optinal	default	description
url	string	YES	-	开发者服务器接口地址
data	any	NO	null	请求的参数 UTSJSONObject|string类型
header	UTSJSONObject	NO	null	设置请求的 header，header 中不能设置 Referer
method	"GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS"	NO	"GET"	请求方法 如果设置的值不在取值范围内，会以GET方法进行请求。
timeout	number	NO	60000	超时时间，单位 ms
dataType	string	NO	"json"	如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse
responseType	string	NO	-	设置响应的数据类型。
sslVerify	boolean	NO	-	验证 ssl 证书
firstIpv4	boolean	NO	false	DNS解析时优先使用ipv4
success	(option: RequestSuccess<T>) => void	NO	null	网络请求成功回调。
fail	(option: RequestFail) => void	NO	null	网络请求失败回调。
complete	(option: any) => void	NO	null	网络请求完成回调，成功或者失败都会调用。

RequestSuccess<T> Values

name	type	optinal	default	description
data	any	NO	-	开发者服务器返回的数据
statusCode	number	YES	-	开发者服务器返回的 HTTP 状态码
header	any	YES	-	开发者服务器返回的 HTTP Response Header
cookies	Array<string>	YES	-	开发者服务器返回的 cookies，格式为字符串数组

RequestFail Values

name	type	optinal	default	description
errCode	5 | 1000 | 100001 | 100002 | 600003 | 600009 | 602001	YES	-	错误码 - 5 接口超时 - 1000 服务端系统错误 - 100001 json数据解析错误 - 100002 错误信息json解析失败 - 600003 网络中断 - 600009 URL格式不合法 - 602001 request系统错误
errSubject	string	YES	-	统一错误主题（模块）名称
data	any	NO	-	错误信息中包含的数据
errMsg	string	YES	-	-

Return value

Type	optinal
RequestTask	NO

RequestTask Values

name	type	optinal	default	description
abort	() => void	YES	-	中断网络请求。

RequestTask Compatibility

	Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
abort	4.4	√	3.9+	9.0	√	3.9+

request Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4	√	3.9+	9.0	√	3.9+

See also

request

Related Bug

Example

hello uni-app x

<template>
 <view style="flex: 1;">
   <view class="uni-padding-wrap uni-common-mt">
     <view class="uni-common-mt" style="border-width: 2rpx;border-style: solid; border-radius: 4rpx;">
       <textarea :value="res" class="uni-textarea"></textarea>
     </view>
     <view>
       <text>地址 : {{ host + url}}</text>
       <text>请求方式 : {{method}}</text>
     </view>
     <view class="uni-btn-v uni-common-mt">
       <button type="primary" @click="sendRequest">发起请求</button>
     </view>
   </view>
   <scroll-view style="flex: 1;" show-scrollbar="true">
     <view style="padding: 20rpx;">
       <text>设置请求方式</text>
       <view class="uni-common-pb"></view>
       <view style="flex-direction: row;flex-wrap: wrap;">
         <button style="padding: 5rpx; margin-right: 10rpx;" type="primary" size="mini"
           @click="changeMethod('GET')">GET</button>
         <button style="padding: 5rpx; margin-right: 10rpx; " type="primary" size="mini"
           @click="changeMethod('POST')">POST</button>
         <button style="padding: 5rpx; margin-right: 10rpx; " type="primary" size="mini"
           @click="changeMethod('PUT')">PUT</button>
         <button style="padding: 5rpx; margin-right: 10rpx;" type="primary" size="mini"
           @click="changeMethod('DELETE')">DELETE</button>
         <button style="padding: 5rpx; margin-right: 10rpx; " type="primary" size="mini"
           @click="changeMethod('PATCH')">PATCH</button>
         <button style="padding: 5rpx;margin-right: 10rpx;" type="primary" size="mini"
           @click="changeMethod('OPTIONS')">OPTIONS</button>
         <button style="padding: 5rpx;" type="primary" size="mini" @click="changeMethod('HEAD')">HEAD</button>
       </view>
     </view>
     <view style="padding: 20rpx;">
       <text>请求返回错误码的接口（默认为GET）</text>
       <view class="uni-common-pb"></view>
       <view style="flex-direction: row;flex-wrap: wrap;">
         <button style="padding: 5rpx;" type="primary" size="mini" v-for="(item, index) in errorCodeUrls" :key="index"
           @click="changeUrl(item)">{{item}}</button>
       </view>
     </view>
     <view style="padding: 20rpx;">
       <text>请求不同header的接口（默认为GET）</text>
       <view class="uni-common-pb"></view>
       <view style="flex-direction: row;flex-wrap: wrap;">
         <button style="padding: 5rpx;" type="primary" size="mini" v-for="(item, index) in headerUrls" :key="index"
           @click="changeUrl(item)">{{item}}</button>
       </view>
     </view>
     <view style="padding: 20rpx;">
       <text>请求不同content-type的接口（默认为GET）</text>
       <view class="uni-common-pb"></view>
       <view style="flex-direction: row;flex-wrap: wrap;">
         <button style="padding: 5rpx;" type="primary" size="mini" v-for="(item, index) in contentTypeUrls"
           :key="index" @click="changeUrl(item)">{{item}}</button>
       </view>
     </view>

     <view style="padding: 20rpx;">
       <text>POST请求(有body)</text>
       <view class="uni-common-pb"></view>
       <view style="flex-direction: row;flex-wrap: wrap;">
         <button style="padding: 5rpx;" type="primary" size="mini" v-for="(item, index) in postUrls" :key="index"
           @click="changeUrlFromPost(item)">{{item}}</button>
       </view>
     </view>
   </scroll-view>
 </view>
</template>
<script>
 const duration = 2000
 const methodMap = {
   "GET": "/api/http/method/get",
   "POST": "/api/http/method/post",
   "PUT": "/api/http/method/put",
   "DELETE": "/api/http/method/delete",
   "PATCH": "/api/http/method/patch",
   "OPTIONS": "/api/http/method/options",
   "HEAD": "/api/http/method/head"
 }


 export default {
   data() {
     return {
       title: 'request',
       res: '',
       task: null as RequestTask | null,
       host: "http://request.dcloud.net.cn",
       url: "/api/http/method/get",
       method: "GET" as RequestMethod | null,
       data: null as any | null,
       header: null as UTSJSONObject | null,
       errorCodeUrls: [
         "/api/http/statusCode/200",
         "/api/http/statusCode/204",
         "/api/http/statusCode/301",
         "/api/http/statusCode/302",
         "/api/http/statusCode/307",
         "/api/http/statusCode/400",
         "/api/http/statusCode/401",
         "/api/http/statusCode/403",
         "/api/http/statusCode/404",
         "/api/http/statusCode/405",
         "/api/http/statusCode/500",
         "/api/http/statusCode/502",
         "/api/http/statusCode/503",
         "/api/http/statusCode/504",
       ],
       headerUrls: [
         "/api/http/header/ua",
         "/api/http/header/referer",
         "/api/http/header/requestCookie",
         "/api/http/header/setCookie",
         "/api/http/header/deleteCookie"
       ],
       contentTypeUrls: [
         "/api/http/contentType/text/plain",
         "/api/http/contentType/text/html",
         "/api/http/contentType/text/xml",
         "/api/http/contentType/image/gif",
         "/api/http/contentType/image/jpeg",
         "/api/http/contentType/image/png",
         "/api/http/contentType/application/json",
         "/api/http/contentType/application/octetStream",
       ],
       postUrls: [
         "/api/http/contentType/json",
         "/api/http/contentType/xWwwFormUrlencoded",
       ],
       //自动化测试例专用
       jest_result: false
     }
   },
   onLoad() {
   },
   onUnload() {
     uni.hideLoading();
     this.task?.abort();
   },
   methods: {
     changeMethod(e : RequestMethod) {
       this.method = e;
       this.url = methodMap[e] as string;
       this.data = null;
       this.header = null;
     },
     changeUrl(e : string) {
       this.method = "GET";
       this.url = e;
       this.data = null;
       this.header = null;
     },
     changeUrlFromPost(e : string) {
       this.method = "POST";
       this.url = e;
       switch (e) {
         case "/api/http/contentType/json":
           this.header = {
             "Content-Type": "application/json"
           };
           this.data = {
             "hello": "world"
           };
           break;
         case "/api/http/contentType/xWwwFormUrlencoded":
           this.header = {
             "Content-Type": "application/x-www-form-urlencoded"
           };
           this.data = "hello=world";
           break;
       }
     },
     sendRequest() {
       uni.showLoading({
         title: "请求中..."
       })
       this.task = uni.request({
         url: this.host + this.url,
         // dataType: "json",
         // responseType: "json",
         method: this.method,
         data: this.data,
         header: this.header,
         timeout: 6000,
         sslVerify: false,
         withCredentials: false,
         firstIpv4: false,
         success: (res) => {
           console.log('request success', JSON.stringify(res.data))
           uni.showToast({
             title: '请求成功',
             icon: 'success',
             mask: true,
             duration: duration
           });
           this.res = '请求结果 : ' + JSON.stringify(res);
         },
         fail: (err) => {
           console.log('request fail', err);
           uni.showModal({
             content: err.errMsg,
             showCancel: false
           });
         },
         complete: () => {
           uni.hideLoading()
         },
       });
     },
     //自动化测试例专用
     jest_request() {
       uni.request({
         url: this.host + this.url,
         // dataType: "json",
         // responseType: "json",
         method: this.method,
         data: this.data,
         header: this.header,
         timeout: 6000,
         sslVerify: false,
         withCredentials: false,
         firstIpv4: false,
         success: () => {
           this.jest_result = true;
         },
         fail: () => {
           this.jest_result = false;
         },
       });
     }
   }
 }
</script>

注意事项

• request 接口内部通过特殊方式读取了泛型类型，不支持传入动态的泛型：比如将外层方法的普通泛型参数传入 request。
• 如果使用泛型先创建RequestOptions实例，再传入uni.request()，此时请务必确保request要显式指定泛型，例：

  const options: RequestOptions<Person> = ...
  uni.request<Person>(options)
  

General type

GeneralCallbackResult

name	type	optinal	default	description
errMsg	string	YES	-	错误信息