app()函数用来注册一个小程序。接受一个object参数,其指定小程序的生命周期函数等。
object参数说明:
| 属性 | 类型 | 描述 | 触发时机 |
|---|---|---|---|
| onlaunch | function | 生命周期函数--监听小程序初始化 | 当小程序初始化完成时,会触发 onlaunch(全局只触发一次) |
| onshow | function | 生命周期函数--监听小程序显示 | 当小程序启动,或从后台进入前台显示,会触发 onshow |
| onhide | function | 生命周期函数--监听小程序隐藏 | 当小程序从前台进入后台,会触发 onhide |
| onerror | function | 错误监听函数 | 当小程序发生脚本错误,或者 api 调用失败时,会触发 onerror 并带上错误信息 |
| onpagenotfound |
function |
页面不存在监听函数 |
当小程序出现要打开的页面不存在的情况,会带上页面信息回调该函数,详见下文 |
| 其他 | any | 开发者可以添加任意的函数或数据到 object 参数中,用 this 可以访问
|
前台、后台定义:当用户点击左上角关闭,或者按了设备 home 键离开微信,小程序并没有直接销毁,而是进入了后台;当再次进入微信或再次打开小程序,又会从后台进入前台。需要注意的是:只有当小程序进入后台一定时间,或者系统资源占用过高,才会被真正的销毁。
关闭小程序(基础库版本1.1.0开始支持):当用户从扫一扫、转发等入口(场景值为1007, 1008, 1011, 1025)进入小程序,且没有置顶小程序的情况下退出,小程序会被销毁。小程序运行机制在基础库版本 1.4.0 有所改变:上一条关闭逻辑在新版本已不适用, 详情
示例代码:
app({
onlaunch: function(options) {
// do something initial when launch.
},
onshow: function(options) {
// do something when show.
},
onhide: function() {
// do something when hide.
},
onerror: function(msg) {
console.log(msg)
},
globaldata: 'i am global data'
})
| 字段 | 类型 | 说明 |
|---|---|---|
| path | string | 打开小程序的路径 |
| query | object | 打开小程序的query |
| scene | number | 打开小程序的场景值 |
| shareticket | string | shareticket,详见 获取更多转发信息 |
| referrerinfo | object | 当场景为由另一个小程序打开时,返回此字段 |
| referrerinfo.appid | string | 来源小程序的 appid |
| referrerinfo.extradata | object | 来源小程序传过来的数据 |
场景值 详见。
以下场景支持返回 referrerinfo.appid:
| 场景值 | 场景 | appid 信息含义 |
|---|---|---|
| 1020 | 公众号 profile 页相关小程序列表 | 返回来源公众号 appid |
| 1035 | 公众号自定义菜单 | 返回来源公众号 appid |
| 1036 | app 分享消息卡片 | 返回来源应用 appid |
| 1037 | 小程序打开小程序 | 返回来源小程序 appid |
| 1038 | 从另一个小程序返回 | 返回来源小程序 appid |
| 1043 | 公众号模板消息 | 返回来源公众号 appid |
基础库 1.9.90 开始支持,低版本需做兼容处理
当要打开的页面并不存在时,会回调这个监听器,并带上以下信息:
| 字段 | 类型 | 说明 |
|---|---|---|
| path | string | 不存在页面的路径 |
| query | object | 打开不存在页面的 query |
| isentrypage | boolean | 是否本次启动的首个页面(例如从分享等入口进来,首个页面是开发者配置的分享页面) |
开发者可以在 onpagenotfound 回调中进行重定向处理,但必须在回调中同步处理,异步处理(例如 settimeout 异步执行)无效。
示例代码:
app({
onpagenotfound(res) {
wx.redirectto({
url: 'pages/...'
})
}
})
注意:
我们提供了全局的getapp()函数,可以获取到小程序实例。
// other.js
var appinstance = getapp()
console.log(appinstance.globaldata) // i am global data
注意:
app()必须在app.js中注册,且不能注册多个。
不要在定义于app()内的函数中调用getapp(),使用this就可以拿到app实例。
不要在onlaunch的时候调用getcurrentpage(),此时page还没有生成。
通过getapp()获取实例之后,不要私自调用生命周期函数。