微信小程序page函数相关

原文地址：微信小程序·注册页面

一、说明

Page() 函数用来注册一个页面。接受一个 object 参数，其指定页面的初始数据、生命周期函数、事件处理函数等。

---

二、object 参数

属性	类型	描述
data	Object	页面的初始数据
onLoad	Function	生命周期函数–监听页面加载
onReady	Function	生命周期函数–监听页面初次渲染完成
onShow	Function	生命周期函数–监听页面显示
onHide	Function	生命周期函数–监听页面隐藏
onUnload	Function	生命周期函数–监听页面卸载
onPullDownRefresh	Function	页面相关事件处理函数–监听用户下拉动作
onReachBottom	Function	页面上拉触底事件的处理函数
onShareAppMessage	Function	用户点击右上角转发
onPageScroll	Function	页面滚动触发事件的处理函数
onTabItemTap	Function	当前是 tab 页时，点击 tab 时触发
其他	Any	开发者可以添加任意的函数或数据到 object 参数中，在页面的函数中用 this 可以访问

object 内容在页面加载时会进行一次深拷贝，需考虑数据大小对页面加载的开销

2.1 初始化数据

初始化数据（data）将作为页面的第一次渲染。data 将会以 JSON 的形式由逻辑层传至渲染层，所以其数据必须是可以转成 JSON 的格式：字符串，数字，布尔值，对象，数组。

渲染层可以通过 WXML 对数据进行绑定。

2.2 生命周期函数

• onLoad: 页面加载
  一个页面只会调用一次，可以在 onLoad 中获取打开当前页面所调用的 query 参数。
• onShow: 页面显示
  每次打开页面都会调用一次。
• onReady: 页面初次渲染完成
  一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。
  对界面的设置如wx.setNavigationBarTitle请在onReady之后设置。
• onHide: 页面隐藏
  当navigateTo或底部tab切换时调用。
• onUnload: 页面卸载
  当redirectTo或navigateBack的时候调用。

2.3 页面相关事件处理函数

• onPullDownRefresh: 下拉刷新
  监听用户下拉刷新事件。
  需要在app.json的window选项中或页面配置中开启enablePullDownRefresh。
  当处理完数据刷新后，wx.stopPullDownRefresh可以停止当前页面的下拉刷新。
• onReachBottom: 上拉触底
  监听用户上拉触底事件。
  可以在app.json的window选项中或页面配置中设置触发距离onReachBottomDistance。
  在触发距离内滑动期间，本事件只会被触发一次。
• onPageScroll: 页面滚动
  监听用户滑动页面事件。
  参数为 Object，包含字段scrollTop，类型为Number，表示页面在垂直方向已滚动的距离（单位px）

• onShareAppMessage: 用户转发
  只有定义了此事件处理函数，右上角菜单才会显示“转发”按钮
  用户点击转发按钮的时候会调用
  此事件需要 return 一个 Object，用于自定义转发内容
  自定义转发字段

  字段	说明	默认值
  title	转发标题	当前小程序名称
  path	转发路径	当前页面 path ，必须是以 / 开头的完整路径

  示例代码:

  Page({
      onShareAppMessage: function () {
          return {
              title: '自定义转发标题',
              path: '/page/user?id=123'
          }
      }
  })

2.4 事件处理函数

除了初始化数据和生命周期函数，Page 中还可以定义一些特殊的函数：事件处理函数。在渲染层可以在组件中加入事件绑定，当达到触发事件时，就会执行 Page 中定义的事件处理函数。

示例代码：

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

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

2.5 Page.prototype.route

route 字段可以获取到当前页面的路径。

2.6 Page.prototype.setData()

setData 函数用于将数据从逻辑层发送到视图层（异步），同时改变对应的 this.data 的值（同步）。

setData() 参数格式:

字段	类型	必填	描述
data	Object	是	这次要改变的数据
callback	Function	否	回调函数

object 以 key，value 的形式表示将 this.data 中的 key 对应的值改变成 value。 callback 是一个回调函数，在这次setData对界面渲染完毕后调用。

其中 key 可以非常灵活，以数据路径的形式给出，如 array[2].message，a.b.c.d，并且不需要在 this.data 中预先定义。

注意：

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

---

三、page生命周期