小程序开发第四节:自定义组件

311 阅读11分钟

附:「这是我参与2022首次更文挑战的第20天,活动详情查看:2022首次更文挑战

自定义组件

1. 组件的创建与引用

1.1 创建组件

(1)在项目的根目录中,鼠标邮件,创建 components -> test目录

(2)在新建的 components -> test目录上,鼠标右键,点击 “新建component”

(3)键入组件的名称之后回车,会自动生成组件对应的 4 个文件。后缀名分别为:.js、.json、.wxml 和 .wxss

注意:为了保证目录结构的清晰,建议把不同的组件,存放到单独目录中,例如:

1.2 引用组件

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

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

1.3 局部引入组件

在页面的 .json 配置文件中引用组件的方式,叫做“局部引用”。示例代码如下:

#home.json

"usingComponents":{
 "my-test1":"/components/test1/test1"   // 左侧为组件名称,右侧为组件的路径
}

#home.wxml

// 使用组件
<my-test1></my-test1>

1.4 全局引入组件

在 app.json 配置文件中引用组件的方式,叫做“全部引用”。示例代码如下:

#app.json

{
 "usingComponents":{
 "my-test2":"/components/test2/test2"   // 左侧为组件名称,右侧为组件的路径
 }
}

#home1.wxml

<my-test2></my-test2>

#home2.wxml

<my-test2></my-test2>

注意:如果某个组件在 app.json 里注册了,那么这个组件在小程序内任何页面都可以直接使用。

1.5 全局引用 vs 局部引用

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

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

1.6 组件和页面的区别

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

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

2. 样式

2.1 组件样式隔离

默认情况下,自定义组件的样式只对当前组件生效,不会影响到组件之外的 UI结构 ,如图所示:

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

好处:

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

2.2 组件样式隔离的注意点

(1)app.wxss 中的全局样式对组件无效

(2)只有 class 选择器会有样式隔离的效果,id选择器、属性选择器、标签选择器不受样式隔离的影响

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

2.3 修改组件的样式隔离选项

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

两种方式添加 stylelsolation 隔离选项:

(1)#components/test1/test1.js 新增 stylelsolation

Component({
 options:{
   stylelsolation: "isolated" 
  }
})

(2)或者在 #components/test1/test1.json 新增 stylelsolation

{
 "stylelsolation": "isolated"
}

2.4 stylelsolation 的可选值

3. 数据、方法和属性

3.1 data 数据

在小程序组件中,用于组件模板渲染的私有数据,需要定义到 data节点中,示例如下:

Component({
 data:{
  count: 0
 }
})

3.2 methods 方法(事件处理函数 / 自定义方法)

在小程序组件中,事件处理函数和自定义方法需要定义到 methods 节点中,示例代码如下:

Component({
 data:{
  count: 0
 },
 methods:{  // 组件的方法列表【包含事件处理函数和自定义方法】
  addCount(){ // 事件处理函数
   this.setData({
    count: this.data.count + 1
   })
   this._showCount() // 通过 this 调用自定义方法
  }
 },
 _showCount(){  // 自定义方法建议以 _ 开头
  wx.showToast({
   title: "count值为" + this.data.count,
   icon: "none"
  })
 }
})

3.3 properties属性(相当于vue的props)

在小程序组件中,properties 是组件的对外属性,用来接受外界传递到组件中的数据,示例代码如下:

这里有两个组件 test1 和 test2 ,test2组件在自己的 test2.wxml 引用了 test1组件,并传递了 max=20 的数据给 test1组件。

#test1.js

Component({
 properties: {
  max: {
   type: Number,
   value: 10
  }
 }
})

#test2.wxml

<my-test1 max="20"></my-test1>

3.4 data 和 properties 的区别

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

  • data 更倾向于存储组件的私有数据
  • properties 更倾向于存储外界传递到组件中的数据
Component({
 methods:{
  showInfo(){
   console.log(this.data)  // 输出结果:{count:0, max:10}
   console.log(this.properties) // 输出结果:{count:0, max:10}
   
    // 结果为true,证明data数据和properties属性【在本质上是一样的,都是可读可写的】
   console.log(this.data === this.properties) 
  }
 }
})

注意:properties 类似于 Vue中的 Props,但是properties是可读可写的,而Props是只读不可写

3.5 使用 setData 修改 properties 的值

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

#components/test1/test1.wxml

<view>max属性的值为:{{max}}</view>

#components/test1/test1.js

Component({
 properties: {
   max: {type: Number},
 },
 methods: {
  addCount(){
   this.setData({
    max: this.properties.max + 1
   })
  }
 }
})

4. 数据监听器

4.1 什么是数据监听器

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

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

4.2 数据监听器的基本用法

组件的 UI结构如下:

<view>{{n1}} + {{n2}} = {{sum}}</view>
<button size="mini" bindtap="addN1">n1自增</button>
<button size="mini" bindtap="addN2">n2自增</button>

组件的 .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:{ // 数据监听节点
   'addN1,addN2': function(n1,n2){  // 监听 n1 和 n2 数据的变化
    this.setData({  // 通过监听器,自动计算 sum 的值
     sum: n1 + n2
    })
   }
  }
})

4.3 监听对象属性的变化

数据监听支持监听对象中单个或多个属性的变化,示例语法如下:

Component({
 observers:{
  '对象.属性A , 对象.属性B': function(属性A的新值,属性B的新值){
   // 触发此监听器的 3 种情况:
   // 1. 为属性A赋值
   // 2. 为属性B赋值
   // 3. 直接为对象赋值
  }
 }
})

4.4 数据监听器案例

这个是一个数据监听器的案例,当对应的数据发生变化,颜色也会发生变化

#color.wxml

<view style="background-color: rgb({{fullColor}});" class="colorBox">颜色值:{{fullColor}}</view>
<button type="default" size="mini" bindtap="changeR">R + 5</button>
<button type="primary" size="mini" bindtap="changeG">G + 5</button>
<button type="warn" size="mini" bindtap="changeB">B + 5</button>

#color.js

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

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

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

如果某个对象中需要被监听的属性太多,为了方便,可以使用 通配符** 来监听对象中所有属性的变化,示例代码如下:

observers: {
    // rgb.** 表示监听 rgb对象下面的所有属性
    // 属性最新的值,可以用 对象. 来调出来,例如: obj.r
    'rgb.**': function(obj){
      this.setData({
        fullColor: `${obj.r},${obj.g},${obj.b}`
      })
    }
  }

5. 纯数据字段

5.1 什么是纯数据字段

概念:纯数据字段指的是那些不用于界面渲染的 data 字段。

应用场景:例如有些情况下,某些 data 中的字段即不会展示在界面上,也不会传递给其他组件,仅仅在当前组件内部使用。带有这种特性的 data 字段适合被设置为纯数据字段。

好处:纯数据字段有助于提升页面更新的性能。

5.2 使用规则

纯数据字段:只有用于逻辑的处理,不会渲染到页面上

在 Component 构造器的 options 节点中,指定 pureDataPattern 为一个正则表达式,字段名符合这个正则表达式的字段将成为纯数据字段,示例代码如下:

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

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

Component({
  options:{
    pureDataPattern:/^_/
  },
  data: {
    // 将 rgb 改造成以 _ 开头的纯数据字段
    _rgb: {
      r: 0,
      g: 0,
      b: 0
    },
    fullColor: '0,0,0'
  },
  methods: {
    changeR() {
      this.setData({
        '_rgb.r': this.data._rgb.r + 5 > 255 ? 255 : this.data._rgb.r + 5
      })
    },
    changeG() {
      this.setData({
        '_rgb.g': this.data._rgb.g + 5 > 255 ? 255 : this.data._rgb.g + 5
      })
    },
    changeB() {
      this.setData({
        '_rgb.b': this.data._rgb.b + 5 > 255 ? 255 : this.data._rgb.b + 5
      })
    }
  },
  observers: {
    // _rgb.** 表示监听 rgb对象下面的所有属性
    '_rgb.**': function(obj){
      this.setData({
        fullColor: `${obj.r},${obj.g},${obj.b}`
      })
    }
  }
})

6. 组件的生命周期

6.1 组件全部的生命周期函数

小程序组件可用的全部生命周期如下表所示:

解析:

  • created:组件刚被创建时触发
  • attached:把创建好的组件放入页面节点树中时触发(只是放在页面节点,还没有被渲染)
  • ready:组件渲染完成后触发
  • moved:组件从a的位置移动到b的位置会触发
  • detached:组件从页面节点树移除时触发
  • error:组件报错时触发

注意:生命周期函数以 d 结尾的,表示完成了这个任务后触发的。

6.2 组件主要的生命周期函数(created、attached、detached)

在小程序组件中,最重要的生命周期函数有3个,分别是 created、attached、detached。它们各自的特点如下:

(1)组件实例刚被创建好的时候,created生命周期函数会被触发

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

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

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

(3)在组件离开页面节点树后,detached 生命周期函数会被触发

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

6.3 lifetimes 节点

在小程序组件中,生命周期函数可以直接定义在 Component 构造器的第一级参数中,可以在 lifetimes 字段内进行声明(这是推荐的方式,其优先级最高)。示例代码如下:

Component({
  // 1. 推荐用法
 lifetimes: {
  attached(){},  // 在组件实例进入页面节点树时触发
  detached(){}   // 在组件实例被从页面节点树移除时触发
 }
  // 2. 以下是旧式的定义方式
  attached(){},  // 在组件实例进入页面节点树时触发
  detached(){},  // 在组件实例被从页面节点树移除时触发
})

小总结:

  1. lifetimes里定义生命周期函数
  2. 有两种定义生命周期函数的方式,更推荐在lifetimes里定义
  3. 如果新的旧的同时存在,会优先执行新的写法

7. 组件所在页面的生命周期

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

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

例如:每当触发页面的show生命周期函数的时候,我们希望能够重新生成一个随机的 RGB 颜色值。

在自定义组件中,组件所在页面的生命周期函数有如下3个,分别是:

7.2 pageLifetimes节点

用于给每一个组件添加一个页面的生命周期函数,通过这个节点,我们可以在当前的组件内部去管理组件所在页面的生命周期。

组件所在页面的生命周期函数,需要定义在 pageLifetimes 节点中。示例代码如下:

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

7.3 案例 - 生成随机的 RGB 颜色值

8. 插槽

8.1 什么是插槽

在自定义组件的 wxml 结构中,可以提供一个 节点(插槽),用于承载组件使用者提供的 wxml 结构。

8.2 单个插槽(定义 + 使用)

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

组件封装者

<view>
   <view>1</view>
   <slot></slot>
   <view>3</view>
</view>

组件使用者

<my-test1>
  <view>2</view>  // 这里的内容会插入到 <slot> 占位的地方
</my-test1>

8.3 多个插槽(启用、定义、使用)

在小程序的自定义组件中,需要使用多个 插槽时,可以在组件的 .js 文件中,通过如下方式进行启用。示例代码如下:

(1)启用支持多个 插槽

Component({
  options: {
   multipleSlots: true  // 在组件定义时的选项中,启用多 slot 支持
  },
  properties: {},
  methods: {}
})

(2)定义多个插槽

可以在组件的 .wxml 中使用多个 标签,以不同的 name 来区分不同的插槽。示例代码如下:

<view class="wrapper">
  <!-- 名字为 before 的占位插槽 -->
  <slot name="before"></slot>
  <view>这是一段固定的文本内容</view>
  <!--名字为 after 的占位插槽 -->
  <slot name="after"></slot>
</view>

(3)使用多个插槽

在使用带有多个插槽的自定义组件时,需要用 slot属性来将节点插入到不同的 中,示例代码如下:

<component-tag-name>
  <view slot="before">这里是插入到组件slot name="before"</view>
  <view slot="after">这里是插入到组件slot name="after"</view>
</component-tag-name>

总结