HarmonyOs开发:轮播图Banner组件封装与使用

前言

轮播图在每个项目中都很常见,鸿蒙中在容器组件中也提供了Swiper组件,用于子组件滑动轮播显示,和前端的使用起来也是异曲同工,我们先看下基本的用法。

Swiper() {
          ForEach(["1", "2", "3", "4", "5", "6"], (item: string) => {
            Text(item.toString())
              .width('90%')
              .height(160)
              .backgroundColor(0xAFEEEE)
              .textAlign(TextAlign.Center)
              .fontSize(30)
          }, (item: string) => item)
        }

以上的代码便轻松的实现了一个轮播图效果,当然了,只是一个简单的案例,很多属性并没有设置,按照正常的使用而言,确实没必要再搞什么封装,但是,有一个潜在的问题是需要封装的,比如使用懒加载数据的时候,不封装的话,每实现一个轮播图就需要重复大量的代码,这显然是冗余的;还有一种场景,那就是,系统的轮播无法满足我们的需求,这种情况下,是不得不进行封装的。

本文的大致内容如下:

1、简单封装之后的代码及效果展示

2、基于Swiper进行懒加载数据和普通数据封装

3、开源地址

4、相关总结

一、简单封装之后的代码及效果展示

封装的Banner已经上传到了远程仓库,使用起来也是非常的简单

方式一:在Terminal窗口中,执行如下命令安装三方包,DevEco Studio会自动在工程的oh-package.json5中自动添加三方包依赖。

    ohpm install @abner/banner

方式二:在工程的oh-package.json5中设置三方包依赖,配置示例如下:


    "dependencies": { "@abner/banner": "^1.0.2"}

效果没什么好说的,都是用Swiper组件所封装的。

代码实现上,毕竟采取了封装,简化了大量的代码,简单的案例如下:

Banner({
          data: ["1", "2", "3", "4", "5", "6"],
          itemPage: this.itemPage
       })

更多的案例,就不贴了,直接去看第3项中的开源地址即可。

相关属性配置

属性 类型 概述
data Array 数据源
itemPage (index: number, item: Object) banner对应的页面
onChange 回调函数 条目切换监听
bannerHeight Length banner高度
bannerWidth Length banner宽度
autoPlay boolean 是否自动播放,默认false
interval number 默认3秒轮播一次
disableSwipe boolean 是否禁止滑动
itemSpace number 子组件之间的间隙
currentIndex number 选中,默认第0个
indicator DotIndicator / DigitIndicator / boolean 指示器
isLineIndicator boolean 是否是自定义的线条指示器
indicatorType IndicatorType 指示器位置
lineIndicatorWidth number 线条指示器宽度
lineIndicatorHeight number 线条指示器高度
lineIndicatorBgColor ResourceColor 线条指示器背景
lineMargin Margin / Length 线条指示器边距
isLoop boolean 是否开启循环,默认是循环
indicatorRules 回调函数 线条指示器位置
isLazyData boolean 是否使用数据懒加载
lazyCachedCount number 缓存条目数量,默认是1
onLazyDataSource (dataSource: BannerDataSource) 回调函数,用于控制数据的增删

二、基于Swiper进行懒加载数据和普通数据封装

首先Swiper的子组件是支持ForEach和LazyForEach进行渲染数据的,LazyForEach也就是数据懒加载模式,也是官方案例中默认推荐的模式,当组件滑出可视区域外时,框架会进行组件销毁回收以降低内存占用,但是两种渲染数据,在代码逻辑上是完全不同的。

ForEach就比较的简单,数据源是一个数组,在封装上也是非常的简洁:

    Swiper(this.swiperController) {
            ForEach(this.data, (item: Object, index: number) => {
              this.itemPage(index, item)
            })
          }

LazyForEach模式,使用起来相对复杂,组件的创建包括两种情况:LazyForEach首次渲染和LazyForEach非首次渲染,这些都是需要考虑的。

ForEach数据加载,我们只考虑数据源的变化即可,但在LazyForEach中,必须使用DataChangeListener对象来进行更新,需要我们创建新的对象,实现IDataSource,进行数据的增删改查。

    /**
     * AUTHOR:AbnerMing
     * DATE:2024/2/23
     * INTRODUCE:懒加载数据
     * */
    export class BannerDataSource implements IDataSource {
      private listeners: DataChangeListener[] = []
      private originDataArray: Object[] = []

      /**
       * AUTHOR:AbnerMing
       * INTRODUCE:返回列表数量
       * */
      totalCount(): number {
        return this.originDataArray.length
      }

      /**
       * AUTHOR:AbnerMing
       * INTRODUCE:返回某一个对象
       * */
      getData(index: number): Object {
        return [this.originDataArray[index]]
      }

      /**
       * AUTHOR:AbnerMing
       * INTRODUCE:该方法为框架侧调用,为LazyForEach组件向其数据源处添加listener监听
       * */
      registerDataChangeListener(listener: DataChangeListener): void {
        if (this.listeners.indexOf(listener) < 0) {
          this.listeners.push(listener);
        }
      }

      /**
       * AUTHOR:AbnerMing
       * INTRODUCE:该方法为框架侧调用,为对应的LazyForEach组件在数据源处去除listener监听
       * */
      unregisterDataChangeListener(listener: DataChangeListener): void {
        const pos = this.listeners.indexOf(listener);
        if (pos >= 0) {
          this.listeners.splice(pos, 1);
        }
      }

      // 通知LazyForEach组件需要重载所有子组件
      notifyDataReload(): void {
        this.listeners.forEach(listener => {
          listener.onDataReloaded();
        })
      }

      // 通知LazyForEach组件需要在index对应索引处添加子组件
      notifyDataAdd(index: number): void {
        this.listeners.forEach(listener => {
          listener.onDataAdd(index);
        })
      }

      // 通知LazyForEach组件在index对应索引处数据有变化,需要重建该子组件
      notifyDataChange(index: number): void {
        this.listeners.forEach(listener => {
          listener.onDataChange(index);
        })
      }

      // 通知LazyForEach组件需要在index对应索引处删除该子组件
      notifyDataDelete(index: number): void {
        this.listeners.forEach(listener => {
          listener.onDataDelete(index);
        })
      }

      // 通知LazyForEach组件将from索引和to索引处的子组件进行交换
      notifyDataMove(from: number, to: number): void {
        this.listeners.forEach(listener => {
          listener.onDataMove(from, to);
        })
      }

      //初始化数据
      public addData(index: number, data: Object): void {
        this.originDataArray.splice(index, 0, data);
        this.notifyDataAdd(index);
      }

      //追加数据
      public pushData(data: Object): void {
        this.originDataArray.push(data);
        this.notifyDataAdd(this.originDataArray.length - 1);
      }

      //删除数据
      public deleteData(index: number): void {
        this.originDataArray.splice(index, 1);
        this.notifyDataDelete(index);
      }

      //交换数据
      public moveData(from: number, to: number): void {
        let temp: Object = this.originDataArray[from];
        this.originDataArray[from] = this.originDataArray[to];
        this.originDataArray[to] = temp;
        this.notifyDataMove(from, to);
      }

      /**
       * AUTHOR:AbnerMing
       * INTRODUCE:改变单个数据
       * */
      public changeData(index: number, data: Object): void {
        this.originDataArray.splice(index, 1, data);
        this.notifyDataChange(index);
      }

      //重置所有子组件的index索引
      public reloadData(): void {
        this.notifyDataReload();
      }

    }

对于以上封装之后,在使用上需要注意,也就是更新数据的时候:

声明变量:


     @State bannerDataSource: BannerDataSource = new BannerDataSource()

赋值变量:


    Banner({
              data: ["1", "2", "3", "4", "5", "6"],
              itemPage: this.itemPage,
              onLazyDataSource: (dataSource: BannerDataSource) => {
                this.bannerDataSource=dataSource
              }
            })

行为操作:


    this.bannerDataSource.pushData()//追加数据
    this.bannerDataSource.deleteData()//删除数据

三、开源地址

在开源地址中,对各个案例的使用方式,也做了相信的介绍。

https://ohpm.openharmony.cn/#/cn/detail/@abner%2Fbanner

四、相关总结

目前的轮播图,仅仅对Swiper做了简单的封装,另外增加了一个线条指示器,这远远是不够的,毕竟日常的轮播图形式多种多样,指示器也是千奇百怪,后续也会在此基础之上进行不断的扩展。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,204评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,091评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,548评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,657评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,689评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,554评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,302评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,216评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,661评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,851评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,977评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,697评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,306评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,898评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,019评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,138评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,927评论 2 355

推荐阅读更多精彩内容