鸿蒙开发:了解@Builder装饰器

程序员一鸣
• 阅读 39

前言

本文代码案例基于Api13,温馨提示:内容相对来说比较简单,如果您已掌握,略过即可。

如果说一个页面中组件有很多,我们都统一写到build函数中,显而易见,会导致build函数代码非常冗余,并且在有相同UI时,也做不到可复用效果,那么,针对这一问题如何解决呢?答案就是抽取出来;在页面内实现UI组件的抽取剥离,其实,在实际的开发中是非常常见的,也就是通过 @Builder装饰器来实现。

简单案例

以下是一个多文本展示案例,非常简单,就是几个Text组件,未抽取之前,都统一写在build函数之中。

@Entry
@Component
struct Index {
  build() {
    Column() {
      Text("文本测试一")
        .fontSize(20)
        .fontWeight(FontWeight.Bold)
      Text("文本测试二")
        .fontSize(20)
        .fontWeight(FontWeight.Bold)
      Text("文本测试三")
        .fontSize(20)
        .fontWeight(FontWeight.Bold)
      Text("文本测试四")
        .fontSize(20)
        .fontWeight(FontWeight.Bold)
    }
    .height('100%')
    .width('100%')
  }
}

使用 @Builder装饰器之后:

@Entry
@Component
struct Index {
  @Builder
  textView(text: string) {
    Text(text)
      .fontSize(20)
      .fontWeight(FontWeight.Bold)
  }

  build() {
    Column() {
      this.textView("文本测试一")
      this.textView("文本测试二")
      this.textView("文本测试三")
      this.textView("文本测试四")
    }
    .height('100%')
    .width('100%')
  }
}

显而可见,代码相比未抽取之前,简洁了很多,虽然上述只是一个案例,然而在实际的开发中,页面的复杂程度远远比案例复杂,所以更应该合理的使用 @Builder装饰器

什么是@Builder?

在前言中已经明确告知, @Builder它是一个装饰器,主要用于UI元素的复用以及抽取, @Builder所修饰的函数,统称为“自定义构建函数”,可以在函数中定义任何的UI组件,用法和build中的使用是一样的。

使用方式

@Builder装饰器有两种使用方式,一种是定义在UI组件内,也就是上述的使用方式,可以称为私有自定义构建函数,也就是只能给当前的UI组件进行使用,别的UI组件是无法使用的。

与私有自定义构建函数相对应的就是全局自定义构建函数,它可以实现任意的UI组件进行使用,需要用到function关键字,如果定义在非UI组件中,需要用export关键字导出。

我们可以自定义一个扩展类,把共用的组件定义在这里。

@Builder
export function TextView(text: string) {
  Text(text)
    .fontSize(20)
    .fontWeight(FontWeight.Bold)
}

任何一个页面或者UI组件中都可以使用。

import { TextView } from './BuilderView'

@Entry
@Component
struct Index {
  build() {
    Column() {
      TextView("文本测试一")
      TextView("文本测试二")
      TextView("文本测试三")
      TextView("文本测试四")
    }
    .height('100%')
    .width('100%')
  }
}

当然了,如果不是全局共用,仅仅是本页面内共用,也可以使用这种方式来实现。

数据更新

当我们直接更改传递的变量时,会发现@Builder修饰的函数内并没有实现数据改变,如下案例,怎么点击Button都不会发生改变。

@Entry
@Component
struct Index {
  @State testContent: string = "文本测试"

  @Builder
  textView(text: string) {
    Text(text)
      .fontSize(20)
      .fontWeight(FontWeight.Bold)
  }

  build() {
    Column() {
      this.textView(this.testContent)
      Button("改变")
        .margin({ top: 10 })
        .onClick(() => {
          this.testContent = "文本测试2"
        })
    }
    .height('100%')
    .width('100%')
    .justifyContent(FlexAlign.Center)
  }
}

这是因为,在@Builder修饰的函数内部,不允许改变参数值,也就是状态变量的改变不会引起@Builder方法内的UI刷新,那么要怎么实现可以动态改变@Builder修饰的函数里的数据呢,有两种方式,一种是,直接把当前的引用也就是当前的类传递过去,直接调用,另一种则是使用引用传递。

this指向当前类

把以上的代码做下更改,由传递值,直接传递当前的类,也就是当前的this,由this直接调用。

@Entry
@Component
struct Index {
  @State testContent: string = "文本测试"

  @Builder
  textView(_this: Index) {
    Text(_this.testContent)
      .fontSize(20)
      .fontWeight(FontWeight.Bold)
  }

  build() {
    Column() {
      this.textView(this)
      Button("改变")
        .margin({ top: 10 })
        .onClick(() => {
          this.testContent = "文本测试2"
        })
    }
    .height('100%')
    .width('100%')
    .justifyContent(FlexAlign.Center)
  }
}

可以发现点击Button后,数据实现了动态改变。

鸿蒙开发:了解@Builder装饰器

按引用传递参数

直接传递当前的this,可以说是最简单的方式,除了这种方式之外,我们还可是使用引用传递参数的方式,动态改变数据,也就是通过传递对象的方式。

class TestBean {
  testContent?: string;
}

@Entry
@Component
struct Index {
  @State testContent: string = "文本测试"

  @Builder
  textView(testBean: TestBean) {
    Text(testBean.testContent)
      .fontSize(20)
      .fontWeight(FontWeight.Bold)
  }

  build() {
    Column() {
      this.textView({ testContent: this.testContent })
      Button("改变")
        .margin({ top: 10 })
        .onClick(() => {
          this.testContent = "文本测试2"
        })
    }
    .height('100%')
    .width('100%')
    .justifyContent(FlexAlign.Center)
  }
}

可以看到,以上的数据传递,也能实现数据的动态改变,相对于this传递,使用这种方式则更加灵活,毕竟在实际的开发中,我们可能会遇到多个页面共用组件的情况,传递this显然只适合当前的页面,如果多个页面复用,还是以对象形式传递为佳。

由此可见,在使用 @Builder进行参数传递的时候,如果要 引起@Builder方法内的UI刷新,可以按照引用传递参数进行实现,按值传递是无法更新UI的。

参数规则

@Builder修饰的函数,其定义的参数类型,必须和传递的类型保持一致,并且不允许undefined、null和返回undefined、null的表达式。

还有一点非常重要,@Builder如果传入的参数是两个或两个以上,不会触发动态渲染UI,比如,上面的案例中,我们随便增加一个参数。

@Builder
 textView(testBean: TestBean, isBoolean: boolean) {
   Text(testBean.testContent)
     .fontSize(20)
     .fontWeight(FontWeight.Bold)
 }

运行后可以发现,数据是无法动态更改的,如果有多个值如何传递呢?两种方式,第一种以this为传递对象,使用this调用更多定义的参数,第二种就是直接定义在对象里,既然都以对象的形式进行传递了,何不都直接定义在对象里呢?

@ComponentV2装饰器更新

使用ComponentV2装饰器,遵循的道理一样,也就是使用简单数据类型不可以触发UI的刷新。

@Entry
@ComponentV2
struct Index {
  @Local testContent: string = "文本测试"

  @Builder
  textView(testContent: string) {
    Column() {
      Text(testContent)
        .fontSize(20)
        .fontWeight(FontWeight.Bold)
    }
  }

  build() {
    Column() {
      this.textView(this.testContent)
      Button("改变")
        .margin({ top: 10 })
        .onClick(() => {
          this.testContent = "文本测试2"
        })
    }
    .height('100%')
    .width('100%')
    .justifyContent(FlexAlign.Center)
  }
}

如果要更新UI的话,还是需要按引用传递参数,也就是修改为对象传递。

class TestBean {
  testContent?: string;
}

@Entry
@ComponentV2
struct Index {
  @Local testContent: string = "文本测试"

  @Builder
  textView(testBean: TestBean) {
    Column() {
      Text(testBean.testContent)
        .fontSize(20)
        .fontWeight(FontWeight.Bold)
    }
  }

  build() {
    Column() {
      this.textView({ testContent: this.testContent })
      Button("改变")
        .margin({ top: 10 })
        .onClick(() => {
          this.testContent = "文本测试2"
        })
    }
    .height('100%')
    .width('100%')
    .justifyContent(FlexAlign.Center)
  }
}

如果直接以对象的形式传递,不借助成员变量,需要使用@ObservedV2修饰的对象类和@Trace修饰属性才可以触发UI的刷新。

@ObservedV2
class TestBean {
 @Trace testContent: string = "文本测试";
}

@Entry
@ComponentV2
struct Index {
  @Local testBean: TestBean = new TestBean()

  @Builder
  textView(testBean: TestBean) {
    Column() {
      Text(testBean.testContent)
        .fontSize(20)
        .fontWeight(FontWeight.Bold)
    }
  }

  build() {
    Column() {
      this.textView(this.testBean)
      Button("改变")
        .margin({ top: 10 })
        .onClick(() => {
          this.testBean.testContent = "文本测试2"
        })
    }
    .height('100%')
    .width('100%')
    .justifyContent(FlexAlign.Center)
  }
}

相关总结

@Builder装饰是鸿蒙UI开发中,非常重要的一个装饰器,在实际的开发中,合理且正确的使用,能够让我们的代码更加的简洁,有两点需要注意,一是,是用私有还是全局,取决于当前的组件的复用机制,如果多个页面都使用了,建议以全局为主;二是传参的动态更新,有更新就使用引用参数传递,没有更新按值传递即可。

点赞
收藏
评论区
推荐文章
半臻 半臻
3年前
Python基础5——装饰器
13、装饰器其本质:在不需要做任何代码变动的前提下,增加额外的功能。装饰器返回的是一个函数对象。相当于把函数作为参数传递进去,然后对函数进行装饰其本质就是一个闭包作用:1.给原来的函数增加额外的功能2.把原来的函数作为参数传递进去13.1基本用法标准版的装饰器pythondefwrapper(func):func为原来的函数名defin
Stella981 Stella981
3年前
Python进阶笔记(2)
'''装饰器装饰器(Decorators)是Python的一个重要部分。简单地说:他们是修改其他函数的功能的函数。他们有助于让我们的代码更简短。如果已经接触过FLASK的,想想路由功能。如果没有接触过FLASK的,建议学习下。''''''各种推导式(compre
Stella981 Stella981
3年前
Python 装饰器(Decorator)
Python 装饰器(Decorator)装饰模式有很多经典的使用场景,例如插入日志、性能测试、事务处理等等,有了装饰器,就可以提取大量函数中与本身功能无关的类似代码,从而达到代码重用的目的。下面就一步步看看Python中的装饰器。装饰器本身是一个Python函数,他可以让其他函数在不需要做任何代码变动
Stella981 Stella981
3年前
HarmonyOS应用开发项目实战
鸿蒙2.0已经发布了有段时间了,目前网上也有些小demo了,但是缺乏稍微大点的项目代码。我准备计划开发一个稍微正式点的项目,我写了个初略的项目需求清单,来体验鸿蒙应用开发。目前我已经着手实现了其中的一些重要功能,某些功能发现鸿蒙暂时不支持,但是还是先写上吧,后面慢慢摸索。我会陆续更新连载此贴,一步步从0基础讲解项目开发过程,然后巩固鸿蒙应用开发知识点。有错误
Stella981 Stella981
3年前
Python装饰器用法实例总结
一、装饰器是什么python的装饰器本质上是一个Python函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能,装饰器的返回值也是一个函数对象。简单的说装饰器就是一个用来返回函数的函数。它经常用于有切面需求的场景,比如:插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计,有了装饰器,我们就可以抽离
程序员一鸣 程序员一鸣
1天前
鸿蒙开发:熟知@BuilderParam装饰器
所以在有@BuilderParam传递UI视图时,一定要注意this的指向问题,这也是为什么很多同学遇到在@Builder修饰的函数中为什么不刷新数据的问题,其原因就是this指向不对。
京东云开发者 京东云开发者
9个月前
鸿蒙跨端实践-ArkTS和CAPI的混合开发实现
一、背景在文章中,讲述了动态化适配鸿蒙的方案实现,当在鸿蒙系统进行UI渲染的时候,我们使用了系统的组件进行递归渲染。在iOS和Android也是借助各自系统组件进行的渲染,但是在鸿蒙系统会存在以下4个严重问题:1.UI层级过多以金融APP理财频道页中的一个
程序员一鸣 程序员一鸣
2个月前
鸿蒙开发:父组件如何调用子组件中的方法?
也许大家可能会有疑问,子组件更新UI,直接由装饰器触发不就行了,希望大家能够明白,以上呢只是简单的案例,在实际的开发中,子组件方法中可能很多的逻辑,比如网络请求,比如数据存储等等,并不是简单的UI更新。
程序员一鸣 程序员一鸣
2星期前
鸿蒙开发:如何更新对象数组
关于对象数组中的数据更新,目前例举了三种方式,一种是传统的装饰器方式,另外两种是针对数据源进行操作,数据源直接赋值的方式,适合简单、高频的单元素修改,性能最优且类型安全,而splice方法适合复杂操作或需保持引用稳定的场景,但需注意性能损耗,在实际的开发中可以根据需求,选择自己适合的方式。
飞龙AI 飞龙AI
2星期前
DevEcoStudio 中使用模拟器时如何过滤日志
DevEcoStudio中使用模拟器时如何过滤日志鸿蒙核心技术鸿蒙开发者工具DevEcoStudio在HilogSettingsFilter设置Logmessage:A03d00/JSAPP当你看到不断更新的日志时,你会不会崩溃因为Nofilters模式下