6 Star 9 Fork 3

HarmonyOS-TPC / Gloading

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

Gloading

介绍

  • 深度解耦Hos Hap中全局加载中、加载失败及空数据视图,为组件化改造过程中的解耦长征助力
  • 分离全局加载状态视图的实现和使用
  • 不需要在每个页面的布局文件中额外添加加载状态视图
  • 可用于Ability、Slice,也可用于为某个Component显示加载状态,还可用于各种列表Item(ListContainer等)
  • 轻量级:只有一个java文件,没有任何其它依赖,不到300行,其中注释占100+行,jar仅6K
  • 兼容性好: 兼容绝大多数第三方炫酷的LoadingComponent(在Adapter中将其作为Component提供给Gloading)
  • 可扩展:默认提供4种加载状态(加载中、加载失败、空数据、加载成功),支持自定义其它状态

演示

为Ability添加加载状态

加载成功 加载失败
点击重试
加载成功
无数据
个别页面使用特殊的Loading视图

为Component添加加载状态

用于Slice 用于ScrollView 用于ListContainer

背景

Loading动画几乎每个Hos Hap中都有。

一般在需要用户等待的场景,显示一个Loading动画可以让用户知道Hap正在加载数据,而不是程序卡死,从而给用户较好的使用体验。

同样的道理,当加载的数据为空时显示一个数据为空的视图、在数据加载失败时显示加载失败对应的UI并支持点击重试会比白屏的用户体验更好一些。

加载中、加载失败、空数据的UI风格,一般来说在Hap内的所有页面中需要保持一致,也就是需要做到全局统一。

传统的做法

  1. 定义一个(或多个)显示不同加载状态的控件或者xml布局文件(例如:LoadingComponent
  2. 每个页面的布局中都写上这个component
  3. BaseAbility/BaseSlice中封装LoadingComponent的初始化逻辑,并封装加载状态切换时的UI显示逻辑,暴露给子类以下方法:
    • void showLoading(); //调用此方法显示加载中的动画
    • void showLoadFailed(); //调用此方法显示加载失败界面
    • void showEmpty(); //调用此方法显示空页面
    • void onClickRetry(); //子类中实现,点击重试的回调方法
  4. BaseAbility/BaseSlice的子类中可通过上一步的封装比较方便地使用加载状态显示功能

这种使用方式耦合度太高,每个页面的布局文件中都需要添加LoadingComponent,使用起来不方便而且维护成本较高,一旦UI设计师需要更改布局,修改起来成本较高。

好一点的封装方法

  1. 定义一个(或多个)显示不同加载状态的控件或者xml布局文件(例如:LoadingComponent
  2. 定义一个工具类(LoadingUtil)来管理LoadingComponent,不同状态显示不同的UI(或者在多个Component之间切换显示)
  3. BaseAbility/BaseSlice中对LoadingUtil的使用进行封装,暴露给子类以下方法:
    • void showLoading(); //调用此方法显示加载中的动画
    • void showLoadFailed(); //调用此方法显示加载失败界面
    • void showEmpty(); //调用此方法显示空页面
    • void onClickRetry(); //子类中实现,点击重试的回调方法
    • abstract int getContainerId(); //子类中实现,LoadingUtil动态创建LoadingComponent并添加到该方法返回id对应的控件中
  4. BaseAbility/BaseSlice的子类中可通过上一步的封装比较方便地使用加载状态显示功能

这种封装的好处是通过封装动态地创建LoadingComponent并添加到指定的父容器中,让具体页面无需关注LoadingComponent的实现,只需要指定在哪个容器中显示即可,很大程度地进行了解耦。如果公司只在一个Hap中使用,这基本上就够了。

但是,这种封装方式还是存在耦合:页面与它所使用的LoadingComponent仍然存在绑定关系。如果需要复用到其它Hap中,因为每个App的UI风格可能不同,对应的LoadingComponent布局也可能会不一样,要想复用必须先将页面与LoadingComponent解耦。

如何解耦?

梳理一下我们需要实现的效果

  • 页面的LoadingComponent可切换,且不需要改动页面代码
  • 页面中可指定LoadingComponent的显示区域(例如导航栏Title不希望被LoadingComponent覆盖)
  • 支持在Slice中使用
  • 支持加载失败页面中点击重试
  • 兼容不同页面显示的UI有细微差别(例如提示文字可能不同)

使用Gloading来解耦

Gloading是一个基于Adapter思路实现的深度解耦Hap中全局LoadingComponent的轻量级工具(只有一个java文件,不到300行,其中注释占100+行,aar仅6K)

1、 依赖

allprojects{
    repositories{
        mavenCentral()
    }
}
implementation 'io.openharmony.tpc.thirdlib:Gloading:1.0.3'

2、 创建Adapter,在getComponent方法中实现创建各种状态视图(加载中、加载失败、空数据等)的逻辑

Gloading不侵入UI布局,完全由用户自定义

public class GlobalAdapter implements Gloading.Adapter {
    @Override
    public Component getComponent(Gloading.Holder holder, Component convertComponent, int status) {
        GlobalLoadingStatusView loadingStatusView = null;
        //convertComponent为可重用的布局
        //Holder中缓存了各状态下对应的View
        //	如果status对应的Component为null,则convertComponent为上一个状态的Component
        //	如果上一个状态的Component也为null,则convertComponent为null
        if (convertComponent != null && convertComponent instanceof GlobalLoadingStatusView) {
            loadingStatusView = (GlobalLoadingStatusView) convertComponent;
        }
        if (loadingStatusView == null) {
            loadingStatusView = new GlobalLoadingStatusView(holder.getContext(), holder.getRetryTask());
        }
        loadingStatusView.setStatus(status);
        return loadingStatusView;
    }
    
    class GlobalLoadingStatusView extends DependentLayout {

        public GlobalLoadingStatusView(Context context, Runnable retryTask) {
            super(context);
            //初始化LoadingComponent
            //如果需要支持点击重试,在适当的时机给对应的控件添加点击事件
        }
        
        public void setStatus(int status) {
            //设置当前的加载状态:加载中、加载失败、空数据等
            //其中,加载失败可判断当前是否联网,可现实无网络的状态
            //		属于加载失败状态下的一个分支,可自行决定是否实现
        }
    }
}

3、 初始化Gloading的默认Adapter

Gloading.initDefault(new GlobalAdapter());

4、在需要使用LoadingComponent的地方获取Holder

//在Ability中显示, 父容器为: mLayout
Gloading.Holder holder = Gloading.getDefault().wrap(ability, mLayout);

//需要支持加载失败后点击重试
Gloading.Holder holder = Gloading.getDefault().wrap(ability, mLayout).withRetry(retryTask);

or

//为某个Component显示加载状态
//Gloading会自动创建一个FrameLayout,将Component包裹起来,LoadingComponent也显示在其中
Gloading.Holder holder = Gloading.getDefault().wrap(component);

//需要支持加载失败后点击重试
Gloading.Holder holder = Gloading.getDefault().wrap(component).withRetry(retryTask);

4.1 如果父容器为 DependentLayout,用cover可以保持与同级其它控件之间的关联关系

Gloading.Holder holder = Gloading.getDefault().cover(component);
//或
Gloading.Holder holder = Gloading.getDefault().cover(component).withRetry(retryTask);

5、 使用Holder来显示各种加载状态

//显示加载中的状态,通常是显示一个加载动画
holder.showLoading() 

//显示加载成功状态(一般是隐藏LoadingComponent)
holder.showLoadSuccess()

//显示加载失败状态
holder.showFailed()

//数据加载完成,但数据为空
holder.showEmpty()

//如果以上默认提供的状态不能满足使用,可使用此方法调用其它状态
holder.showLoadingStatus(status)

6、 兼容多App场景下的页面、Component的复用

每个Hap的LoadingComponent可能会不同,只需为每个Hap提供不同的Adapter,不同App调用不同的Gloading.initDefault(new GlobalAdapter());,具体页面中的使用代码无需改动。

开启/关闭Debug模式

//设置为true时Logcat会输出日志
Gloading.debug(trueOrFalse);

调用差异

Gloading.Holder holder = Gloading.getDefault().wrap(activity);

改为

//需要将父布局传入
Gloading.Holder holder = Gloading.getDefault().wrap(ability, mLayout);

示例entry运行要求

通过DevEco studio,并下载SDK 将项目中的build.gradle文件中dependencies→classpath版本改为对应的版本(即你的IDE新建项目中所用的版本)

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.

About

深度解耦Hos Hap中全局加载中、加载失败及空数据视图,为组件化改造过程中的解耦长征助力 expand collapse
Java
Apache-2.0
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/HarmonyOS-tpc/Gloading.git
git@gitee.com:HarmonyOS-tpc/Gloading.git
HarmonyOS-tpc
Gloading
Gloading
master

Search

344bd9b3 5694891 D2dac590 5694891