定义段与示例方法

Component构造器可用于定义组件，调用Component构造器时可以指定组件的属性、数据、方法等。

定义段 类型 是否必填 描述 最低版本
properties Object Map 否 组件的对外属性，是属性名到属性设置的映射表，属性设置中可包含三个字段， type 表示属性类型、 value 表示属性初始值、 observer 表示属性值被更改时的响应函数
data Object 否 组件的内部数据，和 properties 一同用于组件的模板渲染
observers Object 否 组件数据字段监听器，用于监听 properties 和 data 的变化，参见 数据监听器 2.6.1
methods Object 否 组件的方法，包括事件响应函数和任意的自定义方法，关于事件响应函数的使用，参见 组件事件
behaviors String Array 否 类似于mixins和traits的组件间代码复用机制，参见 behaviors
created Function 否 组件生命周期函数，在组件实例刚刚被创建时执行，注意此时不能调用 setData ，参见 组件生命周期
attached Function 否 组件生命周期函数，在组件实例进入页面节点树时执行，参见 组件生命周期
ready Function 否 组件生命周期函数，在组件布局完成后执行，参见 组件生命周期
moved Function 否 组件生命周期函数，在组件实例被移动到节点树另一个位置时执行，参见 组件生命周期
detached Function 否 组件生命周期函数，在组件实例被从页面节点树移除时执行，参见 组件生命周期
relations Object 否 组件间关系定义，参见 组件间关系
externalClasses String Array 否 组件接受的外部样式类，参见 外部样式类
options Object Map 否 一些选项（文档中介绍相关特性时会涉及具体的选项设置，这里暂不列举）
lifetimes Object 否 组件生命周期声明对象，参见 组件生命周期 2.2.3
pageLifetimes Object 否 组件所在页面的生命周期声明对象，支持页面的 show 、 hide 等生命周期，参见 组件生命周期 2.2.3
definitionFilter Function 否 定义段过滤器，用于自定义组件扩展，参见 自定义组件扩展 2.2.3

生成的组件实例可以在组件的方法、生命周期函数和属性 observer 中通过 this 访问。组件包含一些通用属性和方法。

属性名 类型 描述
is String 组件的文件路径
id String 节点id
dataset String 节点dataset
data Object 组件数据，包括内部数据和属性值
properties Object 组件数据，包括内部数据和属性值（与 data 一致）
方法名 参数 描述
setData Object newData 设置data并执行视图层渲染
hasBehavior Object behavior 检查组件是否具有 behavior （检查时会递归检查被直接或间接引入的所有behavior）
triggerEvent String name, Object detail, Object options 触发事件，参见 组件事件
createSelectorQuery 创建一个 SelectorQuery 对象，选择器选取范围为这个组件实例内
createIntersectionObserver 创建一个 IntersectionObserver 对象，选择器选取范围为这个组件实例内
String selector 使用选择器选择组件实例节点，返回匹配到的第一个组件实例对象（会被 wx://component-export 影响）
selectAllComponents String selector 使用选择器选择组件实例节点，返回匹配到的全部组件实例对象组成的数组
getRelationNodes String relationKey 获取这个关系所对应的所有关联节点，参见 组件间关系
groupSetData Function callback 立刻执行 callback ，其中的多个 setData 之间不会触发界面绘制（只有某些特殊场景中需要，如用于在不同组件同时 setData 时进行界面绘制同步）

代码示例：

在开发者工具中预览效果

  1. Component({
  3.   behaviors: [],
  5.   properties: {
  6.     myProperty: { // 属性名
  7.       type: String, // 类型（必填），目前接受的类型包括：String, Number, Boolean, Object, Array, null（表示任意类型）
  8.       value: '', // 属性初始值（可选），如果未指定则会根据类型选择一个
  9.       observer(newVal, oldVal, changedPath) {
  10.         // 属性被改变时执行的函数（可选），通常 newVal 就是新设置的数据， oldVal 是旧数
  11.         // 新版本基础库不推荐使用这个字段，而是使用 Component 构造器的 observer 字段代替（这样会有更强的功能和更好的性能）
  12.       }
  13.     },
  14.     myProperty2: String // 简化的定义方式
  15.   },
  16.   data: {}, // 私有数据，可用于模板渲染
  18.   lifetimes: {
  19.     // 生命周期函数，可以为函数，或一个在methods段中定义的方法名
  20.     attached() { },
  21.     moved() { },
  22.     detached() { },
  23.   },
  25.   // 生命周期函数，可以为函数，或一个在methods段中定义的方法名
  26.   attached() { }, // 此处attached的声明会被lifetimes字段中的声明覆盖
  27.   ready() { },
  29.   pageLifetimes: {
  30.     // 组件所在页面的生命周期函数
  31.     show() { },
  32.     hide() { },
  33.     resize() { },
  34.   },
  36.   methods: {
  37.     onMyButtonTap() {
  38.       this.setData({
  39.         // 更新属性和数据的方法与更新页面数据的方法类似
  40.       })
  41.     },
  42.     // 内部方法建议以下划线开头
  43.     _myPrivateMethod() {
  44.       // 这里将 data.A[0].B 设为 'myPrivateData'
  45.       this.setData({
  46.         'A[0].B': 'myPrivateData'
  47.       })
  48.     },
  49.     _propertyChange(newVal, oldVal) {
  51.     }
  52.   }
  54. })

注意：在 properties 定义段中，属性名采用驼峰写法（propertyName）；在 wxml 中，指定属性值时则对应使用连字符写法（component-tag-name property-name="attr value"），应用于数据绑定时采用驼峰写法（attr="{{propertyName}}"）。

事实上，小程序的页面也可以视为自定义组件。因而，页面也可以使用 Component 构造器构造，拥有与普通组件一样的定义段与实例方法。但此时要求对应 json 文件中包含 usingComponents 定义段。

此时，组件的属性可以用于接收页面的参数，如访问页面 /pages/index/index?paramA=123&paramB=xyz ，如果声明有属性 paramA 或 paramB ，则它们会被赋值为 123 或 xyz 。

页面的生命周期方法（即 on 开头的方法），应写在 methods 定义段中。

代码示例：

  1. {
  2.   "usingComponents": {}
  3. }
  1. Component({
  3.   properties: {
  4.     paramA: Number,
  5.     paramB: String,
  6.   },
  8.   methods: {
  9.     onLoad() {
  10.       this.data.paramA // 页面参数 paramA 的值
  11.       this.data.paramB // 页面参数 paramB 的值
  12.     }
  13.   }
  15. })

Bug & Tips:

  • 使用 this.data 可以获取内部数据和属性值，但不要直接修改它们，应使用 setData 修改。
  • 生命周期函数无法在组件方法中通过 this 访问到。
  • 属性名应避免以 data 开头，即不要命名成 dataXyz 这样的形式，因为在 WXML 中， data-xyz="" 会被作为节点 dataset 来处理，而不是组件属性。
  • 在一个组件的定义和使用时，组件的属性名和 data 字段相互间都不能冲突（尽管它们位于不同的定义段中）。
  • 从基础库 2.0.9 开始，对象类型的属性和 data 字段中可以包含函数类型的子字段，即可以通过对象类型的属性字段来传递函数。低于这一版本的基础库不支持这一特性。
  • bug : 对于 type 为 Object 或 Array 的属性，如果通过该组件自身的 this.setData 来改变属性值的一个子字段，则依旧会触发属性 observer ，且 observer 接收到的 newVal 是变化的那个子字段的值， oldVal 为空， changedPath 包含子字段的字段名相关信息。
  • bug : 位于 slot 中的自定义组件没有触发 pageLifetimes 中声明的页面生命周期，此问题会在 2.5.3 中修复。

原文:

https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/component.html