Flutter基础类库插件getx_base_classes的使用

Flutter基础类库插件getx_base_classes的使用

一个为GetX架构在Flutter中提供通用功能的基础类集合，包括控制器、视图、中间件等。

目录

• 安装
• 使用
  • BaseController
  • BaseView
  • BaseWidget
  • BaseMiddleware
  • BaseConnect
  • BaseRequest
  • BaseResponse
  • BaseModel
  • Responsive
• 示例
• 贡献
• 许可证

安装

要使用此包，请在pubspec.yaml文件中添加getx_base_classes作为依赖项：

dependencies:
  getx_base_classes: 

使用

BaseController

BaseController提供了处理异步操作和API调用的通用功能。扩展此类以创建不同屏幕或功能的自定义控制器。

// 使用BaseController的示例
class HomeController extends BaseController {
  // 您的控制器实现
}

BaseView

BaseView是一个抽象类，代表在GetX架构中的基本视图，并具有通用功能。扩展此类以创建不同屏幕或UI组件的自定义视图。

// 使用BaseView的示例
class HomeScreen extends BaseView<HomeController> {
  const HomeScreen({super.key});

  [@override](/user/override)
  Widget buildView() => Scaffold(
        appBar: AppBar(),
        body: Text('GetX 基础类库'),
      );
}

BaseWidget

BaseWidget是一个抽象类，代表在GetX架构中的基本小部件，并具有通用功能。扩展此类以创建不同UI组件的自定义小部件。

// 使用BaseWidget的示例
class MyWidget extends BaseWidget<MyController> {
  [@override](/user/override)
  Widget buildView(BuildContext context) {
    // 您的小部件实现
    return Container(
      child: Text('自定义小部件'),
    );
  }
}

BaseMiddleware

BaseMiddleware是一个基类，用于处理GetX中的导航和页面生命周期事件。

// 使用BaseMiddleware的示例
class MyMiddleware extends BaseMiddleware {
  // 您的中间件实现
}

BaseConnect

BaseConnect是一个继承自GetConnect的类，用于带有通用功能（如设置基本URL、头部信息和处理身份验证）的HTTP请求。

// 使用BaseConnect的示例
class MyApiService extends BaseConnect {
  // 您的API服务实现
}

BaseRequest

BaseRequest是一个简单的类，表示一个带有通用属性（如deviceId和tokenId）的请求。

// 使用BaseRequest的示例
BaseRequest request = BaseRequest(deviceId: '123', tokenId: '456');

BaseResponse

BaseResponse是一个泛型类，表示一个带有通用属性（如success、message和data）的响应。

// 使用BaseResponse的示例
BaseResponse<String> response = BaseResponse(success: true, message: '成功', data: '你好');

BaseModel

BaseModel是一个抽象类，定义了应用程序中模型类的契约，提供序列化和反序列化的逻辑方法。

// 使用BaseModel的示例
class MyModel extends BaseModel<MyModel> {
  [@override](/user/override)
  MyModel fromJson(Map<String, dynamic> json) {
    // 您的反序列化逻辑
    return MyModel();
  }

  [@override](/user/override)
  Map<String, dynamic> toJson() {
    // 您的序列化逻辑
    return {};
  }
}

Responsive

Responsive是一个根据屏幕大小和方向调整其子元素的窗口小部件，提供检查当前屏幕类型的实用方法。

// 使用Responsive的示例
Widget responsiveWidget = Responsive(
    mobile: const Text('手机'),
    mobileLandscape: const Text('手机横屏'),
    tablet: const Text('平板'),
    tabletLandscape: const Text('平板横屏'),
    desktop: const Text('桌面'),
);

示例

以下是一个完整的示例，展示了如何在项目中使用这些基础类库。

import 'package:example/helper/route.dart';
import 'package:flutter/material.dart';
import 'package:getx_base_classes/getx_base_classes.dart';

import 'init/app_env.dart';

void main() {
  AppEnviornment.init();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  // 这个小部件是您的应用的根
  [@override](/user/override)
  Widget build(BuildContext context) => GetMaterialApp(
        theme: ThemeData(
          colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
          useMaterial3: true,
        ),
        getPages: routes,
        initialRoute: homePageRoute,
      );
}