在页面的 .json 配置文件中引用组件的方式,叫做局部引用。示例代码如下:
# 在页面的 .json 文件中,引入组件
{
"usingComponents": {
"my-test": "/components/test/test"
}
}
# 在页面的 .wxml 文件中,使用组件
在 app.json 全局配置文件中引用组件的方式,叫做全局引用。示例代码如下:
# 在 app.json 文件中,引入组件
{
"usingComponents": {
"my-test": "/components/test/test"
}
}
根据组件的使用频率和范围,来选择合适的引用方式:
从表面来看,组件和页面都是由 .js、.json、.wxml 和 .wxss 这四个文件组成的。但是,组件和页面的 .js 与 .json 文件有明显的不同:
默认情况下,自定义组件的样式隔离特性能够防止组件内外样式互相干扰的问题。但有时,我们希望在外界能够控制组件内部的样式。此时,可以通过 stylelsolation 修改组件的样式隔离选项,用法如下:
# 在组件的 .js 文件中新增如下配置
Component({
options: {
stylelsolation: 'isolated'
}
})
# 或在组件的 .json 文件中新增如下配置
{
"stylelsolation": "isolated"
}
| 可选值 | 默认值 | 描述 |
| :----------: | :----: | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
| isolated | 是 | 表示启用样式隔离 | 表示启用样式隔离,在自定义组件内外,使用 class 指定的样式将不会互相影响 |
| apply-shared | 否 | 表示页面 wxss 样式将影响到自定义组件,但自定义组件 wxss 中指定的样式不会影响页面 |
| shared | 否 | 表示页面 wxss 样式将影响到自定义组件,自定义组件 wxss 中指定的样式也会影响页面和其他设置了 apply-shared 或 shared 的自定义组件 |
在小程序组件中,用于组件模板渲染和私有数据,需要定义到 data 节点中,示例如下:
Component({
data: {
count: 0
}
})
在小程序组件中,事件处理函数和自定义方法需要定义到 methods 节点中,示例代码如下:
Component({
methods: {
addCount() {
this.setData({count: this.data.count + 1});
this._showCount()
},
_showCount() {
wx.showToast({
title: 'count值为:' + this.data.count,
icon: 'none'
})
}
}
})
在小程序组件中,properties 是组件的对外属性,用来接收外界传递到组件中的数据,示例代码如下:
Component({
properties: {
max: {
type: Number,
value: 10
},
max: Number
}
})
在小程序的组件中,properties 属性和 data 数据的用法相同,它们都是可读可写的,只不过:
Component({
methods: {
showInfo() {
console.log(this.data === this.properties)
}
}
})
由于 data 数据和 properties 属性在本质上没有任何区别,因此 properties 属性的值也可以用于页面渲染,或使用 setData 为 properties 中的属性重新赋值,示例代码如下:
# 在组建的 .wxml 文件中使用 properties 属性的值
max属性的值为:{{max}}
Component({
properties: { max: Number },
methods: {
addCount() {
this.setData({ max: this.properties.max + 1 })
}
}
})
数据监听器用于监听和响应任何属性和数据字段的变化,从而执行特定的操作。它的作用类似于 vue 中的 watch 侦听器。在小程序组件中,数据监听器的基本语法格式如下:
Component({
observers: {
'字段A, 字段B': function(字段A的心智, 字段B的新值) {
}
}
})
Component({
data: { n1: 0, n2: 0, sum: 0 },
methods: {
addN1() { sthis.setData({ n1: this.data.n1 + 1 })},
addN2() { sthis.setData({ n2: this.data.n2 + 1 })}
},
observers: {
'n1, n2': function(n1, n2) {
this.setData({sum: n1 + n2})
}
}
})
# 数据监听器支持监听对象中单个或多个属性的变化,示例代码如下:
Component({
observers: {
'对象.属性A, 对象.属性B': function(属性A的新值, 属性B的心智){}
}
})
# 监听对象中所有属性的变化
Component({
observers: {
'obj.**': function(obj){}
}
})
纯数据字段指的是那些不用于界面渲染的 data 字段。
应用场景:例如有些情况下,某些 data 中的字段既不会展示在界面上,也不会传递给其他组件,仅仅在当前组件内部使用。带有这种特性的 data 字段适合备设置为储数据字段
好处:纯数据字段有助于提升页面更新的性能
在 Component 构造器的 options 节点中,指定 pureDataPattern 为一个正则表达式,字段名符合这个正则表达式的字段将成为纯数据字段,示例代码如下:
Component({
options: {
pureDataPattern: /^_/
},
data: {
a: true, // 普通数据字段
_b: true // 纯数据字段
}
})
生命周期函数 | 参数 | 描述说明 |
---|---|---|
created | 无 | 在组件实例刚刚被创建时执行 |
attached | 无 | 在组件实例进入页面节点树时执行 |
ready | 无 | 在组件视图层布局完成后执行 |
moved | 无 | 在组件实例备移动到节点树另一个位置时执行 |
detached | 无 | 在组件实例被从页面节点树移除时执行 |
error | Object Error | 每当组件方法抛出错误时执行 |
在小程序组件中,最重要的生命周期函数有 3 个,分别是 created、attached、detached。它们各自的特点如下:
在小程序组件中,生命周期函数可以直接定义在 Component 构造器的第一级参数中,可以在 lifetimes 字段内进行声明(这是推荐的方式,其优先级最高)。示例代码如下:
Component({
lifetimes: {
attached() {}, // 在组件实例进入页面节点树时执行
detached() {}, // 在组件实例被从页面节点树移除时执行
},
attached() {}, // 在组件实例进入页面节点树时执行
detached() {}, // 在组件实例被从页面节点树移除时执行
})
有时,自定义组件的行为依赖于页面状态的变化,此时就需要用到组件所在页面的生命周期
生命周期函数 | 参数 | 描述 |
---|---|---|
show | 无 | 组件所在的页面被展示时执行 |
hide | 无 | 组件所在的页面被隐藏时执行 |
resize | Object Size | 组件所在的页面尺寸变化时执行 |
# 组件所在页面的生命周期函数,需要定义在 pageLifetimes 节点中
Component({
pageLifetimes: {
show: function() {}, // 页面被展示
hide: function() {}, // 页面被隐藏
resize: function(size) {} // 页面尺寸变化
}
})
在自定义组件的 wxml 结构中,可以提供一个 slot 节点(插槽),用于承载组件使用者提供的 wxml 结构。
在小程序中,默认每个自定义组件中只允许使用一个 slot 进行占位,这种个数上限制叫做单个插槽
这里是组件的内部节点
这里是插入到组件slot中的内容
在小程序的自定义组件中,需要使用多个 slot 插槽是,可以在组件的 .js 文件中,通过如下方式进行启用,示例代码如下:
Component({
options: {
multipleSlots: true // 在组件定义时,启用多个 slot 支持
}
})
可以在组件的 .wxml 中使用多个 slot 标签,以不同的 name 来区分不同的插槽。示例代码如下:
这是一段固定的文本内容
在使用带有多个插槽的自定义组件时,需要用 slot 属性来将节点插入到不同的 slot 中。示例代码如下:
这里是插入到组件 slot name="before"中的内容
这里是插入到组件 slot name="after"中的内容
属性绑定用于实现父向子传值,而且只能传递普通类型的数据,无法将方法传递给子组件。父组件的示例代码如下:
data: {
count: 0
}
properties: {
count: Number
}
子组件种,count值为:{{count}}
事件绑定用于实现子向父传值,可以传递任何类型的数据。使用步骤如下:
syncCount() {
console.log('syncCount')
}
子组件中,count:{{count}}
# 子组件的 js 代码
methods: {
addCount() {
this.setData({
count: this.properties.count + 1
})
this.triggerEvent('sync', { value: this.properties.count })
}
}
syncCount(e) {
this.setData({
count: e.detail.value
})
}
可在父组件里调用 this.selectComponent(‘id 或 class 选择器’),获取子组件的实例对象,从而直接访问子组件的任意数据和方法。
getChild() {
const child = this.selectComponent('.test')
child.setData({ count: child.properties.count + 1 })
child.addCount()
}
behaviors 是小程序中,用于实现组件间代码共享的特性,类似于 Vue.js 中的 mixins
每个 behavior 可以包含一组属性、数据、生命周期函数和方法。组件引用它时,它的属性、属性和方法会被合并到组件中。
每个组件可以引用多个 behavior,behavior 也可以引用其它 behavior
调用 Behavior(Object object) 方法即可创建一个共享的 behavior 实例对象,供所有的组件使用
# 调用 Behavior() 方法,创建实例对象
# 并使用 module.exports 将 behavior 实例对象共享出去
module.exports = Behavior({
# 属性节点
properties: {},
# 私有数据节点
data: {},
# 事件处理函数和自定义方法节点
methods: {}
})
在组件中,使用 require() 方法导入需要的 behavior,挂载后即可访问 behavior 中的数据或方法,示例代码如下:
# 使用 require() 导入需要自定义 behavior 模块
const myBehavior = require('my-behavior')
Component({
behaviors: [myBehavior]
})
可用的节点 | 类型 | 描述 |
---|---|---|
properties | Object Map | 同组件的属性 |
data | Object | 同自定义组件的方法 |
behaviors | String Array | 引入其它的 behavior |
created | Function | 生命周期函数 |
attached | Function | 生命周期函数 |
ready | Function | 生命周期函数 |
moved | Function | 生命周期函数 |
detached | Function | 生命周期函数 |
目前,小程序已经支持使用 npm 安装第三方包,从而来提高小程序的开发效率。但是,在小程序中使用 npm 包有如下 3 个限制:
默认情况下,小程序官方提供的异步 API 都是基于回调函数实现的,例如,网络请求的 API 需要按照如下的方式调用:
wx.request({
method: '',
url: '',
data: {},
success: () => {}
})
缺点:容易造成回调地狱的问题,代码的可读性、维护性差
API Promise 化,指定是通过额外的配置,将官方提供的、基于回调函数的异步 API,升级改造为基于 Promise 的异步 API,从而提高代码的可读性、维护性、避免回调地狱的问题
在小程序中,实现 API Promise 化主要依赖于 minprogram-api-promise 这个第三方的 npm 包。它的安装和使用步骤如下:
npm install --save minprogram-api-promise
# 在小程序入口文件中(app.js),只需要调用一次 promisifyAll() 方法
import { promisifyAll } from 'minprogram-api-promise'
const wxp = wx.p = {}
promisifyAll(wx, wxp)
# 页面的 .wxml 结构
# 在页面的 .js 文件中,定义对应的 tap 事件处理函数
async getInfo() {
const { data: res } = await wx.p.request({
method: 'GET',
url: '',
data: {}
})
}
全局数据共享(又叫做:状态管理)是为了解决组件之间数据共享的问题
开发中常用的数据共享方案有:Vuex、Redux、MobX 等
在小程序中,可使用 mobx-miniprogram 配合 mobx-miniprogram-bindings 实现全局数据共享。其中:
# 在项目运行如下的命令,安装MobX相关的包
npm install --save mobx-miniprogram mobx-miniprogram-bindings
注意:MobX 相关的包安装完毕之后,记得删除 miniprogram_npm 目录后,重新构建 npm
import { observable, action } from 'mobx-miniprogram'
export const store = observable({
// 数据字段
numA: 1,
numB: 2,
//计算属性
get sum() {
return this.numA + this.numB
},
// actions 方法,用来修改 store 中的数据
updateNumA: action(function(step) {
this.numA += step
}),
updateNumB: action(function(step) {
this.numB += step
}),
})
# 页面的 .js 文件
import { createStoreBindings } from 'mobx-miniprogram-bindings'
import { store } from './store'
Page({
onLoad() {
this.storeBindings = createStoreBindings(this, {
store,
fields: ['numA', 'numB', 'sum'],
actions: ['updateNumA']
})
},
onUnload() {
this.storeBindings.destroyBindings()
}
})
# 页面的 .wxml
{{numA}} + {{numB}} = {{sum}}
numA + 1
numA - 1
btnHandler(e) {
this.updateNumA(e.target.dataset.step)
}
import { storeBindingsBehavior } from 'mobx-miniprogram-bindings'
import { store } from './store'
Component({
behaviors: [storeBindingsBehavior],
storeBindings: {
store,
fields: {
numA: () => store.numA,
numB: (store) => store.numB,
sum: 'sum'
},
actions: {
updateNumA: 'updateNumA'
}
}
})
# 组件的 .wxml 结构
{{numA}} + {{numB}} = {{sum}}
numA + 1
numA - 1
btnHandler(e) {
this.updateNumA(e.target.dataset.step)
}