微信小程序自定义组件

合集 - 微信小程序学习(8)

1.微信小程序常用的view、text、button、image组件2023-05-282.微信小程序 - WXML 模板语法2023-05-293.微信小程序 WXSS模板样式，全局和页面配置，网络请求2023-05-304.微信小程序 - 视图与逻辑2023-06-01

5.微信小程序自定义组件2023-06-07

6.微信小程序 npm包、全局数据共享、分包2023-06-097.uniapp学习(一)2023-06-298.uniapp学习（二）2023-06-30

收起

• 组件的创建与引用
  • 1. 创建组件
  • 2. 引用组件
  • 3. 局部引用组件
  • 4. 全局引用组件
  • 5. 全局引用 VS 局部引用
  • 6. 组件和页面的区别
• 样式
  • 1. 组件样式隔离
  • 2. 组件样式隔离的注意点
  • 3. 修改组件的样式隔离选项
  • 4. styleIsolation 的可选值
• 数据、方法和属性
  • 1. data 数据
  • 2. methods 方法
  • 3. properties 属性
  • 4. data 和 properties 的区别
  • 5. 使用 setData 修改 properties 的值
• 数据监听器
• 2. 数据监听器的基本用法
  • 3. 监听对象属性的变化
• 案例
• 纯数据字段
  • 1. 什么是纯数据字段
  • 2. 使用规则
  • 3. 使用纯数据字段改造数据监听器案例
• 组件的生命周期
  • 1. 组件全部的生命周期函数
  • 2. 组件主要的生命周期函数
  • 3. lifetimes 节点
• 组件所在页面的生命周期
  • 1. 什么是组件所在页面的生命周期
  • 2. pageLifetimes 节点
  • 3. 生成随机的 RGB 颜色值
• 插槽
  • 1. 什么是插槽
  • 2. 单个插槽
  • 3. 启用多个插槽
  • 4. 定义多个插槽
  • 4. 使用多个插槽
• 父子组件之间的通信
  • 2. 属性绑定
  • 3. 事件绑定
  • 步骤4
• behaviors
  • 1. 什么是 behaviors
  • 2. behaviors 的工作方式
  • 3. 创建 behavior
  • 4. 导入并使用 behavior
  • 5. behavior 中所有可用的节点(都是非必选)
  • 6. 同名字段的覆盖和组合规则*

【黑马程序员前端微信小程序开发教程，微信小程序从基础到发布全流程_企业级商城实战(含uni-app项目多端部署)】 https://www.bilibili.com/video/BV1834y1676P/?p=63&share_source=copy_web&vd_source=03c1dc52eeb3747825ecad0412c18ab1

自定义组件

组件的创建与引用

1. 创建组件

① 在项目的根目录中，鼠标右键，创建 components -> test 文件夹
② 在新建的 components -> test 文件夹上，鼠标右键，点击“新建 Component”
③ 键入组件的名称之后回车，会自动生成组件对应的 4 个文件，后缀名分别为 .js，.json， .wxml 和 .wxss

注意：为了保证目录结构的清晰，建议把不同的组件，存放到单独目录中。
也就是Components文件夹里放自定义组件，这些组件以不同的文件夹划分，每个文件夹都是个组件

2. 引用组件

组件的引用方式分为“局部引用”和“全局引用”，顾名思义：

• 局部引用：组件只能在当前被引用的页面内使用
• 全局引用：组件可以在每个小程序页面中使用

3. 局部引用组件

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

{
  "usingComponents": {
      "my-test":"/components/test/test"
  }
}

<my-test></my-test>

4. 全局引用组件

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

//app.json
 "usingComponents": {
    "test2":"/components/test/test"
  }

<test2></test2>

5. 全局引用 VS 局部引用

根据组件的使用频率和范围，来选择合适的引用方式：

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

6. 组件和页面的区别

从表面来看，组件和页面都是由 .js、.json、.wxml 和 .wxss 这四个文件组成的。但是，组件和页面的 .js 与.json 文件有明显的不同：

• 组件的 .json 文件中需要声明 "component": true 属性
• 组件的 .js 文件中调用的是 Component() 函数
• 组件的事件处理函数需要定义到 methods 节点中

样式

这里第一点和第二点讲的不是一个方面，不要晕了

1. 组件样式隔离

默认情况下，自定义组件的样式只对当前组件生效，不会影响到组件之外的
UI 结构，比如：
这里有个小程序页面，里面还有两个自定义组件A和C

• 组件 A 的样式不会影响组件 C 的样式
• 组件 A 的样式不会影响小程序页面的样式
• 小程序页面的样式不会影响组件 A 和 C 的样式

好处：
① 防止外界的样式影响组件内部的样式
② 防止组件的样式破坏外界的样式

2. 组件样式隔离的注意点

这个地方讲的是全局样式对组件样式的影响

• app.wxss 中的全局样式 class 选择器对组件无效
• 但id 选择器、属性选择器、标签选择器可以影响到组件

建议：在组件和引用组件的页面中建议使用 class 选择器，不要使用 id、属性、标签选择器！

3. 修改组件的样式隔离选项

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

//组件的 .js文件 ，也是官方文档的推荐方法
Component({
    options:{
        styleIsolation:"isolated"
    }
})
//组件的 .json文件 

"styleIsolation":"isolated"

4. styleIsolation 的可选值

默认值：

• isolated 表示启用样式隔离，在自定义组件内外，使用 class 指定的样式将不会相互影响

可选：

• apply-shared 表示页面 wxss 样式将影响到自定义组件，但自定义组件 wxss 中指定的样式不会影响页面
• shared 表示页面 wxss 样式将影响到自定义组件，自定义组件 wxss 中指定的样式也会影响页面和其他设置了 apply-shared 或 shared 的自定义组件

冲突样式：组件>页面>全局

数据、方法和属性

1. data 数据

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

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

2. methods 方法

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

<!-- 组建的wxml -->
<view>
    count的值是{{ count }}
</view>
<button bindtap="addCount">+1</button>

//组建的js
methods: {
        //事件处理函数
        addCount(){
            this.setData({
                count:this.data.count +1
            })
         //通过this直接调用自定义方法
            this._showCount()
        },
        //自定义方法建议以_开头
        _showCount(){
            //弹框提示
            wx.showToast({
                title: 'count:' + this.data.count,
                icon:'none'
            })
        }
    },

记得把这个组件放进某个页面里，就能看见效果了

3. properties 属性

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

properties: {
        //指定属性默认值
        max:{
            type:Number,
            value:10
        },
        //不指定属性默认值
        min: Number
    },

哪怕指定默认值也可以在传值的时候进行覆盖

<test2 max="20" min="9"></test2>

4. data 和 properties 的区别

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

• data 更倾向于存储组件的私有数据
• properties 更倾向于存储外界传递到组件中的数据

5. 使用 setData 修改 properties 的值

由于 data 数据和 properties 属性在本质上没有任何区别，因此 properties 属性的值也可以用于页面渲染，或使用 setData 为 properties 中的属性重新赋值

<!-- 组建的wxml -->
<button bindtap="addCount">+1</button>
<view>
    最小值是{{min}}
</view>

//wxjs
properties: {
    //不指定属性默认值
    min: Number
},
 /**
     * 组件的方法列表
     */
methods: {
    addCount(){
       this.setData({ 
           min:this.properties.min +1 
       })
    },
},

数据监听器

1. 什么是数据监听器
   数据监听器用于监听和响应任何属性和数据字段的变化，从而执行特定的操作。它的作用类似于 vue 中的watch 侦听器。在小程序组件中，数据监听器的基本语法格式如下

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

2. 数据监听器的基本用法

<!--wxml-->
<view>
    n1:{{n1}}
</view>
<view>
    n2:{{n2}}
</view>
<view>
sum : {{sum}}
</view>
<button bindtap="addN1">n1 +1</button>
<button bindtap="addN2">n2 +1</button>

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
           })
        }
    }
})

3. 监听对象属性的变化

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

'对象.属性A,对象.属性B': function(属性A的新值,属性B的新值){
        // 触发此监听器的 3种情况
        //[为属性A赋值]使用setData 设置 this.data.对象.属性A 时触发
        //[为属性B赋值]使用setData 设置 this.data.对象.属性B 时触发
        //[直接为对象赋值]使用setData 设置 this.data.对象 时触发
        // do something
        }

案例

<!-- wxml -->
<view class="test" style="background-color: rgb({{fullColor}});">
    颜色的rgb值是 {{ fullColor }}
</view>
<button bindtap="changeR" type="default">R</button>
<button bindtap="changeG" type="primary">G</button>
<button bindtap="changeB" type="warn">B</button>

/* wxss */
.test{
    height: 250rpx;
    width: 100%;
    color: rgb(216, 215, 215);
    text-align: center;
    line-height: 250rpx;
    text-shadow: 0rpx 0rpx 1rpx black;
}

//wxjs
/**
     * 组件的初始数据
     */
    data: {
     rgb:{
         r:0,
         g:0,
         b:0
     },
     fullColor:'0,0,0'
    },

    /**
     * 组件的方法列表
     */
    methods: {
        changeR(){
            this.setData({
                'rgb.r': this.data.rgb.r+5>255? 0:this.data.rgb.r+5
            })
        },
        changeG(){
            this.setData({
                'rgb.g': this.data.rgb.g+5>255? 0:this.data.rgb.g+5
            })
        },
        changeB(){
            this.setData({
                'rgb.b': this.data.rgb.b+5>255? 0:this.data.rgb.b+5
            })
        }
    },
    observers:{
        'rgb.r,rgb.g,rgb.b':function(r,g,b){
            this.setData({
                fullColor:`${r},${g},${b}`
            })
        }
	}

如果某个对象中需要被监听的属性太多，为了方便，可以使用通配符 **来监听对象中所有属性的变化。

'rgb.**':function(obj){
            this.setData({
                fullColor:`${obj.r},${obj.g},${obj.b}`
            })
        }

纯数据字段

1. 什么是纯数据字段

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

2. 使用规则

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

options:{
        //指定所有 _ 开头的数据字段为纯数据字段
        pureDataPattern:/^_/
    },
 data: {
     a:true, //普通数据字段
     _b:true //纯数据字段
    },

3. 使用纯数据字段改造数据监听器案例

wxml不用动，因为它不涉及到rgb字段的值，改改js就行。
改起来也很简单，指定所有 _ 开头的数据字段为纯数据字段。
先把data里的rgb 变成 _rgb,然后把涉及到rgb的统统改成_rgb

data: {
     _rgb:{
         r:0,
         g:0,
         b:0
     },
     fullColor:'0,0,0'
    },

    /**
     * 组件的方法列表
     */
    methods: {
        changeR(){
            this.setData({
                '_rgb.r': this.data._rgb.r+5>255? 0:this.data._rgb.r+5
            })
        },
        changeG(){
            this.setData({
                '_rgb.g': this.data._rgb.g+5>255? 0:this.data._rgb.g+5
            })
        },
        changeB(){
            this.setData({
                '_rgb.b': this.data._rgb.b+5>255? 0:this.data._rgb.b+5
            })
        }
    },
    options:{
        //指定所有 _ 开头的数据字段为纯数据字段
        pureDataPattern:/^_/,
    },
    observers:{
        '_rgb.**':function(obj){
            this.setData({
                fullColor:`${obj.r},${obj.g},${obj.b}`
            }) 
        }

    }

组件的生命周期

1. 组件全部的生命周期函数

无参数的：

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

2. 组件主要的生命周期函数

在小程序组件中，最重要的生命周期函数有 3 个，分别是 created、attached、detached。它们各自的特点
如下：
① 组件实例刚被创建好的时候，created 生命周期函数会被触发

• 此时还不能调用 setData
• 通常在这个生命周期函数中，只应该用于给组件的 this 添加一些自定义的属性字段

② 在组件完全初始化完毕、进入页面节点树后， attached 生命周期函数会被触发

• 此时， this.data 已被初始化完毕
• 这个生命周期很有用，绝大多数初始化的工作可以在这个时机进行（例如发请求获取初始数据）

③ 在组件离开页面节点树后， detached 生命周期函数会被触发

• 退出一个页面时，会触发页面内每个自定义组件的 detached 生命周期函数
• 此时适合做一些清理性质的工作

3. lifetimes 节点

在小程序组件中，生命周期函数可以直接定义在 Component 构造器的第一级参数中，可以在 lifetimes 字段内进行声明（这是推荐的方式，其优先级最高）。
我就不写旧的不推荐的模式了

lifetimes:{
        //在组件实例刚刚被创建时执行
        attached(){ },
        //在组件实例被从页面节点树移除时执行
        detached(){ },
    },

组件所在页面的生命周期

1. 什么是组件所在页面的生命周期

有时，自定义组件的行为依赖于页面状态的变化，此时就需要用到组件所在页面的生命周期。
例如：每当触发页面的 show 生命周期函数的时候，我们希望能够重新生成一个随机的 RGB 颜色值。
在自定义组件中，组件所在页面的生命周期函数有如下 3 个。
无参数的：

• show 组件所在的页面被展示时执行
• hide 组件所在的页面被隐藏时执行

有参数的 Object Size:

• resize 组件所在的页面尺寸变化时执行

2. pageLifetimes 节点

组件所在页面的生命周期函数，需要定义在 pageLifetimes 节点中。
注：写在组件的js文件里。

pageLifetimes:{
        //组件所在的页面被展示时执行
        show(){},
        // 组件所在的页面被隐藏时执行
        hide(){},
        // 组件所在的页面尺寸变化时执行
        resize(){}
    },

3. 生成随机的 RGB 颜色值

写一个生成随机颜色的函数，，然后组件所在页面被展示时调用
(在我们之前做的东西的上面添加，注意，这里的代码是添加的部分)

methods: {
        _randomRgb(){
            this.setData({
                _rgb:{
                    r:Math.floor(Math.random() * 256),
                    g:Math.floor(Math.random() * 256),
                    b:Math.floor(Math.random() * 256)
                }
            })
        },
		},
pageLifetimes:{
        //组件所在的页面被展示时执行
        show(){
            this._randomRgb()
        },
    },

插槽

1. 什么是插槽

在自定义组件的 wxml 结构中，可以提供一个 <slot>节点（插槽），用于承载组件使用者提供的 wxml 结构。
小程序页面，作为组件的使用者，在使用组件时，为<slot>占位符提供具体的内容节点。
自定义组件，作为组件的封装者，在封装组件时，通过<slot>提供内容的占位符

2. 单个插槽

在小程序中，默认每个自定义组件中只允许使用一个 进行占位，这种个数上的限制叫做单个插槽。

<!-- 组件的wxml -->
<view>
    这里是组件的内部节点
</view>
<!-- 对于不确定的内容，可以使用<slot>进行占位，具体的内容由组件的使用者决定 -->
<slot></slot>
<view>
    hello world
</view>

<!-- 调用者的wxml -->
<test2>
<!-- 这部分内容将被放置在组件<slot>的位置上 -->
<view>
    这里是插入到组件slot中的内容
</view>
</test2>

3. 启用多个插槽

在小程序的自定义组件中，需要使用多 插槽时，可以在组件的 .js 文件中，通过如下方式进行启用

 options:{
        multipleSlots:true
    },

4. 定义多个插槽

可以在组件的 .wxml 中使用多个 标签，以不同的 name 来区分不同的插槽

<slot name="before"></slot>
<slot name="after"></slot>

4. 使用多个插槽

在使用带有多个插槽的自定义组件时，需要用 slot 属性来将节点插入到不同的<slot>中。

<test2>
<view slot="before">
    这里是插入到名为before的组件slot中的内容
</view>
<view slot="after">
    这里是插入到名为after的组件slot中的内容
</view>
</test2>

父子组件之间的通信

1. 父子组件之间通信的 3 种方式

① 属性绑定

• 用于父组件向子组件的指定属性设置数据，仅能设置 JSON 兼容的数据

② 事件绑定

• 用于子组件向父组件传递数据，可以传递任意数据

③ 获取组件实例

• 父组件还可以通过 this.selectComponent() 获取子组件实例对象
• 这样就可以直接访问子组件的任意数据和方法

2. 属性绑定

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

//wxjs
 data: {
    count:20
  },
  
//wxml
<test2 count="{{count}}">
</test2>

子组件在 properties 节点中声明对应的属性并使用。

//wxjs
 properties: {
        count:Number
    },
	
//wxml
<view>
    子组件获得一个传值{{ count }}
</view>

3. 事件绑定

事件绑定用于实现子向父传值，可以传递任何类型的数据。使用步骤如下：
① 在父组件的 js 中，定义一个函数，这个函数即将通过自定义事件的形式，传递给子组件
② 在父组件的 wxml 中，通过自定义事件的形式，将步骤 1 中定义的函数引用，传递给子组件
③ 在子组件的 js 中，通过调用 this.triggerEvent('自定义事件名称', { /* 参数对象 */ }) ，将数据发送到父组件
④ 在父组件的 js 中，通过e.detail 获取到子组件传递过来的数据

步骤1

父组件js

syncCount(){
//随便写点啥，后面再改
     console.log("syncCount")
    } ,

步骤2

父组件的 wxml

//这个sync不是死的，这个是给传递的函数起的名字，不是一个死的格式
<test2 count="{{count}}" bind:sync="syncCount">
</test2>

步骤3

在子组件的 js 中

methods: {
        addCount(){
            this.setData({
                count:this.properties.count +1
            })
            this.triggerEvent('sync',{
                value:this.properties.count
            })
//假如说我不传值，子可以调用父的函数
//就不需要第四步了
//this.triggerEvent('sync')
    } ,
        },

步骤4

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

syncCount(e){
        this.setData({
          count:  e.detail.value
        })
    } ,

这个怎么感觉怪怪的逻辑。
我觉得应该

• 先在子组件的 js 中，通过调用 this.triggerEvent('自定义事件名称', { /* 参数对象 */ }) ，将数据发送到父组件。记住自定义事件名。
• 然后在父组件的 wxml 中，通过自定义事件的形式，把函数引用给子组件。记住函数引用名
• 在父组件的 js 中，通过e.detail 获取到子组件传递过来的数据

4. 获取组件实例

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

//wxml
<test2 count="{{count}}"bind:sync="syncCount"
class="A"
>
</test2>
<view>
    <button bindtap="getChild">获取子组件实例</button>
</view>

//wxjs
    getChild(){
        //获取子组件实例
        const child = this.selectComponent('.A')
        child.setData({
            //调用子组件的setdata方法
            count:child.properties.count +1
        })
        //调用子组件的addCount方法
        child.addCount()
    },

behaviors

1. 什么是 behaviors

（提取共用的js代码到一个文件里）
behaviors 是小程序中，用于实现组件间代码共享的特性，类似于 Vue.js 中的 “mixins”。
组件A和组件C都可以引用 behavior

2. behaviors 的工作方式

每个 behavior 可以包含一组属性、数据、生命周期函数和方法。组件引用它时，它的属性、数据和方法会被合并到组件中。每个组件可以引用多个 behavior，behavior 也可以引用其它 behavior

3. 创建 behavior

调用 Behavior(Object object) 方法即可创建一个共享的 behavior 实例对象，供所有的组件使用

//behaviors/mybehavior.js
// 调用Behavior()方法，创建实例对象
// 并使用 model.exports
// 将 behavior 实例对象共享出去
model.exports=Behavior({
    //属性节点
    properties:{},
    //私有数据节点
    data:{
        username:"timer"
    },
    // 数据处理函数和自定义方法节点
    methods:{}
    // 其他节点
})

4. 导入并使用 behavior

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

//组件wxjs
const myBehavior = require("../../behaviors/mybehavior")
Component({
// 2．将导入的 behavior实例对象，挂载到 behaviors_数组节点中，即可生效
    behaviors:[myBehavior],
 // 组件的其他节点
 
})

5. behavior 中所有可用的节点(都是非必选)

Object Map：

• properties 同组件的属性

Object：

• data 同组件的数据
• methods 同自定义组件的方法

String Array：

• behaviors 引入其它的 behavior

函数类型：

• created 生命周期函数
• attached 生命周期函数
• ready 生命周期函数
• moved 生命周期函数
• detached 生命周期函数

6. 同名字段的覆盖和组合规则*

组件和它引用的 behavior 中可以包含同名的字段，此时可以参考如下 3 种同名时的处理规则：
① 同名的数据字段 (data)
② 同名的属性 (properties) 或方法 (methods)
③ 同名的生命周期函数
关于详细的覆盖和组合规则，大家可以参考微信小程序官方文档给出的说明：
https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/behaviors.html