codecamp

uni-app 生命周期

生命周期

应用生命周期

uni-app 支持如下应用生命周期函数:

函数名 说明
onLaunch uni-app初始化完成时触发(局部只触发一次)
onOpen uni-app启动,或从后台进入前台显示
onHide uni-app从前台进入后台
onError uni-app报错时触发
onUniNViewMessage nvue页面发送的数据进行监听,可参考 nvue 向 vue 通讯
onUnhandledRejection 对未处理的 Promise 拒绝事件监听函数(2.8.1+)
onPageNotFound 页面不存在监听函数
onThemeChange 监听系统主题变化

注意

  • 应用生命周期仅可在 App.vue 中监听,在其他页面监听无效。
  • onlaunch 里进行页面调整,如遇白屏报错,请参考 https://ask.dcloud.net.cn/article/35942

示例代码

<script>
    // 只能在App.vue里监听应用的生命周期
    export default {
        onLaunch: function() {
            console.log('App Launch')
        },
        onShow: function() {
            console.log('App Show')
        },
        onHide: function() {
            console.log('App Hide')
        }
    }
</script>

页面生命周期

uni-app 支持如下页面生命周期函数:

函数名 说明 平台差异说明 最低版本
onInit 监听页面初始化,其参数通onLoad参数,为上个页面传递的数据,参数类型为Object(用于页面传参),触发时机早于onLoad 百度小程序 3.1.0+
负载 监听页面加载,其参数为上个页面传递的数据,参数类型为 Object(用于页面传参),参考示例

展出 监听页面显示。页面每次出现在屏幕上都触发,包括从下级页面点返回进入当前页面
onReady 监听页面初次渲染完成。注意如果渲染速度快,会在页面进入动画完成前触发
隐藏 监听页面隐藏
onUnload 监听页面卸载
onResize 监听窗口尺寸变化 App,微信小程序
onPullDownRefresh 监听用户拖动动作,一般用于拖动刷新,参考示例
onReachBottom 页面上拉触底事件的处理函数
onTabItemTap 单击选项卡时触发,参数为对象,具体见以下注意事项 微信小程序,百度小程序,H5,App(自定义组件模式)
onShareAppMessage 用户点击右上角分享 微信小程序,百度小程序,字节跳动小程序,支付宝小程序
onPageScroll 监听页面滚动,参数为对象 nvue 暂不支持
onNavigationBarButtonTap 监听原生标题栏按钮点击事件,参数为对象 5+ App,H5
onBackPress 监听页面返回,返回事件= {from:backbutton,navigationBack},backbutton 表示来源是左上角返回按钮或android 返回键; navigateBack 表示来源是 uni.navigateBack;详细说明及使用:onBackPress 详解。支付宝小程序只有真机能触发,只能监听非 navigateBack 引起的返回,不可阻止默认行为。 App,H5、支付宝小程序
onNavigationBarSearchInputChanged 监听原生标题栏搜索输入框输入内容变化事件 App,H5 1.6.0
onNavigationBarSearchInputConfirmed 监听原生标题栏搜索输入框搜索事件,用户点击软键盘上的“搜索”按钮时触发。 App,H5 1.6.0
onNavigationBarSearchInputClicked 监听原生标题栏搜索输入框点击事件 App,H5 1.6.0
onShareTimeline 监听用户点击右上角转发到朋友去 微信小程序 2.8.1+
onAddToFavorites 监听用户点击右上角收藏 微信小程序 2.8.1+

onInit使用注意

  • 仅百度小程序基础库 3.260 以上支持 onInit 生命周期
  • 其他版本或平台可以同时使用 onLoad 生命周期进行兼容,注意避免重复执行相同逻辑
  • 不依赖页面传参的逻辑可以直接使用 created 生命周期替代

onReachBottom 使用注意 可在 pages.json 里定义具体页面底部的触发距离 onReachBottomDistance,比如设为 50,那么滚动页面到距离底部 50px 时,就会触发 onReachBottom 事件。

如使用 scroll-view 导致页面没有滚动,则触底事件不会被触发。scroll-view 滚动到底部的事件请参考 scroll-view 的文档

onPageScroll 参数说明:

属性 类型 说明
scrollTop 页面在垂直方向已滚动的距离(单位 px)

注意

  • onPageScroll 里不要写交互复杂的 js,比如频繁修改页面。因为这个生命周期是在渲染层触发的,在非 h5 端,js是在逻辑层执行的,两层之间通信是有损耗的。如果在滚动过程中,频发触发两层之间的数据交换,可能会造成卡顿。
  • 如果想实现滚动时标题栏透明渐变,在 App 和 H5 下,可在 pages.json 中配置 titleNView 下的 type 为 transparent,参考
  • 如果需要滚动吸顶固定某些元素,推荐使用 css 的粘性布局,参考插件市场。插件市场也有其他 js 实现的吸顶插件,但性能不佳,需要时可自行搜索。
  • 在 App、微信小程序、H5 中,也可以使用 wxs 监听滚动,参考;在 app-nvue 中,可以使用 bindingx 监听滚动,参考
  • onBackPress 上不可使用 async,会导致无法阻止默认返回

onTabItemTap 参数说明:

属性 类型 说明
指数 被点击 tabItem 的序号,从 0 开始
pagePath 被点击 tabItem 的页面路径
文本 被点击 tabItem 的按钮文字

注意

  • onTabItemTap 常用于单击当前 tabitem,滚动或刷新当前页面。如果是单击不同的 tabitem,一定会触发页面切换。
  • 如果想在 App 端实现点击某个 Tabitem,则不能使用 onTabItemTap,可以使用 plus.nativeObj.view 放一个区块盖住原先的 TAbitem,并拦截点击事件。
  • 支付宝小程序平台 onTabltemTap 表现为点击非当前 tabitem 后触发,因此不能用于实现点击返回顶部这种操作。


    onTabItemTap : function(e) {
        console.log(e);
        // e的返回格式为json对象: {"index":0,"text":"首页","pagePath":"pages/index/index"}
    },

onNavigationBarButtonTap 参数说明:

属性 类型 说明
指数 原生标题栏按钮方块的下标

onNavigationBarButtonTap : function (e) { console.log(e); // e的返回格式为json对象:{"text":"测试","index":0} }

onBackPress 某些参数对象说明:

属性 类型 说明
触发返回行为的来源:'backbutton'-左上角导航栏按钮和安卓返回键;'navigateBack'-uni.navigateBack()方法。支付宝小程序端不支持返回此字段
export default {
    data() {
        return {};
    },
    onBackPress(options) {
        console.log('from:' + options.from)
    }
}

注意

  • nvue 页面支持的生命周期参考:nvue 生命周期介绍。
  • 支付宝小程序真机可以监听到非 navigateBack 引发的返回事件(使用小程序开发工具时不会触发 onBackPress),不可以阻止默认返回行为

组件生命周期

uni-app 组件支持的生命周期,与 vue 标准组件的生命周期相同。这里没有页面级的 onLoad 等生命周期:

函数名 说明 平台差异说明 最低版本
beforeCreate 在实例初始化之后被调用。详见
created 在实例创建完成后被立即调用。详见
beforeMount 在挂载开始之前被调用。详见
mounted 挂载到实例上去之后调用。详见 注意:此处并不能确定子组件被全部挂载,如果需要子组件完全挂载之后在执行操作可以使用$nextTickVue官方文档
beforeUpdate 数据更新时调用,发生在虚拟 DOM 打补丁之前。详见 仅 H5 平台支持
updated 由于数据更改导致的虚拟 DOM 重新渲染和打补丁,在这之后会调用该钩子。详见 仅 H5 平台支持
beforeDestroy 实例销毁之前调用。在这一步,实例仍然完全可用。详见
destroyed Vue 实例销毁后调用。调用后,Vue 实例指示的所有东西都会解绑定,所有的事件监听器会被移除,所有的子实例也会被销毁。详见


uni-app 框架简介
uni-app 路由
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }