小程序——生命周期函数和事件处理函数

生命周期函数和事件处理函数

一、概述
二、应用级生命周期(App)
三、页面级声明周期(Page)
四、示例

一、概述

小程序的生命周期分为两类：

小程序应用级生命周期
页面级生命周期。

当打开小程序时，首先会触发应用级生命周期函数onLaunch()进行程序的启动，完成后调用onShow()准备显示页面，当被切换进入后台会调用onHide(),直到下次程序在销毁前重新被唤起会再次调用onShow()。

当小程序应用级生命周期调用完onShow()以后，就会准备触发小程序页面级生命周期，在一个页面加载显示的过程中会分别触发onLoad()、onShow()、onReady()函数。当页面被切换到后台，会调用页面onHide(),从后台被唤醒会调用页面onShow()。直到页面关闭会调用onUnload(),当用户重新打开页面还会再依次触发onLoad()、onShow()、onReady()函数。

在tab栏上页面之间互相切换以及在当前页面上跳转到一个新页面也会触发onHide()函数，当用户再次切换到之前的页面会调用onShow()函数。

二、应用级生命周期(App)

小程序的应用级注册是通过重写APp()函数的各种回调事件来达到影响整个应用行为的目的，App()函数必须在app.js中注册，并且有且仅有一个，它接受一个object参数，指小程序的应用级注册是通过重写APp()函数的各种回调事件来达到影响整个应用行为的目的，App()函数必须在app.js中注册，并且有且仅有一个，它接受一个object参数，指定小程序的声明周期。

App() 必须在 app.js 中调用，必须调用且只能调用一次。不然会出现无法预期的后果

object参数属性如下表：

属性	类型	必填	说明
`onLaunch`	function	否	生命周期回调------监听小程序初始化。
`onShow`	function	否	生命周期回调------监听小程序启动或切前台。
`onHide`	function	否	生命周期回调------监听小程序切后台。
`onError`	function	否	错误监听函数。
`onPageNotFound`	function	否	页面不存在监听函数。
`onUnhandledRejection`	function	否	未处理的 Promise 拒绝事件监听函数。
`onThemeChange`	function	否	监听系统主题变化
`其他`	any	否	开发者可以添加任意的函数或数据变量到 Object 参数中，用 this 可以访问

前台和后台：当用户单击左上角的"关闭"按钮时，或者设备中的界面离开微信，这时小程序进入后台，而并没有销毁；当小程序再次切换到当前屏幕时，小程序又会从后台进入前台，只有当小程序进入后台一定时间后，或者系统资源占用过高，小程序才会被销毁。

onLaunch(Object object)
小程序初始化完成时触发，全局只触发一次。参数如下：

属性	类型	说明
`path`	string	启动小程序的路径 (代码包路径)
`scene`	number	启动小程序的场景值
`query`	Record.<string, string>	启动小程序的 query 参数
`shareTicket`	string	shareTicket，详见获取更多转发信息
`referrerInfo`	Object	来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 {}。(参见后文注意)
`forwardMaterials`	Array.<Object>	打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数
`chatType`	number	从微信群聊/单聊打开小程序时，chatType 表示具体微信群聊/单聊类型
`hostExtraData`	Object	宿主传递的数据，第三方 app 中运行小程序时返回
`apiCategory`	string	API 类别

onShow(Object object)

小程序启动，或从后台进入前台显示时触发。也可以使用 wx.onAppShow 绑定监听。参数同上。
onHide()

小程序从前台进入后台时触发。也可以使用 wx.onAppHide 绑定监听。参数如下：

属性	类型	说明
reason	numbe	原因

onError(String error)
小程序发生脚本错误或 API 调用报错时触发。也可以使用 wx.onError 绑定监听。参数如下：

属性	类型	说明
message	string	错误信息，包含堆栈

onPageNotFound(Object object)
基础库 1.9.90 开始支持，低版本需做兼容处理。
小程序要打开的页面不存在时触发。也可以使用 wx.onPageNotFound 绑定监听。注意事项请参考 wx.onPageNotFound。

js 复制代码

App({
  onPageNotFound(res) {
    wx.redirectTo({
      url: 'pages/...'
    }) // 如果是 tabbar 页面，请使用 wx.switchTab
  }
})

onUnhandledRejection(Object object)
小程序有未处理的 Promise 拒绝时触发。也可以使用 wx.onUnhandledRejection 绑定监听。
onThemeChange(Object object)
系统切换主题时触发。也可以使用 wx.onThemeChange 绑定监听。

示例：

js 复制代码

App({
  onLaunch (options) {
    // Do something initial when launch.
  },
  onShow (options) {
    // Do something when show.
  },
  onHide (options) {
    // Do something when hide.
  },
  onError (msg) {
    console.log(msg)
  },
  globalData: 'I am global data'
})

三、页面级声明周期(Page)

注册小程序中的一个页面，可以在JS文件中使用Page(Object)方法进行注册，接受一个Object类型参数后，就能够指定页面的初始数据、生命周期回调、事件处理函数等。

在Page()方法中默认生成的onLoad()、onShow()、onReady()、on Hide()以及onUnload()均是页面的生命周期回调函数。

Object类型参数属性如下：

属性	类型	说明
`data`	Object	页面的初始数据
`options`	Object	页面的组件选项，同 Component 构造器中的 options ，需要基础库版本 2.10.1
`behaviors`	String Array	类似于mixins和traits的组件间代码复用机制，参见 behaviors，需要基础库版本 2.9.2
`onLoad`	function	生命周期回调---监听页面加载
`onShow`	function	生命周期回调---监听页面显示
`onReady`	function	生命周期回调---监听页面初次渲染完成
`onHide`	function	生命周期回调---监听页面隐藏
`onUnload`	function	生命周期回调---监听页面卸载
`onRouteDone`	function	生命周期回调---监听路由动画完成
`onPullDownRefresh`	function	监听用户下拉动作
`onReachBottom`	function	页面上拉触底事件的处理函数
`onShareAppMessage`	function	用户点击右上角转发
`onShareTimeline`	function	用户点击右上角转发到朋友圈
`onAddToFavorites`	function	用户点击右上角收藏
`onPageScroll`	function	页面滚动触发事件的处理函数
`onResize`	function	页面尺寸改变时触发，详见响应显示区域变化
`onTabItemTap`	function	当前是 tab 页时，点击 tab 时触发
`onSaveExitState`	function	页面销毁前保留状态回调
`其他`	any	开发者可以添加任意的函数或数据到 Object 参数中，在页面的函数中用 this 可以访问。这部分属性会在页面实例创建时进行一次深拷贝

示例：

js 复制代码

//index.js
Page({
  data: {
    text: "This is page data."
  },
  onLoad: function(options) {
    // Do some initialize when page load.
  },
  onShow: function() {
    // Do something when page show.
  },
  onReady: function() {
    // Do something when page ready.
  },
  onHide: function() {
    // Do something when page hide.
  },
  onUnload: function() {
    // Do something when page close.
  },
  onPullDownRefresh: function() {
    // Do something when pull down.
  },
  onReachBottom: function() {
    // Do something when page reach bottom.
  },
  onShareAppMessage: function () {
    // return custom share data when user share.
  },
  onPageScroll: function() {
    // Do something when page scroll
  },
  onResize: function() {
    // Do something when page resize
  },
  onTabItemTap(item) {
    console.log(item.index)
    console.log(item.pagePath)
    console.log(item.text)
  },
  // Event handler.
  viewTap: function() {
    this.setData({
      text: 'Set some data for updating view.'
    }, function() {
      // this is setData callback
    })
  },
  customData: {
    hi: 'MINA'
  }
})

3.1、数据

data

data 是页面第一次渲染使用的初始数据。页面加载时，data 将会以JSON字符串的形式由逻辑层传至渲染层，因此data中的数据必须是可以转成JSON的类型：字符串，数字，布尔值，对象，数组。渲染层可以通过 WXML 对数据进行绑定。

html 复制代码

<view>{{text}}</view>
<view>{{array[0].msg}}</view>

js 复制代码

Page({
  data: {
    text: 'init data',
    array: [{msg: '1'}, {msg: '2'}]
  }
})

3.2、生命周期回调函数

onLoad(Object query)
页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取打开当前页面路径中的参数。参数如下：

名称	类型	说明
query	Object	打开当前页面路径中的参数

onShow()
页面显示/切入前台时触发
onReady()
页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。
注意：对界面内容进行设置的 API 如wx.setNavigationBarTitle，请在onReady之后进行。
onHide()
页面隐藏/切入后台时触发。如 wx.navigateTo 或底部 tab 切换到其他页面，小程序切入后台等。
onUnload()
页面卸载时触发。如wx.redirectTo或wx.navigateBack到其他页面时
onRouteDone()
路由动画完成时触发。如 wx.navigateTo 页面完全推入后或 wx.navigateBack 页面完全恢复时

3.3、页面事件处理函数

onPullDownRefresh()

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

监听用户上拉触底事件。
- 可以在app.json的window选项中或页面配置中设置触发距离onReachBottomDistance。
- 在触发距离内滑动期间，本事件只会被触发一次。
onPageScroll(Object object)

监听用户滑动页面事件。参数如下：

名称	类型	说明
scrollTop	Number	页面在垂直方向已滚动的距离（单位px）

onAddToFavorites(Object object)
本接口为 Beta 版本，安卓 7.0.15 版本起支持，暂只在安卓平台支持监听用户点击右上角菜单"收藏"按钮的行为，并自定义收藏内容。参数如下：

名称	类型	说明
webViewUrl	String	页面中包含web-view组件时，返回当前web-view的url）

此事件处理函数需要 return 一个 Object，用于自定义收藏内容：

字段	说明	默认值
title	自定义标题	页面标题或账号名称
imageUrl	自定义图片，显示图片长宽比为 1：1	页面截图
query	自定义query字段	当前页面的query

js 复制代码

Page({
  onAddToFavorites(res) {
    // webview 页面返回 webViewUrl
    console.log('webViewUrl: ', res.webViewUrl)
    return {
      title: '自定义标题',
      imageUrl: 'http://demo.png',
      query: 'name=xxx&age=xxx',
    }
  }
})

onShareAppMessage(Object object)
监听用户点击页面内转发按钮（button 组件 open-type="share"）或右上角菜单"转发"按钮的行为，并自定义转发内容。注意：只有定义了此事件处理函数，右上角菜单才会显示"转发"按钮。参数如下：

名称	类型	说明
from	String	转发事件来源button：页面内转发按钮；menu：右上角转发菜单
target	Object	如果 from 值是 button，则 target 是触发这次转发事件的 button，否则为 undefined
webViewUrl	String	页面中包含web-view组件时，返回当前web-view的url

此事件处理函数需要 return 一个 Object，用于自定义转发内容，返回内容如下：

字段	说明	默认值
title	转发标题	当前小程序名称
path	转发路径	当前页面 path ，必须是以 / 开头的完整路径
imageUrl	自定义图片路径，可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4。	使用默认截图
promise	如果该参数存在，则以 resolve 结果为准，如果三秒内不 resolve，分享会使用上面传入的默认参数

js 复制代码

Page({
  onShareAppMessage() {
    const promise = new Promise(resolve => {
      setTimeout(() => {
        resolve({
          title: '自定义转发标题'
        })
      }, 2000)
    })
    return {
      title: '自定义转发标题',
      path: '/page/user?id=123',
      promise 
    }
  }
})

onShareTimeline()
基础库 2.11.3 开始支持，低版本需做兼容处理。监听右上角菜单"分享到朋友圈"按钮的行为，并自定义分享内容。注意：只有定义了此事件处理函数，右上角菜单才会显示"分享到朋友圈"按钮。
事件处理函数返回一个 Object，用于自定义分享内容，不支持自定义页面路径，返回内容如下：

字段	说明	默认值
title	自定义标题，即朋友圈列表页上显示的标题	当前小程序名称
query	自定义页面路径中携带的参数，如 path?a=1&b=2 的 "?" 后面部分	当前页面路径携带的参数
imageUrl	自定义图片路径，可以是本地文件或者网络图片。支持 PNG 及 JPG，显示图片长宽比是 1:1。	默认使用小程序 Logo
promise	如果该参数存在，则以 resolve 结果为准，如果三秒内不 resolve，分享会使用上面传入的默认参数

js 复制代码

Page({
  onShareTimeline() {
    const promise = new Promise(resolve => {
      setTimeout(() => {
        resolve({
          title: '自定义转发标题'
        })
      }, 2000)
    })
    return {
      title: '自定义转发标题',
      query: 'id=123',
      imageUrl: '/images/share.png',
      promise
    }
  }
})

onResize(Object object)

页面尺寸改变时触发。基础库 2.4.0 开始支持，低版本需做兼容处理。页面尺寸改变时触发。
onTabItemTap(Object object)

点击 tab 时触发。基础库 1.9.0 开始支持，低版本需做兼容处理。点击 tab 时触发，参数如下：

参数	类型	说明
index	String	被点击tabItem的序号，从0开始
pagePath	String	被点击tabItem的页面路径
text	String	被点击tabItem的按钮文字

js 复制代码

Page({
  onTabItemTap(item) {
    console.log(item.index)
    console.log(item.pagePath)
    console.log(item.text)
  }
})

onSaveExitState()
基础库 2.7.4 开始支持，低版本需做兼容处理。每当小程序可能被销毁之前，页面回调函数 onSaveExitState 会被调用，可以进行退出状态的保存。

3.4、组件事件处理函数

Page 中还可以定义组件事件处理函数。在渲染层的组件中加入事件绑定，当事件被触发时，就会执行 Page 中定义的事件处理函数。

html 复制代码

<view bindtap="viewTap"> click me </view>

js 复制代码

Page({
  viewTap: function() {
    console.log('view tap')
  }
})

Page.route
基础库 1.2.0 开始支持，低版本需做兼容处理。到当前页面的路径，类型为String。

js 复制代码

Page({
  onShow: function() {
    console.log(this.route)
  }
})

Page.prototype.setData(Object data, Function callback)
setData 函数用于将数据从逻辑层发送到视图层（异步），同时改变对应的 this.data 的值（同步）。参数如下：

字段	类型	必填	描述
data	Object	是	这次要改变的数据
callback	Function	否	setData引起的界面更新渲染完毕后的回调函数

Object 以 key: value 的形式表示，将 this.data 中的 key 对应的值改变成 value。

其中 key 可以以数据路径的形式给出，支持改变数组中的某一项或对象的某个属性，如 array[2].message，a.b.c.d，并且不需要在 this.data 中预先定义。

注意：

直接修改 this.data 而不调用 this.setData 是无法改变页面的状态的，还会造成数据不一致。
仅支持设置可 JSON 化的数据。
单次设置的数据不能超过1024kB，请尽量避免一次设置过多的数据。
请不要把 data 中任何一项的 value 设为 undefined ，否则这一项将不被设置并可能遗留一些潜在问题。

html 复制代码

<!--index.wxml-->
<view>{{text}}</view>
<button bindtap="changeText"> Change normal data </button>
<view>{{num}}</view>
<button bindtap="changeNum"> Change normal num </button>
<view>{{array[0].text}}</view>
<button bindtap="changeItemInArray"> Change Array data </button>
<view>{{object.text}}</view>
<button bindtap="changeItemInObject"> Change Object data </button>
<view>{{newField.text}}</view>
<button bindtap="addNewField"> Add new data </button>

js 复制代码

// index.js
Page({
  data: {
    text: 'init data',
    num: 0,
    array: [{text: 'init data'}],
    object: {
      text: 'init data'
    }
  },
  changeText: function() {
    // this.data.text = 'changed data' // 不要直接修改 this.data
    // 应该使用 setData
    this.setData({
      text: 'changed data'
    })
  },
  changeNum: function() {
    // 或者，可以修改 this.data 之后马上用 setData 设置一下修改了的字段
    this.data.num = 1
    this.setData({
      num: this.data.num
    })
  },
  changeItemInArray: function() {
    // 对于对象或数组字段，可以直接修改一个其下的子字段，这样做通常比修改整个对象或数组更好
    this.setData({
      'array[0].text':'changed data'
    })
  },
  changeItemInObject: function(){
    this.setData({
      'object.text': 'changed data'
    });
  },
  addNewField: function() {
    this.setData({
      'newField.text': 'new data'
    })
  }
})

3.4、页面间通信

如果一个页面由另一个页面通过 wx.navigateTo 打开，这两个页面间将建立一条数据通道：

被打开的页面可以通过 this.getOpenerEventChannel() 方法来获得一个 EventChannel 对象；

wx.navigateTo 的 success 回调中也包含一个 EventChannel 对象。

这两个 EventChannel 对象间可以使用 emit 和 on 方法相互发送、监听事件。

四、示例

app.js代码如下：

js 复制代码

// app.js
App({
  //当小程序初始化完成时，会触发onLaunch（全局只触发一次）
  onLaunch() {
    console.log("app执行onLaunch")
  },
  //当小程序启动，或从后台进入前台显示，会触发onShow
  onShow(options) {
    console.log("app执行onShow")
  },
  //当小程序从前台进入后台，会触发onHide
  onHide() {
    console.log("app执行onHide")
  },
  //当小程序发生脚本错误，或者API调用失败时，会触发onError
  onError() {
    console.log("app执行onError")
  }
})

pages/index/index.js代码如下：

js 复制代码

const app = getApp()
Page({
  data: {
    motto: 'hello world',
    userInfo: {},
    hasUserInfo: false,
    canIUse: wx.canIUse('button.open-type.getUserInfo')
  },
  onLoad(options) {
    console.log("page执行onLoad函数")
  },
  onReady() {
    console.log("page执行了onReady函数")
  },
  onShow() {
    console.log("page执行了onShow函数")
  },
  onHide() {
    console.log("page执行onHide函数")
  }
})