微信小程序——自定义组件的使用以及组件之间的传值

自定义组件

创建

在项目的根目录中，鼠标右键，创建 components -> test 文件夹
在新建的 components -> test 文件夹上，鼠标右键，点击 新建 Component
键入组件的名称之后回车，会自动生成组件对应的 4 个文件，后缀名分别为 .js ， .json ， .wxml 和 .wxss
注意：为了保证目录结构的清晰，建议把不同的组件，存放到单独目录中

局部使用

在页面的 .json 配置文件中引用组件的方式，叫做 局部引用

 "usingComponents": {"组件名":"组件位置""my-test":"/components/test/test"
}

全局使用

在 app.json 全局配置文件中引用组件的方式，叫做 全局引用

{"pages":[],"window":{},"style": "v2","sitemapLocation": "sitemap.json","usingComponents": {"组件名":"组件位置""my-test1" :"/components/test/test"}
}

如果某组件在多个页面中经常被用到，建议进行 全局引用
如果某组件只在特定的页面中被用到，建议进行 局部引用

组件与页面的区别

组件和页面都是由 .js 、 .json 、 .wxml 和 .wxss 这四个文件组成的

组件和页面的 .js 与 .json 文件有明显的不同：

组件的 .json 文件中需要声明 "component": true 属性
组件的 .js 文件中调用的是 Component() 函数
- 整个程序启动调用的是 App()
- 某个页面的渲染调用的是 Page()
- 某个组件的渲染调用的是 Component()
组件的事件处理函数需要定义到 methods 节点中

组件的样式隔离

默认情况下，自定义组件的样式只对当前组件生效，不会影响到组件之外的 UI 结构
组件的样式不会影响页面的样式
组件A的样式也不会影响组件C的样式

好处

防止外界的样式影响组件内部的样式
防止组件的样式破坏外界的样式

注意点

app.wxss中全局样式对组件无效
只有class选择器会有隔离效果，属性选择器、标签选择器不受隔离的的影响
在组件和引用组件的页面中建议使用class选择器，不要使用id、属性、标签选择器

修改组件隔离

默认情况下，自定义组件的样式隔离特性能够防止组件内外样式互相干扰的问题。但有时，我们希望在外界能够控制组件内部的样式，此时，可以通过 styleIsolation 修改组件的样式隔离选项

Component({options:{styleIsolation:'isolated'}
})

可选值	默认值	描述
isolated	是	表示启用样式隔离
apply-shared	否	表示页面wxss样式将会影响到自定义组件
shared	否	表示页面wxss样式和自定义组件wxss的样式会相互影响

组件的数据、方法和属性

data数据

在小程序组件中，用于组件模板渲染的私有数据，需要定义到 data 节点中

// components/test/test.js
Component({/*** 组件的初始数据*/data: {count:0}
})

methods方法

在小程序组件中，事件处理函数和自定义方法需要定义到 methods 节点中

// components/test/test.js
Component({/*** 组件的方法列表*/methods: {//事件处理函数addCount(){//do something},//自定义方法_showCount(){//do something}}
})

自定义方法建议以_开头

properties属性

在小程序组件中， properties 是组件的对外属性，用来接收外界(父组件)传递到组件中的数据

// components/test/test.js
Component({/*** 组件的属性列表*/properties: {//第一种写法max：{type:Number,//属性的数据类型value:10 //属性默认值},//第二种写法min:Number
})

data与properties的区别

在小程序的组件中， properties 属性和 data 数据的用法相同，它们都是可读可写的，只不过：

data 更倾向于存储组件的私有数据
properties 更倾向于存储外界传递到组件中的数据
所以, 也不太建议修改 properties 数据,如果要修改 properties 的数据, 最好通过子组件通信给父组件的方式实现

console.log(this.data===this.properties) //true
//指向同一块内存地址

数据监听器(observers)

数据监听器用于监听和响应任何属性和数据字段的变化，从而执行特定的操作。它的作用类似于 vue 中的 watch 侦听器。

Components({observers:{"字段A,字段B" : function(字段A的新值,字段B的新值){//do something}}
})

监听对象属性的变化

数据监听器支持监听对象中单个或多个属性的变化

Components({observers:{"obj.a, obj.b" : function(newa,newb){//do somethingthis.setData({'obj.a':newa,'obj.b':newb})}}
})

监听对象中所有的属性的变化

Components({observers:{"obj.**" : function(obj){//do somethingthis.setData({'obj.a':obj.a,'obj.b':obj.b})}}
})

纯数据字段

纯数据字段 指的是那些 不用于界面渲染的 data 字段
某些 data 中的字段 既不会被展示在界面上，也不会传递给其他组件，仅仅在当前组件内部使用。带有这种特性的 data 字段适合被设置为纯数据字段
纯数据字段有助于提升页面更新的性能

使用

在 Component 构造器的 options 节点中，指定 pureDataPattern 为一个 正则表达式 ，字段名符合这个正则表达式的字段将会被视为纯数据字段

Component({options:{pureDataPattern:/^_/},data:{a:1,//普通字段_b:2 //纯数据字段}
} )

生命周期

生命周期	参数	描述
`created`	`无`	`在组件实例刚刚被创建时执行`
`attached`	`无`	`在组件实例进入页面节点树时执行`
ready	无	在组件在视图层布局完成后执行
moved	无	在组件实例被移动到节点树另一个位置时执行
`detached`	无	`在组件实例被从页面节点树移除时执行`
error	`Object Error`	每当组件方法抛出错误时执行

组件实例刚刚被创建好时， created 生命周期被触发
- 此时还不能调用 setData
- 通常情况下，这个生命周期只应该用于给组件 this 添加一些自定义属性字段
在组件完全初始化完毕、进入页面节点树后， attached 生命周期被触发
- this.data 已被初始化完毕
- 这个生命周期很有用，绝大多数初始化工作可以在这个时机进行
在组件离开页面节点树后， detached 生命周期被触发
- 退出一个页面时，会触发页面内每个自定义组件的detached 生命周期被触发
- 如果组件还在页面节点树中，则 detached 会被触发。
- 此时适合做一些清理性质的工作

lifetimes节点

生命周期方法可以直接定义在 Component 构造器的第一级参数中，组件的的生命周期也可以在 lifetimes 字段内进行声明（这是推荐的方式，其优先级最高）

lifetimes: {attached () {},detached () {console.log('在组件实例被从页面节点树移除')}
},attached () {console.log('~~~~~在组件实例进入页面节点树')
},
detached () {console.log('~~~~~在组件实例被从页面节点树移除')
},

组件所在页面的生命周期

自定义组件的行为依赖于页面状态的变化，此时就需要用到组件所在页面的生命周期

生命周期	参数	描述
show	无	组件所在的页面被展示时执行
hide	无	组件所在的页面被隐藏时执行
resize	`Object Size`	组件所在的页面尺寸变化时执行

pageLifetimes

组件所在页面的生命周期函数，需要定义在 pageLifetimes 节点中

Components({pageLifetimes:{show:function(){}, //页面被展示hide:function(){}, //页面被隐藏resize:function(size){} //页面尺寸变化}
})

插槽`slot`

在自定义组件的 wxml 结构中，可以提供一个节点（插槽），用于承载组件使用者提供的 wxml 结构

作为组件的封装者占位符

单个插槽

默认情况下，一个组件的 wxml 中只能有一个 slot
需要使用多 slot 时，可以在组件 js 中声明启用
注意：小程序中目前只有默认插槽和多个插槽，暂不支持作用域插槽

<!--test组件-->
<view>
<view>这是组件的内部节点</view><slot></slot> <!--插槽-->
</view>
<!--需要用到自定义组件的页面例如：page/home/home-->
<my-test>
<view>这是插槽的内容</view>
</my-test>

多个插槽

启用多个插槽

在小程序的自定义组件中，需要使用多插槽时，可以在组件的 .js 文件中

Component({options:{multipleSlots:true//开启多个插槽}
})

使用

<!--test组件-->
<view>
<slot name='before'></slot> <!--插槽-->
<view>这是组件的内部节点</view><slot name='after'></slot> <!--插槽-->
</view>
<!--需要用到自定义组件的页面例如：page/home/home-->
<my-test>
<view slot="before">这是before插槽的内容</view><view>---------------</view>
<view slot="after">这是after插槽的内容</view>
</my-test>

父子组件的通讯

属性绑定
- 用于父组件向子组件的指定属性设置数据，仅能设置 JSON 兼容的数据(只能传递数据，不能传递方法)
事件绑定
- 用于子组件向父组件传递数据，可以传递任意数据(包括数组和方法)
获取组件实例
- 父组件还可以通过 this.selectComponent() 获取子组件实例对象这样就可以直接访问子组件的任意数据和方法

属性绑定

属性绑定用于实现父向子传值，而且只能传递普通类型的数据，无法将方法传递给子组件

<!--test组件-->
<view><view>自定义组件</view>
</view>
properties:{
count:Number
}
<!--需要用到自定义组件的页面例如：page/home/home-->
data:{
count:0
}
<my-test count="{{count}}">
</my-test>

事件绑定

在 父组件 的 js 中，定义一个函数，这个函数即将通过自定义事件的形式，传递给子组件

//在父组件中自定义一个函数
syncCount(){}

在 父组件 的 wxml 中，通过自定义事件的形式，将步骤 1 中定义的函数引用，传递给子组件

<my-test count="{{count}}" bind:sync="syncCount"></my-test>

在 子组件的 js 中，通过调用 this.triggerEvent('自定义事件名称', {/* 参数对象 */})，将数据发送到父组件

addCount(){this.setData({count:this.properties.count+1})//调用this.triggerEvent()this.triggerEvent('sync',{value:this.properties.count})
}

在父组件的 js 中，通过 e.detail 获取到子组件传递过来的数据

syncCount(e){console.log(e);//是一个对象里面包含组件实例this.setData({count:e.detail.value//改变父组件的值})
}

获取组件实例

在父组件里调用 this.selectComponent("id或class选择器")，获取子组件的实例对象，从而直接访问子组件的任意数据和方法。调用时需要传入一个选择器

<!-- 父组件-->
<my-test count="{{count}}" bind:sync="syncCount" class="customA" id='customB'></my-test>
<button bindtap="getChild"></button>

getChild(){const  child= this.selectComponent('.customA')console.log(child);//组件实例child.setData({count:child.properties.count})child.addCount()//调用方法
}

behaviors

behaviors 是小程序中，用于实现组件间代码共享的特性，类似于 Vue.js 中的 mixins

每个 behaviors 可以包含一组属性、数据、生命周期函数和方法。组件引用它时，它的属性、数据和
方法会被合并到组件中
每个组件可以引用多个 behaviors ， behaviors 也可以引用其它 behaviors
只有当组件共享的代码(数据、方法)，就可以使用 behaviors 来共享，如果是组件私有的代码，就不需要放在behaviors 中

创建

调用 behaviors(Object object) 方法即可创建一个 共享的 behaviors 实例对象

在项目的根目录新建文件behaviors——>mybehaviors.js文件

// mybehaviors.jsmodule.exports = Behavior({data: {username: 'zs'},properties: {},methods: {}
})

使用

在组件中，使用 require() 方法导入需要的 behaviors，挂载后即可访问 behaviors 中的数据和方法

const mybehaviors = require('../../behaviors/mybehaviors')
Component({behaviors:[mybehaviors]
})<view>{{username}}</view>