Flutter 从0搭建一个完整的项目(三、页面基类的封装)

核心理念

化繁为简,最终使用时,简单易用,扩展性强即可。
1.简介
基类的封装,主要是统一管理,实现模板开发。子类只关心自己的展示即可,无需过多的关心其它操作。
2.基类封装的状态管理、路由管理,主要基于GetX。GetX的主要功能有:
2.1 状态管理 路由管理 依赖管理 国际化 主题等 
2.2 [GetX官网](https://pub.dev/packages/get)
3.定义基类页面的 状态管理类
/// 主要功能:页面各种状态的切换、网络请求的取消定义
class BaseController extends GetxController {
  /// 页面加载状态 在自定义加载类中
  var loadingState = LoadingState.loading.obs;
  /// 网络请求取消用
  CancelToken? cancelToken;

  /// 初始化
  @override
  void onInit() {
    super.onInit();
    cancelToken = CancelToken();
  }
  /// 销毁
  @override
  void onClose() {
    cancelToken?.cancel();
    cancelToken = null;
    super.onClose();
  }

  /// 重试
  void retry() {
    showLoading();
    // 准备好
    onReady();
  }

  /// 显示成功页面
  void showSuccess() {
    if (loadingState.value == LoadingState.success) {
      return;
    }
    loadingState.value = LoadingState.success;
  }

  /// 显示空页面
  void showEmpty() {
    if (loadingState.value == LoadingState.empty) {
      return;
    }
    loadingState.value = LoadingState.empty;
  }

  /// 显示错误页面
  void showError() {
    if (loadingState.value == LoadingState.error) {
      return;
    }
    loadingState.value = LoadingState.empty;
  }

  /// 显示加载中页面
  void showLoading() {
    if (loadingState.value == LoadingState.loading) {
      return;
    }
    loadingState.value = LoadingState.loading;
  }
}
4.定义基类
基类的主要功能:主要是页面流程的控制,模板开发。标题栏、页面背景、是否显示加载页面 等通用操作的实现
/// 页面基类
abstract class BaseWidget<T extends BaseController> extends GetView<T> {
  const BaseWidget({super.key});

  /// 状态控制器
  @override
  T get controller => GetInstance().find<T>(tag: logicTag());

  /// 页面的TAG 如果有需要 复写
  String? logicTag() {
    return null;
  }

  /// 子类实现:注入控制器
  void beforeBuild(BuildContext context) {}

  /// 是否显示加载页面
  bool showLoadingPage() {
    return true;
  }

  /// 是不是根页面  -  主要控制 背景 和 安全区域
  bool isRootPage() {
    return false;
  }

  @override
  Widget build(BuildContext context) {
    beforeBuild(context);
    var child = Scaffold(
      backgroundColor: backgroundColor(),
      appBar: buildAppBar(context),
      body: isRootPage()
          ? SafeArea(child: _buildChild(context))
          : _buildChild(context),
    );
    return child;
  }

  /// 加载子类的页面
  Widget _buildChild(BuildContext context) {
    // 显示加载页面
    if (showLoadingPage()) {
      return Obx(() => LoadingLayout(
          state: controller.loadingState.value,
          retry: controller.retry,
          contentBuilder: (context) {
            return buildChild(context);
          }));
    }

    return buildChild(context);
  }

  /// 标题相关 ========================================================
  /// 是否显示AppBar 默认显示
  bool showTitle() {
    return true;
  }

  /// 标题高度
  double? titleHeight() {
    return null;
  }

  /// 标题剧中
  bool titleCenter() {
    return true;
  }

  /// 是不是 主
  bool primary() {
    return true;
  }

  /// 标题背景色
  Color? titleBackgroundColor() {
    return null;
  }

  /// 是否显示返回按钮
  bool showBack() {
    return true;
  }

  /// 返回按钮的颜色
  Color? backColor() {
    return Colors.white;
  }

  /// 右边按钮或控件
  List<Widget>? titleActions() {
    return null;
  }

  /// 标题字体
  double titleTextSize() {
    return 18;
  }

  /// 标题字体颜色
  Color titleTextColor() {
    return Colors.white;
  }

  /// 标题字体样式
  FontWeight titleFontWeight() {
    return FontWeight.bold;
  }

  /// 标题
  String title() {
    return "";
  }

  /// 构建标题文本
  Widget? buildTitle() {
    return Text(
      title(),
      style: TextStyle(
        fontSize: titleTextSize(),
        color: titleTextColor(),
        fontWeight: titleFontWeight(),
      ),
    );
  }

  /// 构建标题
  AppBar? buildAppBar(BuildContext context) {
    if (!showTitle()) {
      return null;
    }
    return AppBar(
      toolbarHeight: titleHeight(),
      centerTitle: titleCenter(),
      elevation: 0,
      // 阴影高度:0
      backgroundColor: titleBackgroundColor(),
      leading: showBack()
          ? BackButton(
              color: backColor(),
            )
          : null,
      actions: titleActions(),
      title: buildTitle(),
    );
  }

  /// 标题相关 ========================================================

  /// 页面背景
  Color? backgroundColor() {
    return null;
  }

  /// 构建子View
  Widget buildChild(BuildContext context);
}
5.一般基类,不带状态的
/// 一般页面,不带状态的
abstract class NormalWidget extends BaseWidget<BaseController> {
  const NormalWidget({super.key});

  @override
  bool showLoadingPage() {
    return false;
  }
}
6.使用实例(无状态的案例)
/// 页面使用实例
class HomePage extends NormalWidget {
  const HomePage({super.key});

  @override
  String title() {
    return "我是首页";
  }

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

推荐阅读更多精彩内容