Flutter插件motocode_core的功能与使用

Flutter插件motocode_core的功能与使用

motocode_core 是一个用于所有与 motocode 相关的应用程序的共享服务库。该库提供了多种模型和服务，可以帮助开发者快速构建功能丰富的应用程序。

Flutter插件motocode_core的功能

1. Setup Locator
   用于配置依赖注入。
2. 列表中的模型
   包含多个可用的模型，如用户、部门等。
3. 列表中的服务
   提供了多种服务，例如身份验证、业务单位管理等。

Flutter插件motocode_core的开始使用

有两种方式来注入服务：

1. 在 main.dart 文件中调用 setupMotocodeLocator 方法。

void main() async {
  ....
  final baseUrl = 'URL_HERE';
  await setupMotocodeLocator(baseUrl);
  ...
}

1. 通过创建自定义定位器来注入服务。在 app.locator.custom.dart 文件中进行操作。

// 初始化Dio
final dio = Dio(
    BaseOptions(
      connectTimeout: Duration(seconds: 10),
      responseType: ResponseType.json,
    ),
  )..interceptors.add(
      LogInterceptor(
        requestBody: true,
        responseBody: true,
      ),
    );

var baseUrl = '<BASE_URL_HERE>/api';

/// 重要：首先注册[ApiClient]
_locator.registerLazySingleton(() => ApiClient(dio, baseUrl: baseUrl));

// 注册所有需要的服务
final apiClient = _locator<ApiClient>();
final crashlytics = FirebaseCrashlytics.instance;

_locator.registerLazySingleton(() => BusinessUnitsService(apiClient, crashlytics));
_locator.registerLazySingleton(() => DepartmentsService(apiClient, crashlytics));

// 添加其他服务
...

使用

可用模型和服务列表

可用模型

• Branch
• BusinessUnit
• Department
• DepotType
• Depot
• Position
• QrCode
• ScannedQrCode
• Status
• UserRole
• User

可用服务

• ApiClient

  • 用于发起网络请求的基础类。

• AuthenticationService

  • POST api/login
  • POST api/v2/login

• BusinessUnitsService

  • GET api/business-units
  • GET api/business-units/{id}
  • POST api/business-units
  • PUT api/business-units

• DepartmentsService

  • GET api/departments
  • GET api/departments/{id}
  • POST api/departments
  • PUT api/departments

• DepotTypesService

  • GET api/depot-types
  • GET api/depot-types/{id}
  • GET api/depot-types/{id}/depots
  • POST api/depot-types
  • PUT api/depot-types

• DepotsService

  • GET api/depots
  • GET api/depots/{id}
  • POST api/depots
  • PUT api/depots

• EnrollmentsService

  • GET api/enrollments

• PositionsService

  • GET api/positions
  • GET api/positions/{id}
  • POST api/positions
  • PUT api/positions

• QrCodesService

  • GET api/qr-codes
  • POST api/qr-codes
  • GET api/qr-codes/{id}
  • PUT api/qr-codes/{id}
  • GET api/qr-codes/{id}/scanned-qr-codes

• RolesService

  • GET api/roles
  • GET api/roles/{id}
  • POST api/roles
  • PUT api/roles

• ScannedQrCodesService

  • GET api/scanned-qr-codes
  • POST api/scanned-qr-codes
  • GET api/scanned-qr-codes/{id}

• StatusesService

  • GET api/statuses
  • POST api/statuses
  • GET api/statuses/{id}
  • PUT api/statuses/{id}
  • GET api/statuses/{id}/scanned-qr-codes
  • GET api/statuses/{id}/qr-codes

• UsersService

  • GET api/users - 获取所有用户
  • POST api/users - 创建用户
  • GET api/users/{id} - 获取特定用户
  • PUT api/users/{id} - 更新用户
  • GET api/users/{id}/scanned-qr-codes - 获取用户的所有扫描二维码记录
  • GET api/users/{id}/statuses - 获取用户的状态列表
  • GET api/users/{id}/depots - 获取用户的仓库列表
  • GET api/users/{id}/business-units - 获取用户的企业单元列表
  • GET api/users/{id}/departments - 获取用户所在部门列表
  • GET api/users/{id}/positions - 获取用户所在职位列表
  • GET api/users/{creatorId}/users - 获取由创建者创建的所有用户

示例代码

以下是一个简单的示例代码，展示了如何使用 motocode_core 插件。

import 'package:example/app/app.locator.custom.dart';
import 'package:flutter/material.dart';
import 'package:example/app/app.bottomsheets.dart';
import 'package:example/app/app.dialogs.dart';
import 'package:example/app/app.locator.dart';
import 'package:example/app/app.router.dart';
import 'package:stacked_services/stacked_services.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await setupLocator(); // 默认的依赖注入
  await setupCustomLocator(); // 自定义的依赖注入
  setupDialogUi(); // 设置对话框UI
  setupBottomSheetUi(); // 设置底部弹出菜单UI
  runApp(const MainApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      initialRoute: Routes.startupView,
      onGenerateRoute: StackedRouter().onGenerateRoute,
      navigatorKey: StackedService.navigatorKey,
      navigatorObservers: [
        StackedService.routeObserver,
      ],
    );
  }
}