Flutter基础模型管理插件xlf_base_model的使用

Flutter基础模型管理插件xlf_base_model的使用

信立方 flutter项目 base基础model

该插件提供了一些基础功能,用于简化Flutter项目的开发。以下是插件目前包含的基础功能:

  • 网络框架封装 dio + dioCache
  • 添加了针对dio网络请求的缓存框架,支持全局缓存、自定义接口缓存配置。
  • 局部刷新,通过Stream封装的StreamUtil。

一些常用工具类

  • dataUtil: 日期工具类。
  • encryptUtil: MD5加密等工具类。
  • logUtil: 日志打印。
  • moneyUtil: 价格处理显示。
  • numUtil: 数字处理,小数处理等。
  • regexUtil: 常用正则表达式。
  • toastUtil: 吐司工具。
  • streamUtil: 局部状态管理。

备注

此库所包含内容不关联任何业务相关内容,仅作为flutter app 基础架构所需的通用内容,原则避免重复写代码造轮子,引入可快速搭建新的项目。


完整示例Demo

示例代码

import 'package:flutter/material.dart';
import 'package:xlf_base_model/base_manager.dart';
import 'package:xlf_base_model/https/dio_cache_config.dart';
import 'package:xlf_base_model/https/dio_manager.dart';
import 'package:xlf_base_model/https/http.dart';

import 'model/main_model.dart';
import 'pages/base_page/base_stateful_page.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends BaseStatefulPage {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  BaseStatefulPageState<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends BaseStatefulPageState<MyHomePage>
    with MainModel {
  @override
  void initData() {
    // 初始化BaseManager,设置基础URL和header规则
    BaseManager.init(
        httpBaseUrl: "https://gateway.woyaoce.cn/app/",
        headerDelegate: (params) {
          // 自定义Header全局规则
          // DioManager.instance.header.addAll(params ?? {});
        });
  }

  @override
  void initHttpData() {
    // 初始化HTTP数据
  }

  @override
  Widget buildPage(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text("标题"),
      ),
      body: TextButton(
          onPressed: () {
            // 调用loadHome方法进行网络请求
            loadHome(
                error: (e) {
                  // 错误处理
                  setError(e);
                },
                success: (res) {
                  // 成功处理
                });
          },
          child: const Text("发起HTTP请求")),
    );
  }
}

示例说明

  1. 导入必要的包

    import 'package:flutter/material.dart';
    import 'package:xlf_base_model/base_manager.dart';
    import 'package:xlf_base_model/https/dio_cache_config.dart';
    import 'package:xlf_base_model/https/dio_manager.dart';
    import 'package:xlf_base_model/https/http.dart';
    
  2. 初始化应用

    void main() => runApp(const MyApp());
    
  3. 创建应用主体

    class MyApp extends StatelessWidget {
      const MyApp({Key? key}) : super(key: key);
    
      @override
      Widget build(BuildContext context) {
        return MaterialApp(
          title: 'Flutter Demo',
          theme: ThemeData(
            primarySwatch: Colors.blue,
          ),
          home: const MyHomePage(title: 'Flutter Demo Home Page'),
        );
      }
    }
    
  4. 创建主页

    class MyHomePage extends BaseStatefulPage {
      const MyHomePage({Key? key, required this.title}) : super(key: key);
    
      final String title;
    
      @override
      BaseStatefulPageState<MyHomePage> createState() => _MyHomePageState();
    }
    
  5. 实现主页逻辑

    class _MyHomePageState extends BaseStatefulPageState<MyHomePage>
        with MainModel {
      @override
      void initData() {
        BaseManager.init(
            httpBaseUrl: "https://gateway.woyaoce.cn/app/",
            headerDelegate: (params) {
              // 自定义Header全局规则
              // DioManager.instance.header.addAll(params ?? {});
            });
      }
    
      @override
      void initHttpData() {
        // 初始化HTTP数据
      }
    
      @override
      Widget buildPage(BuildContext context) {
        return Scaffold(
          appBar: AppBar(
            title: const Text("标题"),
          ),
          body: TextButton(
              onPressed: () {
                // 调用loadHome方法进行网络请求
                loadHome(
                    error: (e) {
                      // 错误处理
                      setError(e);
                    },
                    success: (res) {
                      // 成功处理
                    });
              },
              child: const Text("发起HTTP请求")),
        );
      }
    }
    

更多关于Flutter基础模型管理插件xlf_base_model的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter基础模型管理插件xlf_base_model的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然,以下是一个关于如何在Flutter项目中使用xlf_base_model插件的基础示例。请注意,xlf_base_model并非一个广泛认知的官方或主流Flutter插件,因此以下示例将基于一个假设的插件功能进行编写。在实际使用中,你需要根据xlf_base_model的具体文档和API进行调整。

假设xlf_base_model插件提供了一个基础模型管理类,用于管理应用中的数据模型。以下是一个简单的使用示例:

1. 添加依赖

首先,在你的pubspec.yaml文件中添加xlf_base_model依赖(注意:这里的依赖名和版本号是假设的,你需要根据实际情况替换):

dependencies:
  flutter:
    sdk: flutter
  xlf_base_model: ^1.0.0

然后运行flutter pub get来安装依赖。

2. 定义数据模型

使用xlf_base_model提供的基础模型类来定义你的数据模型。假设插件提供了一个BaseModel类:

import 'package:xlf_base_model/xlf_base_model.dart';

class UserModel extends BaseModel {
  String? name;
  int? age;

  UserModel({this.name, this.age});

  // 假设BaseModel提供了fromJson方法,用于从JSON数据反序列化模型
  UserModel.fromJson(Map<String, dynamic> json) {
    name = json['name'];
    age = json['age'];
  }

  // 假设BaseModel提供了toJson方法,用于将模型序列化为JSON数据
  Map<String, dynamic> toJson() {
    return {
      'name': name,
      'age': age,
    };
  }
}

3. 使用模型管理类

假设xlf_base_model提供了一个ModelManager类来管理数据模型的创建、更新和删除等操作:

import 'package:xlf_base_model/xlf_base_model.dart';
import 'user_model.dart';

void main() {
  // 初始化ModelManager(假设需要)
  ModelManager.instance.init();

  // 创建模型实例
  UserModel user = UserModel(name: 'Alice', age: 30);

  // 假设ModelManager提供了save方法来保存模型到某种存储(如本地数据库或远程服务器)
  ModelManager.instance.save(user);

  // 从存储中检索模型(假设返回Future<T>)
  ModelManager.instance.load<UserModel>(userId: '123').then((loadedUser) {
    print('Loaded User: ${loadedUser?.name}, Age: ${loadedUser?.age}');
  });

  // 更新模型
  user.name = 'Bob';
  ModelManager.instance.update(user);

  // 删除模型
  ModelManager.instance.delete(user);
}

4. 在Flutter Widget中使用模型

在你的Flutter应用中,你可以使用Provider或GetX等状态管理库来将模型数据提供给UI组件。这里以Provider为例:

import 'package:flutter/material.dart';
import 'package:provider/provider.dart';
import 'model_manager.dart'; // 假设这是包含ModelManager使用的文件
import 'user_model.dart';

void main() {
  runApp(
    MultiProvider(
      providers: [
        // 提供ModelManager实例(假设需要)
        Provider<ModelManager>(
          create: (_) => ModelManager.instance,
        ),
      ],
      child: MyApp(),
    ),
  );
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: UserScreen(),
    );
  }
}

class UserScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    final modelManager = Provider.of<ModelManager>(context);

    return Scaffold(
      appBar: AppBar(title: Text('User Info')),
      body: FutureBuilder<UserModel?>(
        future: modelManager.load<UserModel>(userId: '123'),
        builder: (context, snapshot) {
          if (snapshot.connectionState == ConnectionState.done) {
            UserModel? user = snapshot.data;
            return Center(
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: <Widget>[
                  Text('Name: ${user?.name ?? 'Unknown'}'),
                  Text('Age: ${user?.age ?? 0}'),
                ],
              ),
            );
          } else {
            return CircularProgressIndicator();
          }
        },
      ),
    );
  }
}

请注意,上述代码是基于假设的xlf_base_model插件功能编写的。在实际使用中,你需要根据插件的实际API和功能进行调整。如果xlf_base_model有具体的文档或示例代码,请参考那些资源以获取更准确的信息。

回到顶部