Flutter通用功能插件bdaya_flutter_common的使用

发布于 1周前 作者 htzhanglong 来自 Flutter

Flutter通用功能插件bdaya_flutter_common的使用

我们制作了这个库,将我们在项目中常用的通用代码整合到一个单独的包中。

请注意,您可以自由使用它,但自行承担风险。

警告:此包可能有重大更改,且无迁移指南。

功能

View-Controller架构与辅助类
  • BdayaLoggableMixin:提供唯一的logger
  • BdayaLifeCycleMixin:通过以下方式为控制器提供生命周期管理:
    • beforeRender:相当于状态fulWidget的initState
    • afterRender:在单帧渲染后调用,适用于访问GlobalKey中的状态
    • onDispose:相当于状态fulWidget的dispose
  • BdayaIsLoadingMixin:公开反应式isLoading
  • BdayaStreamHandlerMixin:用于管理StreamListenable订阅
使用flutter_hooks的钩子
  • useViewController:注册lazySingleton控制器,并在其使用BdayaLifeCycleMixin时触发相关事件
使用go_router的路由助手
  • RouterListenableMixin:监听GoRouter的当前路由变化,并通知控制器
上述所有功能的组合控制器
  • BdayaCombinedController:适用于任何小部件,混合以下内容:
    1. BdayaLoggableMixin
    2. BdayaLifeCycleMixin
    3. BdayaIsLoadingMixin
    4. BdayaStreamHandlerMixin
  • BdayaCombinedRouteController:适用于可路由页面,混合以下内容:
    1. BdayaCombinedController
    2. RouterListenableMixin
本地化助手
  • ReactiveLocalizedFormField:操作FormControl<LocalizedStr>以支持多表单字段输入的本地化

使用方法

检查/example文件夹以获取我们使用的架构的完整示例。


示例代码

import 'package:flutter/material.dart';

import 'package:bdaya_flutter_common/bdaya_flutter_common.dart';

import 'get_it_config.dart';
import 'src/app.dart';

void main() {
  //[Optional] 更改默认日志记录器名称
  // bdayaDefaultLoggerName = (p0) {
  //   return p0.runtimeType.toString();
  // };

  Logger.root.level = Level.ALL;
  Logger.root.onRecord.listen(
    bdayaOnRecordHandlerFactory(
      showSequenceNumber: false,
      showTime: false,
    ),
  );
  setPathUrlStrategy();
  getIt.allowReassignment = true;
  configureDependencies();
  runApp(SharedValue.wrapApp(const ExampleApp()));
}

更多关于Flutter通用功能插件bdaya_flutter_common的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter通用功能插件bdaya_flutter_common的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然,下面是一个关于如何使用bdaya_flutter_common插件的示例代码。请注意,由于我无法直接访问实时的包信息或源码,以下示例将基于插件可能提供的一些通用功能进行假设。通常,Flutter插件会提供文档,你可以参考官方文档获取更详细和准确的信息。

首先,确保你已经在pubspec.yaml文件中添加了bdaya_flutter_common依赖:

dependencies:
  flutter:
    sdk: flutter
  bdaya_flutter_common: ^latest_version  # 替换为实际最新版本号

然后,运行flutter pub get来获取依赖。

示例代码

以下是一个简单的Flutter应用示例,展示了如何使用bdaya_flutter_common插件的一些假设功能,比如显示Toast消息、网络请求等。

import 'package:flutter/material.dart';
import 'package:bdaya_flutter_common/bdaya_flutter_common.dart'; // 导入插件

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('bdaya_flutter_common Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: () {
                // 显示Toast消息
                CommonUtils.showToast('Hello, this is a toast message!');
              },
              child: Text('Show Toast'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () async {
                // 发起网络请求(假设插件提供了网络请求功能)
                try {
                  var response = await CommonUtils.networkRequest(
                    url: 'https://api.example.com/data',
                    method: 'GET',
                  );
                  print('Network Response: ${response.body}');
                } catch (e) {
                  print('Network Error: $e');
                }
              },
              child: Text('Make Network Request'),
            ),
          ],
        ),
      ),
    );
  }
}

注意事项

  1. 插件功能:上面的代码假设bdaya_flutter_common插件提供了showToastnetworkRequest方法。实际使用时,你需要参考插件的官方文档来了解具体的方法和参数。

  2. 错误处理:网络请求部分包含了基本的错误处理。在实际应用中,你可能需要更详细的错误处理逻辑。

  3. 依赖版本:确保你使用的是最新版本的插件,以避免已知的错误和兼容性问题。

  4. 权限:如果插件功能需要特定的权限(如网络访问),请确保在AndroidManifest.xmlInfo.plist文件中正确声明了这些权限。

由于我无法直接访问bdaya_flutter_common插件的具体实现,上述代码仅为示例,实际使用时请参照插件的官方文档和示例代码。

回到顶部