@Builder装饰器:自定义构建函数
ArkUI
提供了一种轻量的UI元素复用机制@Builder
,该自定义组件内部UI结构固定,仅与使用方进行数据传递,开发者可以将重复使用的UI元素抽象成一个方法,在build
方法里调用。
为了简化语言,我们将@Builder
装饰的函数也称为“自定义构建函数”。
限制条件
@Builder
通过按引用传递的方式传入参数,才会触发动态渲染UI,并且参数只能是一个。@Builder
如果传入的参数是两个或两个以上,不会触发动态渲染UI。@Builder
传入的参数中同时包含按值传递和按引用传递两种方式,不会触发动态渲染UI。@Builder
的参数必须按照对象字面量的形式,把所需要的属性一一传入,才会触发动态渲染UI。
装饰器使用说明
定义的语法:@Builder MyBuilderFunction() {}
使用方法:this.MyBuilderFunction
- 允许在自定义组件内定义一个或多个@Builder方法,该方法被认为是该组件的私有、特殊类型的成员函数。
- 自定义构建函数可以在所属组件的build方法和其他自定义构建函数中调用,但不允许在组件外调用。
- 在自定义函数体中,this指代当前所属组件,组件的状态变量可以在自定义构建函数内访问。建议通过this访问自定义组件的状态变量而不是参数传递。
全局自定义构建函数
定义的语法:@Builder function MyGlobalBuilderFunction() { ... }
使用的方法:MyGlobalBuilderFunction()
- 如果不涉及组件状态变化,建议使用全局的自定义构建方法。
参数传递规则
自定义构建函数的参数传递有按值传递和按引用传递两种,均需遵守以下规则:
- 参数的类型必须与参数声明的类型一致,不允许
undefined、null
和返回undefined、null
的表达式。 - 在
@Builder
修饰的函数内部,不允许改变参数值。 @Builder
内UI语法遵循UI语法规则。- 只有传入一个参数,且参数需要直接传入对象字面量才会按引用传递该参数,其余传递方式均为按值传递。
按引用传递参数
按引用传递参数时,传递的参数可为状态变量,且状态变量的改变会引起@Builder方法内的UI刷新。
class Tmp {
paramA1: string = ''
}
@Builder function overBuilder(params: Tmp) {
Row() {
Text(`UseStateVarByReference: ${params.paramA1} `)
}
}
@Entry
@Component
struct Parent {
@State label: string = 'Hello';
build() {
Column() {
overBuilder({ paramA1: this.label })
Button('Click me').onClick(() => {
this.label = 'ArkUI';
})
}
}
}
按引用传递参数时,如果在@Builder方法内调用自定义组件,ArkUI提供$$作为按引用传递参数的范式。
class Tmp {
paramA1: string = ''
}
@Builder function overBuilder($$: Tmp) {
Row() {
Column() {
Text(`overBuilder===${$$.paramA1}`)
HelloComponent({message: $$.paramA1})
}
}
}
@Component
struct HelloComponent {
@Prop message: string;
build() {
Row() {
Text(`HelloComponent===${this.message}`)
}
}
}
@Entry
@Component
struct Parent {
@State label: string = 'Hello';
build() {
Column() {
overBuilder({paramA1: this.label})
Button('Click me').onClick(() => {
this.label = 'ArkUI';
})
}
}
}
按值传递参数
调用@Builder装饰的函数默认按值传递。当传递的参数为状态变量时,状态变量的改变不会引起@Builder方法内的UI刷新。所以当使用状态变量的时候,推荐使用按引用传递。
@Builder function overBuilder(paramA1: string) {
Row() {
Text(`UseStateVarByValue: ${paramA1} `)
}
}
@Entry
@Component
struct Parent {
@State label: string = 'Hello';
build() {
Column() {
overBuilder(this.label)
}
}
}
使用场景
自定义组件内使用自定义构建函数
创建私有的@Builder方法,在Column里面使用this.builder()方式调用,通过aboutToAppear生命周期
函数和按钮的点击事件改变builder_value的内容,实现动态渲染UI。
@Entry
@Component
struct PrivateBuilder {
@State builder_value: string = 'Hello';
@Builder builder() {
Column(){
Text(this.builder_value)
.fontSize(30)
.fontWeight(FontWeight.Bold)
}
}
aboutToAppear(): void {
setTimeout(() => {
this.builder_value = 'Hello World';
},3000)
}
build() {
Row() {
Column() {
Text(this.builder_value)
.fontSize(30)
.fontWeight(FontWeight.Bold)
this.builder()
Button('点击改变builder_value内容')
.onClick(() => {
this.builder_value ='builder_value被点击了'
})
}
}
}
}
使用全局自定义构建函数
创建全局的@Builder方法,在Column里面使用overBuilder()方式调用,通过以对象字面量的形式传递参数,无论是简单类型还是复杂类型,值的改变都会引起UI界面的刷新。
class ChildTmp {
val: number = 1;
}
class Tmp {
str_value: string = 'Hello';
num_value: number = 0;
tmp_value: ChildTmp = new ChildTmp();
arrayTmp_value: Array<ChildTmp> = [];
}
@Builder function overBuilder(param: Tmp) {
Column() {
Text(`str_value: ${param.str_value}`)
Text(`num_value: ${param.num_value}`)
Text(`tmp_value: ${param.tmp_value.val}`)
ForEach(param.arrayTmp_value, (item: ChildTmp) => {
Text(`arrayTmp_value: ${item.val}`)
}, (item: ChildTmp) => JSON.stringify(item))
}
}
@Entry
@Component
struct Parent {
@State objParam: Tmp = new Tmp();
build() {
Column() {
Text('通过调用@Builder渲染UI界面')
.fontSize(20)
overBuilder({str_value: this.objParam.str_value, num_value: this.objParam.num_value, tmp_value: this.objParam.tmp_value, arrayTmp_value: this.objParam.arrayTmp_value})
Line()
.width('100%')
.height(10)
.backgroundColor('#000000').margin(10)
Button('点击改变参数值').onClick(() => {
this.objParam.str_value = 'Hello World';
this.objParam.num_value = 1;
this.objParam.tmp_value.val = 8;
const child_value: ChildTmp = {
val: 2
}
this.objParam.arrayTmp_value.push(child_value)
})
}
}
}
修改装饰器修饰的变量触发UI刷新
此种方式是使用了装饰器的特性,监听值的改变触发UI刷新,不通过@Builder传递参数。
class Tmp {
str_value: string = 'Hello';
}
@Entry
@Component
struct Parent {
@State objParam: Tmp = new Tmp();
@State label: string = 'World';
@Builder privateBuilder() {
Column() {
Text(`wrapBuilder str_value: ${this.objParam.str_value}`)
Text(`wrapBuilder num: ${this.label}`)
}
}
build() {
Column() {
Text('通过调用@Builder渲染UI界面')
.fontSize(20)
this.privateBuilder()
Line()
.width('100%')
.height(10)
.backgroundColor('#000000').margin(10)
Button('点击改变参数值').onClick(() => {
this.objParam.str_value = 'str_value Hello World';
this.label = 'label Hello World'
})
}
}
}
使用全局和局部的@Builder传入customBuilder类型
@Builder
function overBuilder() {
Row() {
Text('全局 Builder')
.fontSize(30)
.fontWeight(FontWeight.Bold)
}
}
@Entry
@Component
struct customBuilderDemo {
@State arr: number[] = [0, 1, 2, 3, 4];
@Builder privateBuilder() {
Row() {
Text('局部 Builder')
.fontSize(30)
.fontWeight(FontWeight.Bold)
}
}
build() {
Column() {
List({ space: 10 }) {
ForEach(this.arr, (item: number) => {
ListItem(){
Text(`${item}`)
.width('100%')
.height(100)
.fontSize(16)
.textAlign(TextAlign.Center)
.borderRadius(10)
.backgroundColor(0xFFFFFF)
}
.swipeAction({
start: {
builder: overBuilder()
},
end: {
builder: () => { this.privateBuilder() }
}
})
}, (item: string) => JSON.stringify(item))
}
}
}
}
多层@Builder方法嵌套使用
在@Builder方法内调用自定义组件或者其他@Builder方法,ArkUI提供$$作为按引用传递参数的范式。
class Tmp {
paramA1: string = '';
}
@Builder function parentBuilder($$: Tmp) {
Row() {
Column() {
Text(`parentBuilder===${$$.paramA1}`)
.fontSize(30)
.fontWeight(FontWeight.Bold)
HelloComponent({message: $$.paramA1})
childBuilder({paramA1: $$.paramA1})
}
}
}
@Component
struct HelloComponent {
@Prop message: string = '';
build() {
Row() {
Text(`HelloComponent===${this.message}`)
.fontSize(30)
.fontWeight(FontWeight.Bold)
}
}
}
@Builder
function childBuilder($$: Tmp) {
Row() {
Column() {
Text(`childBuilder===${$$.paramA1}`)
.fontSize(30)
.fontWeight(FontWeight.Bold)
HelloChildComponent({message: $$.paramA1})
grandsonBuilder({paramA1: $$.paramA1})
}
}
}
@Component
struct HelloChildComponent {
@State message: string = '';
build() {
Row() {
Text(`HelloChildComponent===${this.message}`)
.fontSize(30)
.fontWeight(FontWeight.Bold)
}
}
}
@Builder function grandsonBuilder($$: Tmp) {
Row() {
Column() {
Text(`grandsonBuilder===${$$.paramA1}`)
.fontSize(30)
.fontWeight(FontWeight.Bold)
HelloGrandsonComponent({message: $$.paramA1})
}
}
}
@Component
struct HelloGrandsonComponent {
@Prop message: string;
build() {
Row() {
Text(`HelloGrandsonComponent===${this.message}`)
.fontSize(30)
.fontWeight(FontWeight.Bold)
}
}
}
@Entry
@Component
struct Parent {
@State label: string = 'Hello';
build() {
Column() {
parentBuilder({paramA1: this.label})
Button('Click me').onClick(() => {
this.label = 'ArkUI';
})
}
}
}