1 Star 0 Fork 0

Bytedance Inc./bGlobalViewPool

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

@bytedance/byte_global_viewpool

@bytedance/byte_global_viewpool是字节跳动自研鸿蒙组件全局复用池解决方案。https://github.com/bytedance/bGlobalViewPool

简介

本项目主要基于OpenHarmony NodeController与BuilderNode自定义挂载能力实现,从24年4月开始与华为深度合作完成。核心功能如下:

  • 业务轻量化接入自定义组件全局复用能力,业务生命周期与系统无差异。
  • 自定义组件全局预创建能力,保证组件首次使用直接复用
  • 具备复用池自动补池子能力
  • 支持全局开关配置
  • 支持节点类型数量阈值配置
  • 支持OnIdle预创建能力
  • 支持跨端组件预创建能力
  • 提供eventbus用于解决复用池组件与父组件状态变量链条断开问题
  • 提供全局清除复用池接口
  • 适配节点系统配置更新能力,比如暗黑模式

解决核心问题

  • 解决跨端组件预创建能力
  • 采用update与reuse拆帧处理降低丢帧
  • 与华为合作OnIdle接口预创建组件,防止阻塞主线程
  • 复用池自动补充池子能力,解决长列表池子快速清空的问题,大幅提升流畅度
  • 解决系统OnIdle任务积压导致掉帧问题

待实现特性

  • 监听内存,自定义清除或降低缓存
  • 自动补池子采用深拷贝技术,不再需要配置预置数据Func
  • 适配V2装饰器

下载安装

ohpm install @bytedance/byte_global_viewpool

使用说明

注:详细代码可见Entry

1.初始化

// 启动阶段
let config = new ViewPoolConfig()
this.initConifg(config)
ViewPoolManager.getInstance().initViewPoolConfig(config) // 设置配置
ViewPoolManager.getInstance().initContext(this.context) // 设置Context
ViewPoolManager.getInstance().setEnable(true) // 全局控制组件全局复用池的开关,true为打开。

function initConfig(config: ViewPoolConfig) {
    config.enablePreCreateWhenEmpty = true // 当复用池最后一个节点使用完时,是否使用闲时预创建该类型节点
    /*
        export function getAuthorInfoSliceParams(): ESObject
        {
              return {vm : new AuthorInfoSliceViewModel()}
        }        
    */
    // preCreateDataFuncMap要配合enablePreCreateWhenEmpty使用,只有设置了数据生成function的类型才能走闲时创建
    config.preCreateDataFuncMap.set("type", getAuthorInfoSliceParams)
    config.preCreateCountWhenEmpty = 2 // 目前没有在使用
    config.nodeMaxCount = 20 // 每个节点最大缓存数量
}

2.设置UIContext

注:不是必要设置

  onWindowStageCreate(windowStage: window.WindowStage): void {
    windowStage.loadContent('pages/Index', (err) => {
      ViewPoolManager.getInstance().setUIContext(windowStage.getMainWindowSync().getUIContext())
    });
  }

3.组件复用接入

// 第一步:业务组件提供全局创建Builder,并用WrapperBuilder封装
export const gContentSliceWrapper: WrappedBuilder<ESObject> = wrapBuilder<ESObject>(ContentSliceBuilder)

@Builder
export function ContentSliceBuilder($$: ESObject) {
  ContentSlice({
    mText: $$.mText
  })
}

// 第二步:使用Module接入xxx
  "dependencies": {
    "byte_global_viewpool": "file:../byte_global_viewpool"
  }
  
// 第三步:接入位置使用ViewPoolContainer容器封装即可
type:复用类型,一般为组件名
params:即传参
builder:组件全局WrapperBuilder
ViewPoolContainer({
    type: ViewPoolTypeConstants.CONTENT_SLICE,
    params: {
        mText: "我是复用池Text"
    },
    builder: gContentSliceWrapper
})

4.OnIdle预创建

前置条件:预创建的组件需要由复用池容器承载

第一步:业务组件提供全局创建Builder,同时提供获取预创建数据的function,这里一般都是空model
export const gContentSliceWrapper: WrappedBuilder<ESObject> = wrapBuilder<ESObject>(ContentSliceBuilder)

// 这个函数用于获取预创建数据,要保证数据每次获取引用不一致
export function getContentSliceParams(): ESObject
{
  return {mText : "预创建组件"}
}

@Builder
export function ContentSliceBuilder($$: ESObject) {
  ContentSlice({
    mText: $$.mText
  })
}

第二步:使用ViewPoolManager preCreateBuilderOnIdleFrame通过vsync周期内的OnIdle时机预创建
/*
* @description 通过UIContext的OnIdle时机预创建组件节点,下次使用快速复用。
* @param uiContext 组件的上下文,与WindowStage绑定,即窗口。
* @param builder 组件全局创建Builder入口
* @param data 这个需要重点关注,需要构建一个空的ViewModel对象,否则会崩溃
* @param type 复用的类型
* @param timeout(ns) onIdle剩余时间阈值,大于这个阈值才会预创建
* @param count 预创建的数量,默认为1
* @param isMeasure 是否主动调用framnode.measure,默认为false。主要为lynx卡片预创建使用
* */
  preCreateBuilderOnIdleFrame(uiContext: UIContext, builder: WrappedBuilder<ESObject>, data: ESObject, type: string, timeout: number, count: number = 1, isMeasure: boolean = false) {
      ...
  }
  
  // 注意这里走的vsync OnIlde的时机预创建,当vysnc剩余时间大于timeout(这里设置的是4ms)才会预创建
  // 因此预创建的组件要保证4ms能渲染出来,否则可能会掉帧
 ViewPoolManager.getInstance().preCreateBuilderOnIdleFrame(uiContext, gAuthorInfoSliceWrapper, getAuthorInfoSliceParams(),
      ViewPoolTypeConstants.UGC_POSTCARD_AUTHOR_INFO_SLICE, 4000000, 4)

生命周期日志解析

Demo为Entry

启动APP,进入Index页面
ContentSliceTAG aboutToAppear 我不是复用池Text // 非复用池组件走正常生命周期
ContentSliceTAG aboutToAppear 我是复用池Text // 复用池组件,由于没有预创建的组件进入池子,因此走正常的生命周期
// 预创建4个ContentSlice组件,生命周期先创建再回收,符合预期
ContentSliceTAG aboutToAppear 预创建组件
ContentSliceTAG aboutToRecycle 预创建组件
ContentSliceTAG aboutToAppear 预创建组件
ContentSliceTAG aboutToRecycle 预创建组件
ContentSliceTAG aboutToAppear 预创建组件
ContentSliceTAG aboutToRecycle 预创建组件
ContentSliceTAG aboutToAppear 预创建组件
ContentSliceTAG aboutToRecycle 预创建组件

跳转进入Index1页面
ContentSliceTAG aboutToAppear 我不是复用池Text // 非复用池组件走正常生命周期
ContentSliceTAG aboutToReuse 我是复用池Text // 复用池组件,复用池有缓存直接走aboutToReuse,不需要走重新创建

返回Index页面
ContentSliceTAG aboutToRecycle 我是复用池Text // 复用池组件回收到复用池

相关数据

  1. 复用池使用收益(提升40%)
    • 频道滑动(使用前):Jank率(1.1%/0.9%/1.3%)、最长帧耗时(20ms/19ms/18ms)
    • 频道滑动(使用后):Jank率(0.6%/0.7%/0.7%)、最长帧耗时(13ms/15ms/14ms)
    • 分析:由于长列表滑动开始前没有预创建,开始滑动Jank率较高。且滑动过快或过长池子很容易为空,复用池偶先效果不明显
  2. 预创建+补池子(提升50%)
    • 频道滑动:Jank率(0.3%/0.5%/0.2%)、最长帧耗时(9ms/8ms/9ms)
    • 分析:预创建解决列表首次滑动需要创建组件的丢帧,补池子解决长时间滑动池子很快为空的问题

注意事项

  1. 不能传递Provide类型,因为这个是自定义组件链的,NodeContainer已经打破了这个链,所以需要在手动传入
  2. 数据是一次性的,不支持同步响应,因为状态变量链条已经断裂
  3. 基础组件会低概率丢掉父容器的宽高,需要自定组件自己设置一下。目前只发现Text会有这个问题,一般自定义组件都会有容器包裹不会有这个问题。
  4. 复用组件不能被@Reusable修饰,否则会崩溃
  5. 自定义测量的跨端组件,即带有onMeasureSize的组件预创建无法触发aboutToAppear。系统原因:带有onMeasureSize的组件被识别为系统组件,预创建组件无法触发aboutToAppear
  6. 自定义Image组件需要在aboutToRecycle清空数据。

技术支持

  1. 邮件: wuqizhao@bytedance.com

License

Copyright (2024) Bytedance Ltd. and/or its affiliates

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
TypeScript
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/ByteDance/bGlobalViewPool.git
git@gitee.com:ByteDance/bGlobalViewPool.git
ByteDance
bGlobalViewPool
bGlobalViewPool
main

搜索帮助