.wxml、.wxss、.js、.json
文件组件的引用方式分为“局部引用”和“全局引用”,故名思义:
在页面的 .json
配置文件中引用组件的方式,叫做“局部引用”。示例代码如下:
// xx.json
{
"usingComponents": {
"my-test": "/components/test/test"
}
}
// xx.wxml
<my-test>my-test>
在 app.json
全局配置文件中引用组件的方式,叫做“全局引用”。示例代码如下:
// app.json
{
"usingComponents": {
"my-test": "/components/test/test"
}
}
// xx.wxml
<my-test>my-test>
根据组件的使用频率和范围,来选择合适的引用方式:
从表面来看,组件和页面都是由 .js、.json、.wxml、.wxss
这四个文件组成的。但是,组件和页面的 .js
与 .json
文件有明显的不同:
.json
文件中需要声明**"component": true
**属性.js
文件中调用的是 Component() 函数默认情况下,自定义组件的样式只对当前组件生效,不会影响到组件之外的 UI 结构。
好处:
app.wxss
中的全局样式对组件无效注意:在组件和引用组件的页面中建议使用 class 选择器,不要使用 id、属性、标签选择器!
默认情况下,自定义组件的样式隔离特性能够防止组件内外样式互相干扰的问题。但有时,需要在外界能够控制组件内部的样式,此时,可以通过 styleIsolation 修改组件的样式隔离选项,用法如下:
// xx.js
Component({
options: {
styleIsolation: 'isolated'
}
})
或
// xx.json
{
"styleIsolation": "isolated"
}
可选值 | 默认值 | 描述 |
---|---|---|
isolated | 是 | 表示启用样式隔离,在自定义组件内外,使用 class 指定的样式将不会相互影响 |
apply-shared | 否 | 表示页面 wxss 样式将影响到自定义组件,但自定义组件 wxss 中指定的样式不会影响页面 |
shared | 否 | 表示页面 wxss 样式将影响到自定义组件,自定义组件 wxss 中指定的样式也会影响页面和其他设置了 apply-shared 或 shared 的自定义组件 |
在小程序组件中,用于组件模板渲染的私有数据,需要定义到 data 节点中,示例如下:
// xx.js
Conponnet({
data: {}
})
在小程序组件中,事件处理函数和自定义方法需要定义到 methods 节点中,示例代码如下:
// xx.js
Component({
methods:{
functionName() {}, // 事件处理函数
_functionName() {} // 自定义方法建议以 _ 开头
}
})
在小程序组件中,properties 是组件的对外属性,用来接收外界传递到组件中的数据,示例代码如下:
// xx.js
Component({
properties: {
max: { // 完整方式
type: Number, // 属性类型
value: 10 // 默认值
},
max: Number // 简写方式
}
})
// xx.wxml
<my-test max="1">my-test>
在小程序的组件中,properties 属性和 data 数据的用法相同,它们都是可读可写的,只不过:
由于 data 数据和 properties 属性在本质上没有任何区别,因此 properties 属性的值也可以用于页面渲染,或使用 setData 为 properties 中的属性重新赋值。
数据监听器用于监听和响应任何属性和数据字段的变化,从而执行待定的操作。它的作用类似于 vue 中的 watch 侦听器。在小程序组件中,数据监听器的基本语法格式如下:
Componnet({
observers: {
'字段A, 字段B': function(字段A的新值, 字段B的新值) {
// do something
}
}
})
// xx.wxml
<view>{{n1}} + {{n2}} = {{sum}}view>
<button bindtap="addN1">n1自增button>
<button bindtap="addN2">n2自增button>
// xx.js
Component({
data: {
n1: 0,
n2: 0,
sum: 0
},
methods: {
addN1() {
this.setData({
n1: this.data.n1 + 1
})
},
addN2() {
this.setData({
n2: this.data.n2 + 1
})
}
},
observers: {
'n1, n2': function(n1, n2) {
this.setData({
sum: n1 + n2
})
}
}
})
数据监听器支持监听对象中单个或多个属性的变化,示例如下:
// xx.js
Componnet({
observers: {
'对象.属性A, 对象.属性B': function(属性A的新值, 属性B的新值) {
// 触发此监听器的3种情况:
// 1、为属性A赋值
// 2、为属性B赋值
// 3、为对象赋值
}
}
})
概念:纯数据字段指的是那些不用于界面渲染的 data 字段。
应用场景:有些情况下,某些 data 中的字段即不会展示在界面上,也不会传递给其他组件,仅仅在当前组件内部使用。带有这种特性的 data 字段适合被设置为纯数据字段。
好处:纯数据字段有助于提升页面更新的性能。
在 Component 构造器的 options 节点中,指定 pureDataPattern 为一个正则表达式,字段名符合这个正则表达式的字段将称为纯数据字段,示例代码如下:
// xx.js
Component({
options: {
// 指定所有 _ 开头的数据字段为纯数据字段
pureDataPattern: /^_/
},
data: {
a: true, // 普通数据字段
_b: true, // 纯数据字段
}
})
小程序组件可用的全部生命周期如下表所示:
生命周期函数 | 参数 | 描述说明 | 与vue对比 |
---|---|---|---|
created | 无 | 组件实例刚刚被创建时执行 | created |
attached | 无 | 组件实例进入页面节点树时执行 | mounted |
ready | 无 | 组件在视图层布局完成后执行 | |
moved | 无 | 组件实例被移动到节点树另一个位置时执行 | |
detached | 无 | 组件实例被从页面节点树移除时执行 | beforeDestroy |
error | Object Error | 组件方法抛出错误时执行 |
在小程序组件中,最重要的生命周期函数有3个,分别是 created、attached、detached。它们各自的特点如下:
在小程序组件中,生命周期函数可以直接定义在 Component 构造器的第一级参数中,可以在 lifetimes 字段内进行声明(这是推荐的方式,其优先级最高)。实例代码如下:
// xx.js
Componnet({
lifetimes: { // 【推荐】
// 在组件实例进入页面节点树时执行
attached() {},
// 在组件实例被从页面节点树移除时执行
detached() {}
},
// 以下是旧时的定义方法【不推荐】
attached() {},
detached() {}
})
有时,自定义组件的行为依赖于页面状态的变化,此时就需要用到组件所在页面的生命周期。
在自定义组件中,组件所在页面的声明周期函数有如下3个,分别是:
生命周期函数 | 参数 | 描述 |
---|---|---|
show | 无 | 组件所在的页面被展示时执行 |
hide | 无 | 组件所在的页面被隐藏时执行 |
resize | Object Size | 组件所在的页面尺寸变化时执行 |
组件所在页面的生命周期函数,需要定义在 pageLifetimes 节点中,示例代码如下:
// xx.js
Component({
pageLifetimes: {
// 页面被展示
show: function() {},
// 页面被隐藏
hide: function() {},
// 页面尺寸变化
resize: function() {}
}
})
在自定义组件的 wxml 结构中,可以提供一个
节点(插槽),用于承载组件使用者提供的 wxml 结构。
在小程序中,默认每个自定义组件中只允许使用一个
进行占位,这种个数上的限制叫做单个插槽。
<slot>slot>
<slotComponentName>
<view>这里是插入到组件slot中的内容view>
slotComponentName>
在小程序的自定义组件中,需要使用多
插槽时,可以在组件的 .js
文件中,通过如下方式进行启用。示例代码如下:
Component({
options: {
multipleSlots: true // 在组件定义时的选项中启用多 slot 支持
}
})
可以在组件的 .wxml
中使用多个
标签,以不同的 name 来区分不同的插槽。示例代码如下:
<slot name="slot1">slot>
<slot name="slot2">slot>
在使用带有多个插槽的自定义组件时,需要用 slot 属性来将节点插入到不同的
中。示例代码如下:
<slotComponentName>
<view slot="slot1">这里是插入到组件slot1中的内容view>
<view slot="slot2">这里是插入到组件slot2中的内容view>
slotComponentName>
this.selectComponent()
获取子组件实例对象属性绑定用于实现父向子传值,而且只能传递普通类型的数据,无法将方法传递给子组件。父组件的示例代码如下:
<sonComponent num="1">sonComponent>
子组件在 properties 节点中声明对应的属性并使用。示例代码如下:
Component({
properties: {
num: Number
}
})
事件绑定用于实现子向父传值,可以传递任何类型的数据。使用步骤如下:
在父组件的 .js
文件中,定义一个函数,这个函数即将通过自定义事件的形式,传递给子组件
Component({
sendData(){}
})
在父组件的 .wxml
文件中,通过自定义事件的形式,将步骤1中定义的函数引用,传递给子组件
<sonComponent bind:sendData="sendData">sonComponent>
<sonComponent bindsendData="sendData">sonComponent>
在子组件的 .js
文件中,通过调用 this.triggerEvent('自定义事件名称', {/*参数对象*/})
,将数据发送到父组件
<button bindtap="sendToFather">sendbutton>
// 子组件的 js 文件
Component({
data: {
a: 1
},
methods: {
sendToFather() {
this.triggerEvent('sendData', this.data.a)
}
}
})
在父组件的.js
文件中,通过e.detail
获取到子组件传递过来的数据
// 父组件的 js 文件
Component({
sendData(e) {
console.log(e.detail.value)
}
})
可在父组件里调用 this.selectComponent("id或class选择器")
,获取子组件的实例对象,从而直接访问子组件的任意数据和方法。
// 父组件的 js 文件
Component({
getChild() {
const child = this.selectComponnet('.sonComponent') // 只能传递 id 或 class 选择器
child.setData({ // 调用子组件的 setData 方法(也可以调用其他方法)
count: child.data.count + 1
})
}
})
behaviors 是小程序中,用于实现组件间代码共享的特性,类似于 Vue 中的“mixins”。
每个 behavios 可以包含一组属性、数据、生命周期函数和方法。组件引用它时,它的属性、数据和方法会被合并到组件中。
每个组件可以引用多个 behaviors,behaviors 也可以引用其他 behaviors。
在项目根目录创建 behaviors 文件夹,然后创建对应的 js 文件
调用 Behavior(Object object)
方法即可创建一个共享的 behavior 实例对象,供所有的组件使用:
// 调用 Behavior() 方法,创建实例对象
// 并使用 module.exports 将 behavior 实例对象共享出去
module.exports = Behavior({
data: {},
methods: {}
})
在组件中,使用 require()
方法导入需要的 behavior,挂载后即可访问 behavior 中的数据或方法,示例代码如下:
// 导入 behavior 模块
const demo = require("../../behaviors/demo")
Component({
// 挂载 behaviors
behaviors: [demo]
})
可用的节点 | 类型 | 是否必填 | 描述 |
---|---|---|---|
properties | Object Map | 否 | 同组件的属性 |
data | Object | 否 | 同组件的数据 |
methods | Object | 否 | 同自定义组件的方法 |
behaviors | String Array | 否 | 引入其它的 behavior |
created | Function | 否 | 生命周期函数 |
attached | Function | 否 | 生命周期函数 |
ready | Function | 否 | 生命周期函数 |
moved | Function | 否 | 生命周期函数 |
detached | Function | 否 | 生命周期函数 |
组件和它引用的 behavior 中可以包含同名的字段,此时可以参考如下3种同名时的处理规则:
关于详细的覆盖和组合规则,可以参考微信小程序官方文档说明
自定义 tabBar 分为3大步骤,分别是:
配置信息
app.json
中的 tabBar 项指定 custom 字段,同时其余 tabBar 相关配置也补充完整。app.json
全局开启。// app.json
{
"tabBar": {
"custom": true,
}
}
添加 tabBar 代码文件
在代码根目录下添加入口文件:
custom-tab-bar/index.js
custom-tab-bar/index.json
custom-tab-bar/index.wxml
custom-tab-bar/index.wxss
编写 tabBar 代码
详细步骤,参考小程序官方文档
目前,小程序中已经支持使用 npm 安装第三方包,从而来提高小程序的开发效率。但是,在小程序中使用 npm 包有如下3个限制:
PS:虽然 npm 上的包有很多,但是能供小程序使用的包却不多。
Vant Weapp 是有赞前端团队开源的一套小程序 UI 组件库,助力开发者快速搭建小程序应用。它所使用的是 MIT 开源许可协议,对商业使用比较友好。
官网文档地址
在小程序项目(JS,如果是 TS 则是4步)中,安装 Vant 组件库主要分为如下3步:
通过 npm 安装(建议指定版本为@1.3.3)
npm i @vant/[email protected] -S --production
使用前如果没有包管理配置文件——package.json,则需要先初始化一个
npm init -y
构建 npm 包
修改 app.json
将
app.json
中的"style": "v2"
去除,小程序的新版基础组件强行加上了许多样式,难以覆盖,不关闭将造成部分组件样式混乱。
详细的操作步骤,参考 Vant 官方提供的快速上手教程
安装完 Vant 组件库之后,可以在 app.json
的 usingComponents 节点中引入需要的组件,即可在 wxml 中直接使用组件。示例代码如下:
// app.json
{
"usingComponents": {
"van-button": "@vant/weapp/button/index"
}
}
Vant Weapp 使用 CSS 变量来实现定制主题。关于 CSS 变量的基本用法,参考 MDN 文档。
html {
/* 自定义 CSS 变量,选择器即为作用域 */
--main-color: #C00000;
}
.box1 {
/* 使用自定义 CSS 变量 */
color: var(--main-color);
}
在自定义组件中使用 Vant Weapp 组件时,需在对应的 js 文件中开启
styleIsolation: 'shared'
选项
在 app.wxss
中,写入 CSS 变量,即可对全局生效:
// app.wxss
page {
/* 定义警告按钮的背景颜色和边框颜色 */
--button-danger-background-color: #C00000;
--button-danger-border-color: #D60000;
}
详情见官网文档。(使用的如果是 CSS 需要将开头的 @ 改为–,less则不需要更改)
默认情况下,小程序官方提供的异步 API 都是基于回调函数实现的。例如,网络请求的 API 需要按照如下的方式调用:
wx.request({
url: '',
method: '',
data: {},
success: () => {}, // 请求成功的回调函数
fail: () => {}, // 请求失败的回调函数
complete: () => {} // 请求完成的回调函数
})
缺点:容易造成回调地狱的问题,代码的可读性、维护性差!
API Promise化,指的是通过额外的配置,将官方提供的、基于回调函数的异步 API,升级改造为基于 Promise 的异步 API,从而提高代码的可读性、维护性,避免回调地狱的问题。
在小程序中,实现 API Promise 化主要依赖于 miniprogram-api-promise 这个第三方的 npm 包。它的安装和使用步骤如下:
安装
npm i --save [email protected]
在小程序中每次安装一个包,都需要先将以前的 npm 包给删除了,再次点击工具 -> 构建 npm。
使用
// app.js
import { promisifyAll } from 'miniprogram-api-promise'
const wxp = wx.p = {}
promisifyAll(wx, wxp)
<button bindtap="getInfo">按钮button>
// 页面的 js 文件
Page({
async getInfo() {
const { data: res } = await wx.p.request({
method: 'GET',
url: 'https://www.escook.cn/api/get',
data: { name: 'zs', age: 20 }
})
}
})
全局数据共享(又叫做:状态管理)是为了解决组件之间数据共享的问题。
开发中常用的全局数据共享方案有:Vue、Redux、MobX 等。
在小程序中,可使用 mobx-miniprogram 配合 mobx-miniprogram-bindings 实现全局数据共享。其中:
在项目中运行如下的命令,安装 MobX 相关的包:
npm i --save [email protected] [email protected]
MobX 相关的包安装完毕之后,记得删除 miniprogram_npm 目录后,重新构建 npm
在项目根目录下创建 store 文件夹,再创建 store.js 文件
// store/store.js
// 在这个 js 文件中,专门用来创建 Store 实例对象
import { action, observable } from 'mobx-miniprogram'
export const store = observable({
// 数据字段
numA: 1,
numB: 2,
// 计算属性
get sum() {
return this.numA + this.numB
},
// actions 方法,用来修改 store 中的数据
updateNum1: action(function(step) {
this.numA += step
}),
updateNum2: action(function(step) {
this.numB += step
}),
})
// 页面的 js 文件
import { createStoreBindings } from 'mobx-miniprogram-bindings'
import { store } from '../../store/store'
Page({
onLoad: function() {
this.storeBindings = createStoreBindings(this, {
store, // 指定要绑定的 Store
fields: ['numA', 'numB', 'sum'], // 指定要绑定的字段数据
actions: ['updateNum1'] // 指定要绑定的方法
})
},
onUnload: function() {
this.storeBindings.destroyStoreBindings()
}
})
<view>{{numA}} + {{numB}} = {{sum}}view>
<button bindtap="btnHandler1" data-step="{{1}}">numA+1button>
<button bindtap="btnHandler1" data-step="{{-1}}">numA-1button>
// 页面的 js 文件
Page({
btnHandler1(e) {
this.updateNum1(e.target.dataset.step) // e.target.dataset:获取点击元素的自定义属性(data-开头)
}
})
import { storeBindingsBehavior } from 'mobx-miniprogram-bindings'
import { store } from '../../store/store'
Componnet({
behaviors: [storeBindingsBehavior], // 通过 storeBindingsBehavior 来实现自动给绑定
storeBindings: {
store, // 指定要绑定的 Store
fields: { // 指定要绑定的字段数据
numA: () => store.numA, // 绑定字段的第1种方式
numB: (store) => store.numB, // 绑定字段的第2种方式
sum: 'sum' // 绑定字段的第3种方式(推荐)
},
actions: { // 指定要绑定的方法
updateNum2: 'updateNum2'
}
}
})
和在页面中一样。
组件中的方法要单独放在 methods 中
分包指的是把一个完整的小程序项目,按照需求划分为不同的子包,在构建时打包成不同的分包,用户在使用时按需进行加载。
分包前,小程序项目中所有的页面和资源都被打包到了一起,导致整个项目体积过大,影响小程序首次启动的下载时间。
分包后,小程序项目由1个主包+多个分包组成:
- app.js
- app.json
- app.wxss
- pages:主包的所有页面
- index
- logs
- packageA:第一个分包
- pages:第一个分包的所有页面
- cat
- dog
- packageB:第二个分包
- pages:第二个分包的所有页面
- apple
- banana
- utils
// 在 app.json 的 subpackages 节点中声明分包的结构
{
"pages": [ // 主包的所有页面
"pages/index/index",
"pages/logs/index"
],
"subpackages": [ // 通过 subpackages 节点,声明分包的结构
{
"root": "packageA", // 第一个分包的根目录
"pages": [ // 当前分包下,所有页面的相对存放路径
"pages/cat/cat",
"pages/dog/dog"
]
},{
"root": "packageB", // 第一个分包的根目录
"name": "pack2", // 分包的别名
"pages": [ // 当前分包下,所有页面的相对存放路径
"pages/apple/apple",
"pages/banana/banana"
]
}
]
}
独立分包本质上也是分包,只不过它比较特殊,可以独立于主包和其他分包而单独运行。
最主要的区别:是否依赖于主包才能运行
开发者可以按需,将某些具有一定功能独立性的页面配置到独立分包中。原因如下:
一个小程序中可以拥有多个独立分包
// 在 app.json 的 subpackages 节点中声明分包的结构
{
"subpackages": [
{
"root": "packageB", // 第一个分包的根目录
"name": "pack2", // 分包的别名
"pages": [ // 当前分包下,所有页面的相对存放路径
"pages/apple/apple",
"pages/banana/banana"
],
"independent": true // 通过此节点,声明当前 packageB 分包为”独立分包“
}
]
}
独立分包和普通分包以及主包之间的区别,是相互隔绝的,不能相互应用彼此的资源!例如:
分包预下载指的是:在进入小程序的某个页面时,由框架自动预下载可能需要的分包,从而提升进入后续分包页面时的启动速度。
预下载分包的行为,会在进入指定的页面时触发。在 app.json
中,使用 preloadRule 节点定义分包的预下载规则,示例代码如下:
// app.json
{
"preloadRule": { // 分包预下载的规则
"pages/contact/contact": { // 触发分包预下载的页面路径
// network:表示在指定的网络模式下进行预下载
// 可选值为:all(不限网络)和wifi【默认】(仅wifi模式下进行预下载)
"network": 'all',
// packages:表示进入页面后,预下载哪些分包
// 可以通过 root 或 name 指定预下载哪些分包
"packages": ["pack1"]
}
}
}
同一个分包中的页面享有共同的预下载大小限额2M,例如: