小程序 页面生命周期



  • 定义

    下图说明了页面 Page 实例的生命周期。
    生命周期
  • 参数

    注册小程序中的一个页面。接受一个 Object 类型参数,其指定页面的初始数据、生命周期回调、事件处理函数等。
    属性 类型 默认值 必填 说明
    data Object 页面的初始数据
    onLoad function 生命周期回调—监听页面加载
    onShow function 生命周期回调—监听页面显示
    onReady function 生命周期回调—监听页面初次渲染完成
    onHide function 生命周期回调—监听页面隐藏
    onUnload function 生命周期回调—监听页面卸载
    onPullDownRefresh function 监听用户下拉动作
    onReachBottom function 页面上拉触底事件的处理函数
    onShareAppMessage function 用户点击右上角转发
    onPageScroll function 页面滚动触发事件的处理函数
    onResize function 页面尺寸改变时触发,详见 响应显示区域变化
    onTabItemTap function 当前是 tab 页时,点击 tab 时触发
    其他 any 开发者可以添加任意的函数或数据到 Object 参数中,在页面的函数中用 this 可以访问
  • 示例

    页面生命周期函数示例
    //index.js
    Page({
      data: {
        text: "This is page data."
      },
      onLoad: function(options) {
        // 在页面加载时进行一些初始化。
      },
      onShow: function() {
        // 页面显示时执行一些操作。
      },
      onReady: function() {
        //准备好页面后执行一些操作。
      },
      onHide: function() {
        // 隐藏页面时执行某些操作。
      },
      onUnload: function() {
        // 关闭页面时执行某些操作。
      },
      onPullDownRefresh: function() {
        // 下拉时做点什么。
      },
      onReachBottom: function() {
        // 页面到达底部时执行某些操作。
      },
      onShareAppMessage: function () {
        // 用户共享时返回自定义共享数据。
      },
      onPageScroll: function() {
        // 页面滚动时做些什么
      },
      onResize: function() {
        // 调整页面大小时执行某些操作
      },
      onTabItemTap(item) {
        console.log(item.index)
        console.log(item.pagePath)
        console.log(item.text)
      },
      // 事件处理程序
      viewTap: function() {
        this.setData({
          text: 'Set some data for updating view.'
        }, function() {
          // this is setData callback
        })
      },
      customData: {
        hi: 'MINA'
      }
    })
    
    
  • data

    data 是页面第一次渲染使用的初始数据。
    页面加载时,data 将会以 JSON 字符串的形式由逻辑层传至渲染层,因此 data 中的数据必须是可以转成 JSON 的类型:字符串,数字,布尔值,对象,数组;渲染层可以通过 WXML 对数据进行绑定。
    //index.wxml
    <view>{{text}}</view>
    <view>{{array[0].msg}}</view>
    
    
    //index.js
    Page({
      data: {
        text: 'init data',
        array: [{msg: '1'}, {msg: '2'}]
      }
    })
    
    
  • 生命周期回调函数

    生命周期的触发以及页面的路由方式详见

    onLoad(Object query)

    页面加载时触发。一个页面只会调用一次,可以在 onLoad 的参数中获取打开当前页面路径中的参数。
    名称 类型 说明
    query Object 打开当前页面路径中的参数

    onShow()

    页面显示/切入前台时触发。

    onReady()

    页面显示/切入前台时触发。页面初次渲染完成时触发。一个页面只会调用一次,代表页面已经准备妥当,可以和视图层进行交互。
    注意:对界面内容进行设置的 API 如wx.setNavigationBarTitle,请在onReady之后进行。

    onHide()

    页面隐藏/切入后台时触发。如 wx.navigateTo 或底部 tab 切换到其他页面,小程序切入后台等。

    onUnload()

    页面卸载时触发。如 wx.redirectTowx.navigateBack 到其他页面时。
  • 页面事件处理函数

    onPullDownRefresh()

    监听用户下拉刷新事件。
    • 需要在app.jsonwindow选项中或页面配置中开启enablePullDownRefresh
    • 可以通过wx.startPullDownRefresh触发下拉刷新,调用后触发下拉刷新动画,效果与用户手动下拉刷新一致。
    • 当处理完数据刷新后,wx.stopPullDownRefresh可以停止当前页面的下拉刷新。

    onReachBottom()

    监听用户上拉触底事件。
    • 可以在app.jsonwindow选项中或页面配置中开启onReachBottomDistance
    • 在触发距离内滑动期间,本事件只会被触发一次。

    onPageScroll(Object object)

    监听用户滑动页面事件。
    参数 Object object:
    属性 类型 说明
    scrollTop Number 页面在垂直方向已滚动的距离(单位px)
    注意:请只在需要的时候才在 page 中定义此方法,不要定义空方法。以减少不必要的事件派发对渲染层-逻辑层通信的影响。
    注意:请避免在 onPageScroll 中过于频繁的执行 setData 等引起逻辑层-渲染层通信的操作。尤其是每次传输大量数据,会影响通信耗时。

    onShareAppMessage(Object object)

    监听用户点击页面内转发按钮(button 组件 open-type="share")或右上角菜单“转发”按钮的行为,并自定义转发内容。
    注意:只有定义了此事件处理函数,右上角菜单才会显示“转发”按钮
    参数 Object object:
    参数 类型 说明 最低版本
    from String
    转发事件来源。
    button:页面内转发按钮;
    menu:右上角转发菜单
    1.2.4
    target Object 如果 from 值是 button,则 target 是触发这次转发事件的 button,否则为 undefined 1.2.4
    webViewUrl String 页面中包含web-view组件时,返回当前web-view的url 1.6.4
    此事件处理函数需要 return 一个 Object,用于自定义转发内容,返回内容如下:
    自定义转发内容 基础库 2.8.1 起,分享图支持云图片。
    字段 说明 默认值 最低版本
    title 转发标题 当前小程序名称
    path 转发路径 当前页面 path ,必须是以 / 开头的完整路径
    imageUrl 自定义图片路径,可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4。 使用默认截图 1.5.0
    代码演示:
    //index.js
    Page({
      onShareAppMessage: function (res) {
        if (res.from === 'button') {
          // 来自页面内转发按钮
          console.log(res.target)
        }
        return {
          title: '自定义转发标题',
          path: '/page/user?id=123'
        }
      }
    })
    
    

    onResize(Object object)

    小程序屏幕旋转时触发。详见 响应显示区域变化
    注意:基础库 2.4.0 开始支持

    onTabItemTap(Object object)

    点击底部 tab 时触发
    参数 类型 说明 最低版本
    index String 被点击tabItem的序号,从0开始 1.9.0
    pagePath String 被点击tabItem的页面路径 1.9.0
    text String 被点击tabItem的按钮文字 1.9.0
    代码演示:
    //index.js
    Page({
        onTabItemTap(item) {
          console.log(item.index)
          console.log(item.pagePath)
          console.log(item.text)
        }
    })