API – 第 2 页 – 微信小程序开发指南

RequestTaskwx.request(Object object)

以 Promise 风格调用：不支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信、移动解析HttpDNS

功能描述

发起 HTTPS 网络请求。使用前请注意阅读相关说明。

参数

Object object

属性类型默认值必填说明最低版本

url string 是开发者服务器接口地址

data string/object/ArrayBuffer 否请求的参数

header Object 否设置请求的 header，header 中不能设置 Referer。
content-type 默认为 application/json

timeout number 否超时时间，单位为毫秒。默认值为 60000 2.10.0

method string GET 否 HTTP 请求方法

合法值	说明
OPTIONS	HTTP 请求 OPTIONS
GET	HTTP 请求 GET
HEAD	HTTP 请求 HEAD
POST	HTTP 请求 POST
PUT	HTTP 请求 PUT
DELETE	HTTP 请求 DELETE
TRACE	HTTP 请求 TRACE
CONNECT	HTTP 请求 CONNECT

dataType string json 否返回的数据格式。值为 json 时，返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse；其他值则不对返回的内容进行 JSON.parse

responseType string text 否响应的数据类型 1.7.0

合法值	说明
text	响应的数据为文本
arraybuffer	响应的数据为 ArrayBuffer

useHighPerformanceMode boolean true 否使用高性能模式。从基础库 v3.5.0 开始在 Android 端默认开启，其他端暂不生效。该模式下有更优的网络性能表现，更多信息请查看下方说明。 3.3.3

enableHttp2 boolean false 否开启 http2 2.10.4

enableProfile boolean true 否是否开启 profile。iOS 和 Android 端默认开启，其他端暂不支持。开启后可在接口回调的 res.profile 中查看性能调试信息。

enableQuic boolean false 否是否开启 Quic/h3 协议（iOS 微信目前使用 gQUIC-Q43；Android 微信在 v8.0.54 前使用 gQUIC-Q43，v8.0.54 开始使用 IETF QUIC，即 h3 协议；PC微信使用 IETF QUIC，即 h3 协议） 2.10.4

enableCache boolean false 否开启 Http 缓存 2.10.4

enableHttpDNS boolean false 否是否开启 HttpDNS 服务。如开启，需要同时填入 httpDNSServiceId 。 HttpDNS 用法详见移动解析HttpDNS 2.19.1

httpDNSServiceId string 否 HttpDNS 服务商 Id。 HttpDNS 用法详见移动解析HttpDNS 2.19.1

httpDNSTimeout number 10000 否 HttpDNS 超时时间。HttpDNS解析时间超过该值时不再走HttpDNS，本次请求将回退到localDNS。默认为 10000 毫秒。 HttpDNS 用法详见移动解析HttpDNS 3.8.9

enableHttpDNSFallback boolean true 否是否开启 HttpDNS 兜底。开启时，HttpDNS 服务查询失败会回退到 localDNS；关闭时，HttpDNS 服务查询失败将直接报错，不回退到 localDNS。默认为 true。 HttpDNS 用法详见移动解析HttpDNS 3.16.2

enableChunked boolean false 否开启 transfer-encoding chunked。 2.20.2

forceCellularNetwork boolean false 否强制使用蜂窝网络发送请求 2.21.0

redirect string follow 否重定向拦截策略。（目前安卓、iOS、开发者工具已支持，PC端将在后续支持） 3.2.2

合法值	说明
follow	不拦截重定向，即客户端自动处理重定向
manual	拦截重定向。开启后，当 http 状态码为 3xx 时客户端不再自动重定向，而是触发 onHeadersReceived 回调，并结束本次 request 请求。可通过 onHeadersReceived 回调中的 header.Location 获取重定向的 url

success function 否接口调用成功的回调函数

fail function 否接口调用失败的回调函数

complete function 否接口调用结束的回调函数（无论调用成功还是失败都会执行）

object.success 回调函数

参数

Object res

属性类型说明最低版本

data string/Object/Arraybuffer 开发者服务器返回的数据

statusCode number 开发者服务器返回的 HTTP 状态码

header Object 开发者服务器返回的 HTTP Response Header 1.2.0

cookies Array.<string> 开发者服务器返回的 cookies，格式为字符串数组 2.10.0

profile Object 网络请求过程中的一些调试信息，查看详细说明。目前仅 iOS 和 Android 端支持，其他端暂不支持。 2.10.4

结构属性	类型	说明	最低版本
invokeStart	number	调用接口的时间。	3.8.10
httpDNSDomainLookUpStart	number	httpDNS 开始查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅 wx.request 接口支持	3.8.9
httpDNSDomainLookUpEnd	number	httpDNS 完成查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅 wx.request 接口支持	3.8.9
queueStart	number	开始排队的时间。达到并行上限时才需要排队。	3.8.10
queueEnd	number	结束排队的时间。达到并行上限时才需要排队。如果未发生排队，则该字段和 queueStart 字段值相同	3.8.10
redirectStart	number	第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算，否则值为 0
redirectEnd	number	最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算，否则值为 0
fetchStart	number	组件准备好使用 HTTP 请求抓取资源的时间，这发生在检查本地缓存之前
domainLookUpStart	number	Local DNS 域名查询开始的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等
domainLookUpEnd	number	Local DNS 域名查询完成的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等
connectStart	number	HTTP（TCP）开始建立连接的时间，如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接开始的时间
connectEnd	number	HTTP（TCP）完成建立连接的时间（完成握手），如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接完成的时间。注意这里握手结束，包括安全连接建立完成、SOCKS 授权通过
SSLconnectionStart	number	SSL 建立连接的时间，如果不是安全连接，则值为 0
SSLconnectionEnd	number	SSL 建立完成的时间，如果不是安全连接，则值为 0
requestStart	number	HTTP 请求读取真实文档开始的时间（完成建立连接），包括从本地读取缓存。连接错误重连时，这里显示的也是新建立连接的时间
requestEnd	number	HTTP 请求读取真实文档结束的时间
responseStart	number	HTTP 开始接收响应的时间（获取到第一个字节），包括从本地读取缓存
responseEnd	number	HTTP 响应全部接收完成的时间（获取到最后一个字节），包括从本地读取缓存
rtt	number	当次请求连接过程中实时 rtt
estimate_nettype	number	评估的网络状态 unknown, offline, slow 2g, 2g, 3g, 4g, last/0, 1, 2, 3, 4, 5, 6
httpRttEstimate	number	协议层根据多个请求评估当前网络的 rtt（仅供参考）
transportRttEstimate	number	传输层根据多个请求评估的当前网络的 rtt（仅供参考）
downstreamThroughputKbpsEstimate	number	评估当前网络下载的 kbps
throughputKbps	number	当前网络的实际下载 kbps
peerIP	string	当前请求的 IP
port	number	当前请求的端口
socketReused	boolean	是否复用连接
sendBytesCount	number	发送的字节数
receivedBytedCount	number	收到的字节数
protocol	string	使用的协议类型，有效值包括：http1.1、h2、quic、unknown
usingHighPerformanceMode	boolean	是否使用了高性能模式。基础库 v3.3.4 起支持。

exception Object 网络请求过程中的一些异常信息，例如 httpdns 超时等 3.0.0

结构属性类型说明

retryCount number 本次请求底层的重试次数

reasons Array.<Object> 本次请求底层的失败信息，所有失败信息均符合 Errno 错误码

	结构属性	类型	说明
	errMsg	string	错误原因
	errno	string	错误码

useHttpDNS boolean 最终请求是否使用了 HttpDNS 解析的 IP。仅当 enableHttpDNS 传 true 时返回此字段。如果开启 enableHttpDNS 但最终请求未使用 HttpDNS 解析的 IP，可在 exception 中查看原因。 3.4.10

object.fail 回调函数

参数

Object err

属性类型说明最低版本

errMsg String 错误信息

errno Number errno 错误码，错误码的详细说明参考 Errno 错误码 2.24.0

exception Object 网络请求过程中的一些异常信息，例如 httpdns 超时等 3.8.10

结构属性类型说明

retryCount number 本次请求底层的重试次数

reasons Array.<Object> 本次请求底层的失败信息，所有失败信息均符合 Errno 错误码

	结构属性	类型	说明
	errMsg	string	错误原因
	errno	string	错误码

useHttpDNS boolean 最终请求是否使用了 HttpDNS 解析的 IP。仅当 enableHttpDNS 传 true 时返回此字段。如果开启 enableHttpDNS 但最终请求未使用 HttpDNS 解析的 IP，可在 exception 中查看原因。 3.8.10

返回值

RequestTask

基础库 1.4.0 开始支持，低版本需做兼容处理。

请求任务对象

data 参数说明

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

对于 GET 方法的数据，会将数据转换成 query string（encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...）
对于 POST 方法且 header['content-type'] 为 application/json 的数据，会对数据进行 JSON 序列化
对于 POST 方法且 header['content-type'] 为 application/x-www-form-urlencoded 的数据，会将数据转换成 query string（encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...）

useHighPerformanceMode 高性能模式说明

在该模式下，框架将会采用全新的网络请求模块，默认支持 HTTP3，可以提升微信小程序的网络请求性能。有以下注意事项：

除声明了 enableChunked 后会走 HTTP1 以外，均会自动开启 HTTP2/HTTP3 等优化能力，enableQuic、enableHttp2 参数将会强制开启。建议开发者在后台服务也开启对应能力以获得更好的效果。
暂仅支持 Android，iOS/PC 端设置该参数后会使用原 request 模块。iOS 会在后续支持该参数。
暂不支持 HttpDNS 能力。
开启 enableProfile 后，返回的 profile 字段部分信息缺失，会被缺省值代替。缺失部分包括 redirectStart、redirectEnd、rtt、estimate_nettype、httpRttEstimate、transportRttEstimate、downstreamThroughputKbpsEstimate、throughputKbps、peerIP、port。

示例代码

wx.request({
  url: 'example.php', //仅为示例，并非真实的接口地址
  data: {
    x: '',
    y: ''
  },
  header: {
    'content-type': 'application/json' // 默认值
  },
  success (res) {
    console.log(res.data)
  }
})

worklet.runOnUI(function fn)

微信小程序插件：不支持

相关文档: worklet 动画

功能描述

在 UI 线程执行 worklet 函数。

参数

function fn

worklet 类型函数。

返回值

function

runOnUI 为高阶函数，返回一个函数，执行时运行在 UI 线程。

示例代码


function someWorklet(greeting) {
  'worklet';
  console.log('hello', greeting); // print: [ui] hello Skyline
}

wx.worklet.runOnUI(someWorklet)('Skyline')

function worklet.runOnJS(function fn)

微信小程序插件：不支持

相关文档: worklet 动画

功能描述

worklet 函数运行在 UI 线程时，捕获的外部函数可能为 worklet 类型或普通函数，为了更明显的对其区分，要求必须使用 runOnJS 调回 JS 线程的普通函数。有这样的要求是因为，调用其它 worklet 函数时是同步调用，但在 UI 线程执行 JS 线程的函数只能是异步，开发者容易混淆，试图同步获取 JS 线程的返回值。

参数

function fn

未声明为 worklet 类型的普通函数。

返回值

function

runOnJS 为高阶函数，返回一个函数，执行时运行在 JS 线程。

示例代码


 function someFunc(greeting) {
   console.log('hello', greeting);
 }

 function someWorklet() {
   'worklet'
   runOnJS(someFunc)('Skyline')
 }

 wx.worklet.runOnUI(someWorklet)()

AnimationObject worklet.sequence(AnimationObject animationN)

微信小程序插件：不支持

相关文档: worklet 动画

功能描述

组合动画序列，依次执行传入的动画。

参数

AnimationObject animationN

动画对象

返回值

AnimationObject

返回 AnimationObject 类型值，可直接赋值给 SharedValue。

示例代码


const { shared, sequence, timing, spring } = wx.worklet
const offset = shared(0)
offset.value = sequence(timing(100), spring(0))

AnimationObject worklet.repeat(AnimationObject animation, number numberOfReps, boolean reverse, function callback)

微信小程序插件：不支持

相关文档: worklet 动画

功能描述

重复执行动画。

参数

AnimationObject animation

动画对象

number numberOfReps

重复次数。为负值时一直循环，直到被取消动画。

boolean reverse

反向运行动画，每周期结束动画由尾到头运行。该字段仅对 timing 和 spring 返回的动画对象生效。

function callback

动画完成回调。动画被取消时，返回 fasle，正常完成时返回 true。

返回值

AnimationObject

返回 AnimationObject 类型值，可直接赋值给 SharedValue。

示例代码


const { shared, repeat, timing } = wx.worklet
const offset = shared(0)
offset.value = repeat(timing(70), 2, true);

AnimationObject worklet.delay(number delayMS, AnimationObject delayedAnimation)

微信小程序插件：不支持

相关文档: worklet 动画

功能描述

延迟执行动画。

参数

number delayMS

动画开始前等待的时间，单位：毫秒。

AnimationObject delayedAnimation

动画对象。

返回值

AnimationObject

返回 AnimationObject 类型值，可直接赋值给 SharedValue。

示例代码


const { shared, repeat, timing } = wx.worklet
const offset = shared(0)
offset.value = delay(1000, timing(70));

AnimationObject worklet.timing(number toValue, Object options, function callback)

微信小程序插件：不支持

相关文档: worklet 动画

功能描述

基于时间的动画。

参数

number toValue

目标值

Object options

动画配置

属性	类型	默认值	必填	说明
duration	number	300	否	动画时长
easing	function	Easing.inOut(Easing.quad)	否	动画曲线，参考 Easing 模块。

function callback

动画完成回调。动画被取消时，返回 fasle，正常完成时返回 true。

返回值

AnimationObject

返回 AnimationObject 类型值，可直接赋值给 SharedValue。

示例代码


<view id="moved-box"></view>
<view id="btn" bind:tap="tap">点击驱动小球移动</view>



const { shared, timing, Easing } = wx.worklet
Page({
  onLoad() {
    const offset = shared(0)
    this.applyAnimatedStyle('#moved-box', () => {
      'worklet';
      return {
        transform: `translateX(${offset.value}px)`
      }
    })
    this._offset = offset
  }
  tap() {
    const random = Math.random()
    this._offset.value = timing(random, {
        duration: 500,
        easing: Easing.bezier(0.25, 0.1, 0.25, 1),
      }),
    };
})

AnimationObject worklet.spring(number|string toValue, Object options, function callback)

微信小程序插件：不支持

相关文档: worklet 动画

功能描述

基于物理的动画。

参数

number|string toValue

目标值

Object options

动画配置

属性	类型	默认值	必填	说明
damping	number	10	否	阻尼系数
mass	number	1	否	重量系数，值越大移动越慢
stiffness	number	100	否	弹性系数
overshootClamping	boolean	false	否	动画是否可以在指定值上反弹
restDisplacementThreshold	number	0.01	否	弹簧静止时的位移
restSpeedThreshold	number	2	否	弹簧静止的速度
velocity	number	0	否	速度

function callback

动画完成回调。动画被取消时，返回 fasle，正常完成时返回 true。

返回值

AnimationObject

返回 AnimationObject 类型值，可直接赋值给 SharedValue。

示例代码


<pan-gesture-handler onGestureEvent="handlepan">
  <view class="circle"></view>
</pan-gesture-handler>



const { shared, spring } = wx.worklet
Page({
  onLoad() {
    const offset = shared(0);
    this.applyAnimatedStyle(".circle", () => {
      "worklet";
      return {
        transform: `translateX${offset.value}px`,
      };
    });
    this._offset = offset;
  },
  handlepan(evt) {
    "worklet";
    if (evt.state === GestureState.ACTIVE) {
      this._offset.value += evt.deltaX;
    } else if (evt.state === GestureState.END) {
      this._offset.value = spring(0);
    }
  },
});

worklet.Easing

相关文档: worklet 动画

Easing 模块实现了常见的动画缓动函数（动画效果参考 https://easings.net/ ），可从 wx.worklet 对象中读取。

示例代码

在开发者工具中预览效果

预置动画函数

Easing.bounce 反弹动画
Easing.ease 惯性动画
Easing.elastic 弹性动画

标准缓动函数

Easing.linear 线性
Easing.quad 二次方
Easing.cubic 三次方
Easing.poly 实现其它幂函数

其它数学函数

Easing.bezier 三次贝塞尔曲线
Easing.circle 圆形曲线
Easing.sin 正弦函数
Easing.exp 指数函数

缓动方式

以上效果均有三种缓动方式

Easing.in 正向执行缓动函数
Easing.out 反向执行缓动函数
Easing.inOut 前半程正向，后半程反向以 sin 函数为例，其中 Easing.in(Easing.sin) 和直接使用 Easing.sin 效果相同。

Easing.in(Easing.sin) 动画效果参考 https://easings.net/#easeInSine
Easing.out(Easing.sin) 动画效果参考 https://easings.net/#easeOutSine
Easing.inOut(Easing.sin) 动画效果参考 https://easings.net/#easeInOutSine

Easing.bounce

简单的反弹效果，动画效果参考

Easing.bounce(t)

Easing.ease

简单的惯性动画，动画效果参考

Easing.ease(t)

Easing.elastic

简单的弹性动画，类似弹簧来回摆动，高阶函数。默认弹性为 1，会稍微超出一次。弹性为 0 时不会过冲。动画效果参考

Easing.elastic(bounciness = 1)

Easing.linear

线性函数，f(t) = t，动画效果参考

Easing.linear(t)

Easing.quad

二次方函数，f(t) = t * t，动画效果参考

Easing.quad(t)

Easing.cubic

立方函数，f(t) = t * t * t，动画效果参考

Easing.cubic(t)

Easing.poly

高阶函数，返回幂函数

poly(4): 动画效果参考

poly(5): 动画效果参考

Easing.poly(n)

Easing.bezier

三次贝塞尔曲线，效果同 css transition-timing-function

调试参数可借助可视化工具

Easing.bezier(x1, y1, x2, y2)

Easing.circle

圆形曲线，动画效果参考

Easing.circle(t)

Easing.sin

正弦函数，动画效果参考

Easing.sin(t)

Easing.exp

指数函数，动画效果参考

Easing.exp(t)

Easing.in

正向运行 easing function，高阶函数。

Easing.in(easing)

Easing.out

反向运行 easing function，高阶函数。

Easing.out(easing)

Easing.inOut

前半程正向，后半程反向，高阶函数。

Easing.inOut(easing)

AnimationObject worklet.decay(Object options, function callback)

微信小程序插件：不支持

相关文档: worklet 动画

功能描述

基于滚动衰减的动画。

参数

Object options

动画配置

属性	类型	默认值	必填	说明
velocity	number	0	否	初速度
deceleration	number	0.998	否	衰减速率
clamp	Array.`<number>`	[]	否	边界值，长度为 2 的数组

function callback

动画完成回调。动画被取消时，返回 fasle，正常完成时返回 true。

返回值

AnimationObject

返回 AnimationObject 类型值，可直接赋值给 SharedValue。

示例代码

在开发者工具中预览效果

<pan-gesture-handler onGestureEvent="handlepan">
  <view class="circle"></view>
</pan-gesture-handler>

const { shared, decay } = wx.worklet
Page({
  onLoad() {
    this._offset = shared(0);
    this.applyAnimatedStyle('.circle', () => {
      'worklet';
      return {
        transform: `translateX(${this._offset.value}px)`
      };
    });
  },
  handlepan(evt) {
    'worklet';
    if (evt.state === GestureState.ACTIVE) {
      this._offset.value += evt.deltaX;
    } else if (evt.state === GestureState.END) {
      this._offset.value = decay({
         velocity: evt.velocityX,
         clamp: [-200, 200],
        },
        () => {
           'worklet'
           console.info('@@@ decay finish')
        }
      );
    }
  }
});