Skip to content

bladeofgod/Bedrock

Repository files navigation

🐳Flutter Bedrock

🌱v 2.2.0

一款基于MVVM+Provider的快速开发框架。

欢迎提issue和pr,如果对你有帮助的话,给个⭐⭐star⭐⭐吧。 ^.^

我的联系方式:[email protected]

声明

已由 SheepYang1993 迁移到Flutter 2.0, 非常感谢帮助。
框架版本也从2.0.x开始增长。

更新日志

关于集成

框架与插件性质不太相同,且由于个人精力有限可能更新不太及时,建议clone后本地添加,或者fork后yaml依赖。
这样可以解决更新不及时,和定制化需要。

此项目的statefulWidget和路由及相关模块做了二次封装,请务必阅读下方文章加以了解

请看我——bedrock框架的widget和路由入门简介

绘声绘色的Demo

仿网易云音乐APP

主要特性

Android

Android端增加了异常保护 :
全部开启后,理论上,应用在安卓端将不再会崩溃。
(极为严重的连续性异常和系统异常依然会崩溃,不过也可以通过调整策略避免崩溃,但不建议这样)
            //在BaseApp的onCreate内
            AndroidPlatformProtect.initProtect(new DefaultActivityExceptionHandler())
                    ///处理UI线程的异常
                    .protectUIThread()
                    ///处理 activity生命周期的异常
                    .protectActivityStart()
                    ///处理子线程异常
                    .protectChildThread()
                    .init(this);

DefaultActivityExceptionHandler,发生异常后的善后类:
    默认是回退到上一页(或者退出应用),并输出log。

Tip:
建议继承ActivityExceptionHandler 并自定义相关操作。

Tip:
如果是纯flutter项目,
可以考虑注释掉这两个保护[protectUIThread]和[protectActivityStart]
混合项目(或引入的插件含有原生端)的话,可以考虑开启
[protectActivityStart]在混淆下可能会无效或者出现无法预知的问题,建议混淆方案中忽视它(或者屏蔽它)。

Flutter

1、MVVM+Provider,低耦合、逻辑分明、页面代码清晰。Provider提供的状态管理使页面控制和展现更为灵活方便

2、全局异常捕捉:接口业务型和语法型,业务型可根据需要进行处理(如未登录、未授权、超时、无网等等)并实现页面自动切换,语法型可以跳转到指定页面避免红屏(还可在此页面做日志上传)。

3、基础类PageState/WidgetState-Basestate-State、BaseStatelessWidget-StatelessWidget和BaseSkeletonWidget,对常用功能函数进行了封装,轻松配 置骨架屏、屏幕适配、异形屏适配等

4、基类ProviderWidget-Provider和ViewstateModel-ChangeNotifier对 provider等的封装、底层封装了一些常用状态和异常处理功能

5、全局cookie默认SharedPreferences,基础拦截器自动上传app版本等(可以根据需求自定)

6、页面侧滑退出,路由管理模块,常用页面跳转动画的封装等

7、全局toast、骨架屏、缓存、格式化文字、图片选择裁剪和上传、瀑布流和各种Util这些都是优秀的插件所提供的功能(再次感谢所有开源作者)

8、基于Intl的国际化、APP主题切换。

9、你的viewmodel只要是继承ViewStateModel,并注册CacheDataFactory,就可以实现首次加载自动缓存,无网自动显示上次缓存(缓存方式采用的mmkv 高速缓存)

10、viewmodel 混入ExceptionBinding后,可以在内部对所有api 业务异常进行监听。

...更多可以查看更新日志

使用方法

引入

1、将项目clone(master分支)下来,(注意,clone后不要无脑next,其中一步更换项目名时,换为你的)

2、更换 pubspec.yaml中name属性为你的项目名称, 点一下pub get (这时你的项目爆红)

3、全局查找 flutter_bedrock 替换为上面 name 的值(这时项目恢复正常)

4、删除page文件夹下的 demo_page和mine两个文件夹

5、根目录的 README.md和update_log.md 也删除

开发

墙裂建议运行DEMO并查看源码和注释,以及pub中的注释(其中有很多使用频率很高的插件,可以查看他们的文档,熟练使用能提高开发效率)。

很简单,如下操作:
    1、页面/wiget,继承PageState/WidgetState/BaseStatelessWidget
    2、骨架屏继承BaseSkeletonWidget
    3、ViewModel(VM)继承 ViewStateModel的子类,如:SingleViewStateModel、RefreshListViewStateModel(也可以根据需求自己封装)
    
页面代码如下(页面请使用PageState):

class APageState extends PageState{
@override
 Widget build(BuildContext context) {
     return switchStatusBar2Dark(
     ///全局VM 如:用户VM,可以在登录登出时对整个项目进行状态刷新和管理。
     ///框架自己也定义了一些常用地全局VM  可见DEMO
        child: Consumer<全局VM>(
        builder:(ctx,全局VM,child){
            ///当前页面的VM
            return ProviderWidget<当前页面VM>(
                model:初始化你的vm
                onModelReady:(model){
                    启动你的model,///可选
                }
                builder(ctx,你的vm,child){
                    reutrn 你的页面;
                }
            );
            
        }
        )
     );
 }

}
    
    
你的ViewModel(VM)代码:
///自定义ViewModel话,继承自ViewStateModel即可
class YourPageViewModel extends SingleViewStateModel{
    
}

具体使用方法可以见DEMO

GITHUB 集成

当你clone下项目后,可以看到一下几个文件:
    main ///入口
    base_framework ///bedrock 框架核心文件夹
    I10n  /// I10n插件创建,也可能是得你自己手动创建,具体可以百度I10n 了解
    generated ///I10n 在你编辑语言文件后自动生成的 ,请不要编辑这个文件夹下的内容
    page ///你的项目页面  
    service_api  ///项目接口 对应原生的repository
    

我暂时没有打算把base_framework摘出来,通过pub来集成,因为个人可能都有自己的定制需求,pub集成并不便于按照自己的需求修改。 
况且,直接clone集成还是非常简单的,只需要clone项目后将除了base_framework的其它文件夹删除即可。

DEMO

主要分为两部分:功能性演示和综合性演示。请直接clone项目进行运行浏览,我在DEMO加了详尽的注释,强烈建议运行和阅读DEMO的代码。

感谢

再次感谢广大开源者的奉献和大佬的分享,菜鸟的成长离不开各位的帮助。
此框架属于菜鸡初试身手,稚嫩之处还请海涵,不足之处欢迎斧正,不胜感激。

后续

我会持续维护这个库,有问题欢迎提issue和pr,我会尽快回复。
欢迎打赏一杯咖啡,哈哈哈~

image

About

一款基于MVVM+Provider的快速开发框架。

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages