鸿蒙开发笔记(四):自定义组件常用装饰器 @Builder @BuilderParam @Styles @Extend及stateStyles

最新推荐文章于 2025-04-15 23:35:23 发布

ZWaruler

最新推荐文章于 2025-04-15 23:35:23 发布

阅读量4.2k

点赞数 25

分类专栏：鸿蒙开发文章标签： harmonyos 鸿蒙开发移动开发

本文链接：https://blog.youkuaiyun.com/u010483016/article/details/135596947

版权

1. @Builder装饰器：自定义构建函数

前面介绍了如何创建一个自定义组件。该自定义组件内部UI结构固定，仅与使用方进行数据传递。ArkUI还提供了一种更轻量的UI元素复用机制@Builder，@Builder所装饰的函数遵循build()函数语法规则，开发者可以将重复使用的UI元素抽象成一个方法，在build方法里调用。

为了简化语言，我们将@Builder装饰的函数也称为“自定义构建函数”。

从API version 9开始，该装饰器支持在ArkTS卡片中使用。

1.1 自定义组件内自定义构建函数

定义的语法：

@Builder MyBuilderFunction({
    ... })

使用方法：

this.MyBuilderFunction({
    ... })

允许在自定义组件内定义一个或多个自定义构建函数，该函数被认为是该组件的私有、特殊类型的成员函数。
自定义构建函数可以在所属组件的build方法和其他自定义构建函数中调用，但不允许在组件外调用。
在自定义函数体中，this指代当前所属组件，组件的状态变量可以在自定义构建函数内访问。建议通过this访问自定义组件的状态变量而不是参数传递。

1.2 全局自定义构建函数

定义的语法：多了function关键字

@Builder function MyGlobalBuilderFunction({
     ... })

使用方法：

MyGlobalBuilderFunction()

全局的自定义构建函数可以被整个应用获取，不允许使用this和bind方法。
如果不涉及组件状态变化，建议使用全局的自定义构建方法。

1.3 参数传递规则

自定义构建函数的参数传递有按值传递和按引用传递两种，均需遵守以下规则：

参数的类型必须与参数声明的类型一致，不允许undefined、null和返回undefined、null的表达式。
在自定义构建函数内部，不允许改变参数值。如果需要改变参数值，且同步回调用点，建议使用@Link。
@Builder内UI语法遵循UI语法规则。

1. 按引用传递参数

按引用传递参数时，传递的参数可为状态变量，且状态变量的改变会引起@Builder方法内的UI刷新。ArkUI提供$$作为按引用传递参数的范式。

ABuilder( $$ : {
    paramA1: string, paramB1 : string } );

@Builder function ABuilder($$: {
     paramA1: string }) {
   
  Row() {
   
    Text(`UseStateVarByReference: ${
     $$.paramA1} `)
  }
}
@Entry
@Component
struct Parent {
   
  @State label: string = 'Hello';
  build() {
   
    Column() {
   
      // 在Parent组件中调用ABuilder的时候，将this.label引用传递给ABuilder
      ABuilder({
    paramA1: this.label })
      Button('Click me').onClick(() => {
   
        // 点击“Click me”后，UI从“Hello”刷新为“ArkUI”
        this.label = 'ArkUI';
      })
    }
  }
}

2. 按值传递参数

调用@Builder装饰的函数默认按值传递。当传递的参数为状态变量时，状态变量的改变不会引起@Builder方法内的UI刷新。所以当使用状态变量的时候，推荐使用按引用传递。

@Builder function ABuilder(paramA1: string) {
   
  Row() {
   
    Text(`UseStateVarByValue: ${
     paramA1} `)
  }
}
@Entry
@Component
struct Parent {
   
  label: string = 'Hello';
  build() {
   
    Column() {
   
      ABuilder(this.label)
    }
  }
}

2. @BuilderParam装饰器：引用@Builder函数

当开发者创建了自定义组件，并想对该组件添加特定功能时，例如在自定义组件中添加一个点击跳转操作。若直接在组件内嵌入事件方法，将会导致所有引入该自定义组件的地方均增加了该功能。为解决此问题，ArkUI引入了@BuilderParam装饰器，@BuilderParam用来装饰指向@Builder方法的变量，开发者可在初始化自定义组件时对此属性进行赋值，为自定义组件增加特定的功能。该装饰器用于声明任意UI描述的一个元素，类似slot占位符。

从API version 9开始，该装饰器支持在ArkTS卡片中使用。

2.1 初始化@BuilderParam装饰的方法

@BuildParam装饰的方法只能被自定义构建函数（@Builder装饰的方法）初始化。

使用所属自定义组件的自定义构建函数或者全局的自定义构建函数，在本地初始化@BuilderParam。

@Builder function GlobalBuilder0() {
   }

@Component
struct Child {
   
  @Builder doNothingBuilder() {
   };

  @BuilderParam aBuilder0: () => void = this.doNothingBuilder;
  @BuilderParam aBuilder1: () => void = GlobalBuilder0;
  build(){
   }
}

用父组件自定义构建函数初始化子组件@BuildParam装饰的方法。

@Component
struct Child {
   
  @BuilderParam aBuilder0: () => void;

  build() {
   
    Column() {
   
      this.aBuilder0()
    }
  }
}

@Entry
@Component
struct Parent {
   
  @Builder componentBuilder() {
   
    Text(`Parent builder `)
  }

  build() {
   
    Column() {
   
      Child({
    aBuilder0: this.componentBuilder })
    }
  }

最低0.47元/天解锁文章