Flutter自定义创建组件插件flutter_custom_creator的使用

该插件提供了一个结构化的基础来创建自定义的Flutter应用程序。它包括配置、路由、主题、核心功能以及实用帮助器，以简化开发过程。

插件结构

lib/
├── config/
│   ├── app_helper/
│   │   ├── app_extension.dart
│   │   ├── app_formats.dart
│   │   ├── app_functions.dart
│   │   ├── app_gaps.dart
│   │   └── app_padding.dart
│   ├── router/
│   │   ├── app_router.dart
│   │   └── unknown_route.dart
│   └── theme/
│       ├── dark_theme.dart
│       ├── light_theme.dart
│       └── theme_manager.dart
├── core/
│   ├── network/
│   │   ├── api_provider.dart
│   │   └── app_endpoints.dart
│   └── utils/
│       ├── dialogs.dart
│       ├── logger.dart
│       ├── snack_bar_utils.dart
│       └── validator.dart
├── features/
├── app.dart
├── injection_container.dart
└── main.dart

功能

• Config: 包含辅助函数、路由配置和主题管理。
• Core: 包括与网络相关的实用工具和通用的实用工具函数。
• Features: 包含主应用文件、依赖注入设置以及应用的入口点。

开始使用

安装

1. 安装 flutter_custom_creator 工具（如果尚未安装）：

   dart pub global activate flutter_custom_creator
   

使用

要使用此插件创建一个新的Flutter项目：

1. 使用工具创建新项目：

   flutter_custom_creator example com.yourdomain
   

   将 example 替换为你的项目名称，将 com.yourdomain 替换为你的应用域名。

2. 这将会创建一个带有此包提供的自定义结构和文件的新Flutter项目。

3. 导航到项目目录并运行应用：

   cd example
   flutter run
   

自定义你的应用

在创建项目后：

1. 修改 lib/main.dart 来定制你的应用入口点。
2. 更新 lib/features/app.dart 来调整整个应用的结构。
3. 使用提供的配置、核心和功能目录来构建你应用的功能。

配置

• 修改 app_router.dart 来设置你的应用导航结构。
• 自定义 dark_theme.dart 和 light_theme.dart 来匹配你的应用设计。
• 使用 app_helper 文件来保持应用中一致的样式和功能。

网络

core/network 目录包含用于API通信的类：

• api_provider.dart: 处理API请求和响应。
• app_endpoints.dart: 定义应用中使用的API端点。

实用工具

core/utils 目录提供了常见的实用工具函数：

• dialogs.dart: 显示对话框的辅助方法。
• logger.dart: 用于调试的日志记录工具。
• snack_bar_utils.dart: 显示SnackBar消息的函数。
• validator.dart: 输入验证助手。

依赖注入

injection_container.dart 文件设置了应用的依赖注入。修改此文件以注册和管理你的应用依赖项。

贡献

欢迎贡献！请随时提交Pull Request。

以下是一个完整的示例Demo，展示了如何使用 flutter_custom_creator 创建一个简单的Flutter应用：

// lib/main.dart
import 'package:flutter/material.dart';
import 'package:your_project_name/injection_container.dart' as di;
import 'package:your_project_name/config/router/app_router.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await di.init(); // 初始化依赖注入
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp.router(
      routerDelegate: di.appRouter.routerDelegate,
      routeInformationParser: di.appRouter.routeInformationParser,
      title: 'Flutter Demo',
      theme: di.themeManager.getTheme(), // 使用主题管理器获取主题
    );
  }
}

// lib/injection_container.dart
import 'package:get_it/get_it.dart';
import 'package:your_project_name/config/router/app_router.dart';
import 'package:your_project_name/config/theme/theme_manager.dart';

GetIt di = GetIt.instance;

Future<void> init() async {
  di.registerLazySingleton<AppRouter>(() => AppRouter());
  di.registerLazySingleton<ThemeManager>(() => ThemeManager());
}

// lib/config/router/app_router.dart
import 'package:auto_route/auto_route.dart';

part 'router.gr.dart';

@MaterialAutoRouter(
  replaceInRouteName: 'Page,Route',
  routes: <AutoRoute>[
    AutoRoute(page: HomeRoute, path: '/'),
    AutoRoute(page: AboutRoute, path: '/about'),
    RedirectRoute(path: '*', redirectTo: '/'),
  ],
)
class $AppRouter {}

// lib/config/theme/theme_manager.dart
import 'package:flutter/material.dart';

class ThemeManager {
  final darkTheme = ThemeData.dark();
  final lightTheme = ThemeData.light();

  ThemeData getTheme() {
    // 可以根据用户偏好或系统设置返回不同的主题
    return lightTheme;
  }
}