Gloading 开源项目使用指南

Gloading 开源项目使用指南

GloadingShow global loading status view in a low coupling way for Android App(超轻量级，深度解耦Android App中全局加载中、加载失败及空数据视图)项目地址:https://gitcode.com/gh_mirrors/gl/Gloading

一、项目介绍

Gloading是一款轻量级的Android加载状态显示库，专为低耦合应用程序设计。它可以在你的App中优雅地展示各种加载状态，如加载中、加载失败、空数据等。Gloading的核心特性包括：

• 极简体积: AAR文件小于6KB。
• 精炼代码: 只有一个Java文件，共约170行代码和104行注释。
• 适配广泛: 设计遵循适配器模式，能够兼容大多数第三方加载视图。

在GitHub上查看最新版本的文档及示例代码.

二、项目快速启动

添加依赖

在你的build.gradle文件中添加以下依赖：

dependencies {
    implementation 'com.billy.android:gloading:latest_version'
}

请注意将latest_version替换为你所需的Gloading具体版本号。

初始化Gloading

在你的应用程序中初始化Gloading:

// 在Application或Activity的onCreate方法内调用
Gloading.initDefault(new GlobalAdapter());

这里的GlobalAdapter是提供不同加载状态视图（如加载中、加载失败）的适配器类实例。你可以自定义实现以适应你的UI需求。

展示加载状态

覆盖页面展示不同的加载状态:

// 创建并获取全局的Gloading Holder对象
GloadingHolder holder = Gloading.getDefault().wrap(yourActivity);

// 展示不同的加载状态
holder.showLoading();       // 加载中状态
holder.showLoadSuccess();   // 加载成功且有数据时隐藏Gloading
holder.showFailed();        // 加载失败状态，通常会包含重试按钮
holder.showEmpty();         // 数据为空但已加载完成的状态

三、应用案例和最佳实践

应用于BaseActivity/BaseFragment

为了简化每次的调用过程，建议在基类(BaseActivity/BaseFragment)中封装Gloading的操作：

public abstract class BaseActivity extends AppCompatActivity {

    private GloadingHolder mHolder;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        // 在onCreate中初始化Gloading
        mHolder = Gloading.getDefault().wrap(this);
    }

    // 示例: 显示加载状态
    public void showLoading() {
        if (mHolder != null) {
            mHolder.showLoading();
        }
    }
    
    // 其他类似方法...
}

自定义Adapter实现

通过自定义Gloading.Adapter子类来灵活控制每种加载状态下的UI表现：

public class CustomGlobalAdapter implements Gloading.Adapter {

    @Override
    public View getView(GloadingHolder holder, View convertView, int status) {
        
        switch (status) {
            case Gloading.STATUS_LOADING:
                // 返回加载中的视图
                break;
            case Gloading.STATUS_SUCCESS:
                // 返回加载成功后的默认视图或者隐藏视图
                break;
            case Gloading.STATUS_FAILED:
                // 返回加载失败的视图，可以带有重试按钮
                break;
            case Gloading.STATUS_EMPTY:
                // 返回无数据的视图
                break;
            default:
                // 默认情况下的处理
                break;
        }
        
        return convertView;
    }
}

然后，在初始化Gloading时传递这个自定义adapter。

四、典型生态项目

Gloading的设计原则使其能够无缝融入到任何遵循MVP/MVVM架构的项目中。无论是复杂的应用程序还是简单的演示Demo，都能够利用Gloading轻松处理各种加载状态。例如，在一个MVVM架构的App中，ViewModel负责异步数据请求，而Activity或Fragment只需简单关注于如何呈现这些状态变化即可。

由于其高度灵活性，Gloading经常被集成进诸如BaseActivity或BaseFragment这样的基础组件中，使得所有继承它们的活动或片段自动获得统一的加载状态管理能力。

此外，对于那些需要额外自定义加载界面的情况，开发者可以通过扩展Gloading Adapter的方式注入特定主题的布局资源，确保应用风格的一致性。

总之，Gloading作为一款专注于Android加载状态展现的小工具，凭借其超小体量、简洁API以及强大的适配能力，在实际项目开发中展现出极大的实用价值和灵活性，成为众多开发者推崇的选择之一。

希望这份指南能帮助你在自己的项目中更有效地运用Gloading，提升用户体验的同时降低开发负担！

---

以上就是基于luckybilly/Gloading开源项目的详细使用指南，如果你有任何疑问或遇到问题，欢迎访问项目主页获取更多支持。祝编码愉快！

GloadingShow global loading status view in a low coupling way for Android App(超轻量级，深度解耦Android App中全局加载中、加载失败及空数据视图)项目地址:https://gitcode.com/gh_mirrors/gl/Gloading