App
简介
App
代表顶层应用,管理所有页面和全局数据,以及提供生命周期方法。它也是一个构造方法,生成App
实例。一个小程序就是一个App
实例。
每个小程序的顶层一般包含三个文件。
- app.js:应用逻辑
- app.acss:应用样式(可选)
- app.json:应用配置
下面是一个简单的app.json
。
{
"pages": [
"pages/index/index",
"pages/logs/index"
],
"window": {
"defaultTitle": "Demo"
}
}
上面配置指定小程序包含两个页面,以及应用窗口的默认标题是 Demo
。
App
提供四个事件,可以设置钩子方法。
- onLaunch:小程序启动
- onShow:小程序切换到前台
- onHide:小程序切换到后台
- onError: 小程序出错
一个简单的app.js
代码如下。
App({
onLaunch(options) {},
onShow(options) {},
onHide() {},
onError(msg) {
console.log(msg)
},
globalData: {
foo: true,
}
})
App(Object)
App()
接受一个 object
作为参数,用来配置小程序的生命周期等。
Object 参数说明
属性 | 类型 | 描述 | 触发时机 |
---|---|---|---|
onLaunch | Function | 监听小程序初始化 | 当小程序初始化完成时触发,全局只触发一次 |
onShow | Function | 监听小程序显示 | 当小程序启动,或从后台进入前台显示时触发 |
onHide | Function | 监听小程序隐藏 | 当小程序从前台进入后台时触发 |
onError | Function | 监听小程序错误 | 当小程序发生 js 错误时触发 |
onShareAppMessage | Function | 全局分享配置 | 当页面未设置 page.onShareAppMessage 时调用分享会执行全局的分享设置,具体见分享 |
前台、后台定义: 用户点击左上角关闭,或者按了设备 Home 键离开支付宝时,小程序并不会直接销毁,而是进入了后台,当再次进入支付宝或再次打开小程序时,又会从后台进入前台。
只有当小程序进入后台一定时间,或占用系统资源过高,才会被真正销毁。
onLaunch/onShow 方法的参数 options 属性说明
属性 | 类型 | 描述 |
---|---|---|
query | Object | 当前小程序的 query,从启动参数的 query 字段解析而来 |
path | String | 当前小程序的页面地址,从启动参数 page 字段解析而来,page 忽略时默认为首页 |
referrerInfo | Object | 来源信息。 |
示例 url 如下:
alipays://platformapi/startapp?appId=1999&query=number%3D1&page=x%2Fy%2Fz
参数解析如下:
query = decodeURIComponent('number%3D1');
// number=1
path = decodeURIComponent('x%2Fy%2Fz');
// x/y/z
那么,当用户第一次启动小程序可以从 onLaunch
方法中获取这个参数,或者小程序在后台时被重新用 schema 打开也可以从 onShow
方法中获取这个参数。
App({
onLaunch(options) {
// 第一次打开
console.log(options.query);
// {number:1}
},
onShow(options) {
// 从后台被 schema 重新打开
console.log(options.query);
// {number:1}
},
})
referrerInfo结构
属性 | 类型 | 描述 | 兼容性 |
---|---|---|---|
appId | string | 来源小程序 | |
sourceServiceId | String | 来源插件,当处于插件运行模式时可见 | 1.11.0 |
extraData | Object | 来源小程序传过来的数据。 |
注意: 不要在 onShow 中进行 redirectTo/navigateTo 等操作页面栈的行为。
getApp()
我们提供了全局的 getApp()
函数,可以获取到小程序实例,一般用在各个子页面之中获取顶层应用。
var app = getApp()
console.log(app.globalData) // 获取 globalData
注意:
App()
必须在app.js
里调用,且不能调用多次。- 不要在定义于
App()
内定义的函数中调用getApp()
,使用this
就可以拿到app
实例。 - 不要在
onLaunch
里调用getCurrentPages()
,这个时候page
还没有生成。 - 通过
getApp()
获取实例之后,不要私自调用生命周期函数。
全局的数据可以在 App() 中设置,各个子页面通过全局函数 getApp() 可以获取全局的应用实例。下面是一个例子。
// app.js
App({
globalData: 1
})
// a.js
// localValue 只在 a.js 有效
var localValue = 'a'
// 生成 app 实例
var app = getApp()
// 拿到全局数据,并改变它
app.globalData++
// b.js
// localValue 只在 b.js 有效
var localValue = 'b'
// 如果 a.js 先运行,globalData 会返回 2
console.log(getApp().globalData)
上面代码中,a.js
和 b.js
都声明了变量 localValue
,它们不会互相影响,因为各个脚本声明的变量和函数只在该文件中有效。
app.json
app.json
用于全局配置,决定页面文件的路径、窗口表现、设置网络超时时间、设置多 tab 等。
以下是一个包含了部分配置选项的简单配置 app.json
。
{
"pages": [
"pages/index/index",
"pages/logs/index"
],
"window": {
"defaultTitle": "Demo"
}
}
app.json
配置项如下。
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
pages | String Array | 是 | 设置页面路径 |
window | Object | 否 | 设置默认页面的窗口表现 |
tabBar | Object | 否 | 设置底部 tab 的表现 |
(1)pages
pages
属性是一个数组,每一项都是字符串,用来指定小程序的页面。小程序中新增/减少页面,都需要对 pages
数组进行修改。
数组的第一项代表小程序的首页,每一项代表对应页面的路径信息。
页面路径不需要写 js
后缀,框架会自动去加载同名的.json
、.js
、.axml
、.acss
文件。
举例来说,如果开发目录为:
pages/
pages/index/index.axml
pages/index/index.js
pages/index/index.acss
pages/logs/logs.axml
pages/logs/logs.js
app.js
app.json
app.acss
app.json
就要写成下面的样子。
{
"pages":[
"pages/index/index",
"pages/logs/logs"
]
}
(2)window
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
defaultTitle | String | 否 | 页面标题 |
pullRefresh | Boolean | 否 | 是否允许下拉刷新。默认 false, 备注:下拉刷新生效的前提是allowsBounceVertical 值为 YES |
allowsBounceVertical | String | 否 | 页面是否支持纵向拽拉超出实际内容。默认 YES, 支持 YES / NO |
titleBarColor | HexColor | 否 | 导航栏背景色 |
下面是一个例子。
{
"window":{
"defaultTitle": "支付宝接口功能演示"
}
}
(3)tabBar
如果你的小程序是一个多 tab 应用(客户端窗口的底部栏可以切换页面),那么可以通过tabBar
配置项指定 tab 栏的表现,以及 tab 切换时显示的对应页面。
注意,通过页面跳转(my.navigateTo
)或者页面重定向(my.redirectTo
)所到达的页面,即使它是定义在 tabBar 配置中的页面,也不会显示底部的 tab 栏。另外,tabBar
的第一个页面必须是首页。
tabBar 配置
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
textColor | HexColor | 否 | 文字颜色 |
selectedColor | HexColor | 否 | 选中文字颜色 |
backgroundColor | HexColor | 否 | 背景色 |
items | Array | 是 | 每个 tab 配置 |
每个 item 配置
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
pagePath | String | 是 | 设置页面路径 |
name | String | 是 | 名称 |
icon | String | 否 | 平常图标路径 |
activeIcon | String | 否 | 高亮图标路径 |
icon 推荐大小为 60*60px 大小,系统会对任意传入的图片非等比拉伸/缩放。
例如
{
"tabBar": {
"textColor": "#dddddd",
"selectedColor": "#49a9ee",
"backgroundColor": "#ffffff",
"items": [
{
"pagePath": "pages/index/index",
"name": "首页"
},
{
"pagePath": "pages/logs/logs",
"name": "日志"
}
]
}
}