跳到主要内容
版本:3.x

生命周期 API

生命周期监听,这里会在对应生命周期事件执行完成后,下次渲染前执行,说白了就是一个"after lifecycle"的钩子

AppLifecycle

APP 生命周期

对应生命周期的说明可以参考官网:传送门

onLaunch

监听 onLaunch 生命周期执行回调

function onLaunch(): Promise<void>

用法:

// 等待onLaunch响应完成
await testUtils.AppLifecycle.onLaunch()

onShow

程序启动,或切前台时触发

监听 onShow / componentDidShow 生命周期执行回调

function onShow(): Promise<void>

用法:

// 等待onShow响应完成
await testUtils.AppLifecycle.onShow()

onHide

程序切后台时触发

监听 onHide / componentDidHide 生命周期执行回调

function onHide(): Promise<void>

用法:

// 等待onHide响应完成
await testUtils.AppLifecycle.onHide()

onError

小程序发生脚本错误或 API 调用报错时触发。

function onError(): Promise<Error>

用法:

// 等待onError响应完成
await testUtils.AppLifecycle.onError()

onPageNotFound

程序要打开的页面不存在时触发。

function onPageNotFound(): Promise<{ path: string; query: object; isEntryPage: boolean }>

回调参数:

属性类型说明
pathstring不存在页面的路径
queryObject打开不存在页面的 query 参数
isEntryPageboolean是否本次启动的首个页面(例如从分享等入口进来,首个页面是开发者配置的分享页面)

用法:

// 等待onPageNotFound响应完成
await testUtils.AppLifecycle.onPageNotFound()

onUnhandledRejection

小程序有未处理的 Promise 拒绝时触发。

function onUnhandledRejection(): Promise<{ reason: string; promise: Promise<unknown> }>

回调参数: <<<<<<< HEAD

属性类型说明
reasonstring拒绝原因,一般是一个 Error 对象
promisePromise被拒绝的 Promise 对象

======= | 属性 | 类型 | 说明 | | ------- | ------- | ------------------------------- | | reason | string | 拒绝原因,一般是一个 Error 对象 | | promise | Promise | 被拒绝的 Promise 对象 |

master

用法:

// 等待onUnhandledRejection响应完成
await testUtils.AppLifecycle.onUnhandledRejection()

PageLifecycle

Page 生命周期

页面级别的生命周期使用方式与AppLifecycle类似,除了用于监听的onXXX外,页面级别的生命周期 api 还提供了triggerXXX用于模拟触发一些特定的生命周期。 比如onReachBottom,需要触发它的条件需要监听用户上拉触底的事件,我们写事件去模拟比较麻烦,所以我们干脆提供了triggerReachBottom给用户在测试时可直接触发到onReachBottom这个生命周期。

对应生命周期的说明可以参考官网:传送门

用法:

// 等待pages/index/index这个路由页面展示
await testUtils.PageLifecycle.onShow('pages/index/index')
// 手动触发onReachBottom事件
testUtils.PageLifecycle.triggerReachBottom()
// 等待onReachBottom响应完成
await testUtils.PageLifecycle.onReachBottom()
方法说明
onLoad(path: string)在此生命周期中通过访问 options 参数或调用 getCurrentInstance().router,可以访问到页面路由参数。
onUnload(path: string)在小程序环境中对应页面的 onUnload。
onShow(path: string)页面显示/切入前台时触发。
onHide(path: string)页面隐藏/切入后台时触发。
onReady(path: string)从此生命周期开始可以使用 createCanvasContext 或 createSelectorQuery 等 API 访问小程序渲染层的 DOM 节点。
onPullDownRefresh(path: string)监听用户下拉动作
triggerPullDownRefresh(path: string)触发onPullDownRefresh生命周期
onReachBottom(path: string)监听用户上拉触底事件
triggerReachBottom(path: string)触发onReachBottom生命周期
onPageScroll(path: string)监听用户滑动页面事件
triggerPageScroll(path: string, opt: PageScrollObject)触发onPageScroll生命周期
onAddToFavorites(path: string)监听用户点击右上角菜单“收藏”按钮的行为,并自定义收藏内容
triggerAddToFavorites(path: string)触发onAddToFavorites生命周期
onShareAppMessage(path: string)监听用户点击页面内转发按钮(Button 组件 openType='share')或右上角菜单“转发”按钮的行为,并自定义转发内容
triggerShareAppMessage(path: string, opt: ShareAppMessageObject)触发onShareAppMessage生命周期
onShareTimeline(path: string)监听右上角菜单“分享到朋友圈”按钮的行为,并自定义分享内容
triggerShareTimeline(path: string)触发onShareTimeline生命周期
onResize(path: string)监听屏幕旋转时
triggerResize(path: string, opt: PageResizeObject)触发onResize生命周期
onTabItemTap(path: string)点击 tab 时触发
triggerTabItemTap(path: string, opt: TabItemTapObject)触发onTabItemTap生命周期
onSaveExitState(path: string)每当小程序可能被销毁之前,页面回调函数 onSaveExitState 会被调用,可以进行退出状态的保存
triggerSaveExitState(path: string)触发onSaveExitState生命周期
onTitleClick(path: string)点击标题触发
triggerTitleClick(path: string)触发onTitleClick生命周期
onOptionMenuClick(path: string)点击导航栏额外图标触发
triggerOptionMenuClick(path: string)触发onOptionMenuClick生命周期
onPopMenuClick(path: string)
triggerPopMenuClick(path: string)触发onPopMenuClick生命周期
onPullIntercept(path: string)下拉截断时 onPullIntercept 触发
triggerPullIntercept(path: string)触发onPageScroll生命周期