页面预览

前言

@Builder 和 @BuilderParam 是 ArkUI 中实现 UI 模板化和插槽模式的装饰器。@Builder 用于封装可复用的 UI 片段，@BuilderParam 用于在组件中预留插槽，让父组件自定义渲染内容。本文以小事记（xiaoshiji_ohos_app） 的 HomePage.ets 为分析对象，深入解析 @Builder 和 @BuilderParam 的使用。

本文参考 HarmonyOS 官方文档：arkts-builder.md 和 arkts-builderparam.md。

一、@Builder 的基本用法

1.1 基本结构

// @Builder 的基本用法
@Entry
@Component
struct HomePage {
  build() {
    Column() {
      this.buildStatsCard()
      this.buildEventItem(event, 0)
    }
  }

  @Builder
  buildStatsCard() {
    Stack() {
      Column()
        .width('100%')
        .height(200)
        .linearGradient({ angle: 135, colors: [['#7B68EE', 0.0], ['#DDA0DD', 1.0]] })
        .borderRadius(20)
      // 内容
    }
  }

  @Builder
  buildEventItem(event: LifeEvent, index: number) {
    Row() {
      // 事件卡片内容
    }
  }
}

二、@BuilderParam 插槽模式

2.1 基本用法

// 定义带插槽的组件
@Component
struct Card {
  @BuilderParam content?: () => void;

  build() {
    Column() {
      Column() {
        if (this.content) {
          this.content()  // 渲染插槽内容
        }
      }
      .padding(12)
      .backgroundColor(Color.White)
      .borderRadius(12)
    }
  }
}

// 使用插槽组件
@Entry
@Component
struct HomePage {
  build() {
    Card() {
      Text('自定义内容')
        .fontSize(16)
    }
  }
}

三、@Builder 与 @BuilderParam 对比

对比维度 @Builder @BuilderParam
用途 封装 UI 片段 定义插槽
调用方 组件内部 父组件
复用性 方法级复用 内容级定制
传参 显式传参 闭包捕获

四、最佳实践

策略 说明 效果
@Builder 封装 提取重复 UI 代码简洁
@BuilderParam 插槽 定义可定制区域 灵活组合
闭包传参 使用闭包传递参数 简化调用

八、拓展阅读

本节汇总了与本文主题相关的扩展阅读材料，帮助读者深入理解相关技术细节。

8.1 官方文档

8.2 相关技术文章

  • 性能优化最佳实践
  • 常见问题排查指南

8.3 社区资源

八、实战案例

8.1 场景描述

在实际项目中，本文介绍的技术点通常与其他组件配合使用，形成完整的交互流程。以下是一个综合应用示例。

8.2 代码示例

// 综合应用示例
@Entry
@Component
struct Demo {
  build() {
    Column({ space: 12 }) {
      Text("实战案例演示")
        .fontSize(18)
        .fontWeight(FontWeight.Bold)
      // 具体实现根据文章主题调整
    }
    .width("100%")
    .padding(20)
  }
}

8.3 要点总结

  • 理解核心原理比记忆 API 更重要
  • 实际开发中应注意性能优化和边界情况处理
  • 多参考官方文档获取最新 API 变更

十、最佳实践与优化建议

在实际开发中，合理运用上述技术可以显著提升应用的性能和用户体验。以下是几个关键的最佳实践建议：

10.1 性能优化要点

优化方向 具体措施 预期效果
渲染性能 减少不必要的组件重建 提升帧率
内存管理 及时释放不再使用的资源 降低内存占用
响应速度 避免在主线程执行耗时操作 提升交互流畅度

10.2 推荐实践步骤

按照以下步骤进行优化：

  1. 使用 DevEco Studio 的 Profiler 工具分析当前性能瓶颈
  2. 针对识别出的热点进行针对性优化
  3. 通过单元测试和集成测试验证优化效果
  4. 在真机环境下进行回归测试

10.3 代码示例

// 推荐的最佳实践示例
@Component
export struct OptimizedComponent {
  // 使用 @State 管理最小粒度的状态
  @State private isActive: boolean = false;

  build() {
    Column() {
      Text(this.isActive ? '激活' : '未激活')
        .fontSize(16)
    }
    .onClick(() => {
      // 使用 animateTo 实现平滑过渡
      animateTo({ duration: 300 }, () => {
        this.isActive = !this.isActive;
      });
    });
  }
}

最佳实践提示：在编写代码时，始终遵循 ArkUI 的性能优化原则，避免在 build() 方法中执行复杂计算或频繁的状态更新。

十、进一步学习与拓展

掌握以上内容后，可以进一步探索以下相关主题，深化对 HarmonyOS 开发的理解：

10.1 推荐学习路径

学习阶段 主题 预期目标
基础阶段 掌握核心概念和 API 用法 能够独立完成基本功能开发
进阶阶段 理解底层原理和最佳实践 能够优化应用性能和用户体验
高级阶段 掌握架构设计和性能调优 能够主导复杂项目的技术方案

10.2 实践项目建议

建议通过以下实践项目巩固所学知识：

  1. 基于小事记项目，尝试独立实现一个类似的功能模块
  2. 阅读 HarmonyOS 官方 Sample 代码，学习最佳实践
  3. 参与开源社区，贡献代码或文档

10.3 相关资源

  • HarmonyOS 官方文档：提供完整的 API 参考和开发指南
  • DevEco Studio 文档：包含 IDE 使用技巧和调试方法
  • 开源社区：获取项目源码和开发经验

学习建议：理论与实践相结合，在阅读文档的同时动手编写代码，才能更好地掌握 HarmonyOS 应用开发技能。

10.4 拓展阅读

以下资源可以加深对本文内容的理解：

  1. HarmonyOS 官方开发者文档提供了最权威的 API 参考和最佳实践指南
  2. 开源社区的项目源码是学习实际应用开发的宝贵资源
  3. DevEco Studio 的代码示例模板可以帮助快速上手
资源类型 推荐指数 适用人群
官方文档 ⭐⭐⭐⭐⭐ 所有开发者
开源项目 ⭐⭐⭐⭐ 中级开发者
技术博客 ⭐⭐⭐ 入门开发者

学习路径：建议按照"官方文档 → 开源项目 → 实践项目"的路径循序渐进地学习。

总结

// 状态管理示例
@State count: number = 0;

build() {
  Column() {
    Text(`计数: ${this.count}`)
      .fontSize(20)
    Button("增加")
      .onClick(() => {
        this.count++;
      })
  }
}

本文深入解析了 @Builder 和 @BuilderParam 的使用。核心要点如下：

  1. @Builder：封装可复用的 UI 片段，支持传参
  2. @BuilderParam：定义插槽，让父组件自定义渲染内容
  3. 插槽模式：实现组件的灵活组合
  4. 模板化构建：减少重复代码

如果这篇文章对你有帮助，欢迎点赞👍、收藏⭐、关注🔔，你的支持是我持续创作的动力！

// 使用 @Watch 监听状态变化
@State @Watch("onCountChange") count: number = 0;

onCountChange(): void {
  console.log(`count 变化为: ${this.count}`);
}

// 数据绑定示例
@Entry
@Component
struct DataBinding {
  @State message: string = "Hello HarmonyOS";

  build() {
    Column() {
      Text(this.message)
        .fontSize(20)
        .fontColor("#7B68EE")
    }
    .width("100%")
    .height("100%")
    .justifyContent(FlexAlign.Center)
  }
}

// 条件渲染示例
@State isVisible: boolean = false;

build() {
  Column() {
    if (this.isVisible) {
      Text("内容可见")
        .fontSize(16)
    }
    Button("切换")
      .onClick(() => {
        this.isVisible = !this.isVisible;
      })
  }
}

九、完整示例代码

9.1 完整组件实现

以下是一个完整的组件实现示例，展示了本文介绍的各个技术点的综合运用：

import { Component, State, Prop } from '@kit.ArkUI';

@Component
export struct DemoComponent {
  @Prop title: string = '';
  @State count: number = 0;

  build() {
    Column({ space: 12 }) {
      // 标题区域
      Text(this.title)
        .fontSize(18)
        .fontWeight(FontWeight.Bold)
        .fontColor('#1A1A2E')
        .width('100%')

      // 内容区域
      Text(`当前计数: ${this.count}`)
        .fontSize(14)
        .fontColor('#6B7280')

      // 交互按钮
      Button('点击增加')
        .width(120)
        .height(40)
        .backgroundColor('#7B68EE')
        .borderRadius(20)
        .fontColor(Color.White)
        .onClick(() => {
          this.count++;
        })
    }
    .width('100%')
    .padding(16)
    .backgroundColor(Color.White)
    .borderRadius(12)
    .shadow({ radius: 4, color: '#00000008', offsetX: 0, offsetY: 2 })
  }
}

9.2 使用方式

在页面中引入并使用该组件：

@Entry
@Component
struct Index {
  build() {
    Column() {
      DemoComponent({ title: '示例组件' })
    }
    .width('100%')
    .height('100%')
    .backgroundColor('#F8F9FA')
  }
}

9.3 代码说明

  • 组件封装：使用 @Component 装饰器定义可复用的组件
  • 状态管理：使用 @State 管理组件内部状态
  • 参数传递：使用 @Prop 接收外部传入的参数
  • 事件处理：使用 onClick 处理用户交互
  • 样式优化：使用 borderRadius、shadow 等属性美化 UI

相关资源：

# harmonyos # 华为
Logo
HarmonyOS开发者社区

讨论HarmonyOS开发技术，专注于API与组件、DevEco Studio、测试、元服务和应用上架分发等。

更多推荐

cover

HarmonyOS7 平板双栏布局真的很香：列表和详情别再来回跳

avatar HarmonyOS开发者社区
cover

HarmonyOS 6.0 自定义绘图表盘与仪表

avatar HarmonyOS开发者社区
cover

HarmonyOS7 RelativeContainer 减少嵌套：资料卡别套太多层

avatar HarmonyOS开发者社区