Flutter命令行工具插件flutter_cli_tool的使用

简介

flutter_cli_tool 是一个命令行工具，旨在帮助开发者快速生成基于 Bloc 和 GoRouter 的 Flutter 项目功能模块和模型。通过该工具，您可以轻松初始化项目结构，并生成具有 Bloc、页面、小部件和模型的功能模块。

特性

• 初始化项目结构，包含 core 和 config 目录。
• 快速生成新的功能模块（Feature），包括 Bloc、页面、小部件和模型。
• 根据 JSON 数据或文件生成 Dart 模型。
• 自动将路由添加到 routes.dart 文件中。
• 支持 PascalCase 和 snake_case 转换以适配功能名称。

安装

要安装 flutter_cli_tool，请运行以下命令：

dart pub global activate flutter_cli_tool

使用方法

1. 初始化项目

此命令会初始化项目结构，包含 core 和 config 目录，并创建一个 main.dart 文件。

flutter_cli_tool --init

示例效果：

初始化后，项目的目录结构如下：

lib/
|__ config/routes.dart
|__ core/
└── features/
    └── home/
        ├── bloc/
        ├── pages/
        ├── widgets/
        └── models/
main.dart

2. 创建功能模块

要生成一个新的功能模块，可以使用 --feature 或 -f 参数。功能名称会自动转换为 PascalCase 用于内部使用，snake_case 用于文件夹命名。

flutter_cli_tool --feature "hello world"

示例效果：

生成的功能模块结构如下：

lib/
└── features/
    └── hello_world/
        ├── bloc/
        ├── pages/
        ├── widgets/
        └── models/

3. 从 JSON 创建模型

可以通过提供 JSON 数据或 JSON 文件路径来生成模型。使用 --model 或 -m 参数指定模型名称，使用 --json 或 -j 参数指定 JSON 数据或文件路径。

示例 1: 从 JSON 数据生成 User 模型

flutter_cli_tool_tool --model User --json '{"id": 1, "name": "John Doe", "email": "john@example.com"}'

示例 2: 从 JSON 文件生成 Profile 模型并放置在特定功能模块中

flutter_cli_tool_tool --model Profile --json ./path/to/user.json --featureModel profile

4. 帮助文档

如需查看所有可用命令和选项，可运行以下命令：

flutter_cli_tool_tool --help

生成代码示例

main.dart 示例

import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:go_router/go_router.dart';
import 'routes.dart';

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MultiBlocProvider(
      providers: [
        BlocProvider<HomeBloc>(
          create: (context) => HomeBloc(),
        ),
        // 其他 Bloc 提供者将动态插入此处
      ],
      child: MaterialApp.router(
        title: 'Flutter Demo',
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
        routerDelegate: createRouter().routerDelegate,
        routeInformationParser: createRouter().routeInformationParser,
      ),
    );
  }
}

模型示例

class User {
  final int id;
  final String name;
  final String email;

  User({required this.id, required this.name, required this.email});

  User copyWith({int? id, String? name, String? email}) {
    return User(
      id: id ?? this.id,
      name: name ?? this.name,
      email: email ?? this.email,
    );
  }

  factory User.fromJson(Map<String, dynamic> json) {
    return User(
      id: json['id'],
      name: json['name'],
      email: json['email'],
    );
  }

  Map<String, dynamic> toJson() {
    return {
      'id': id,
      'name': name,
      'email': email,
    };
  }

  [@override](/user/override)
  String toString() {
    return 'User(id: $id, name: $name, email: $email)';
  }

  [@override](/user/override)
  bool operator ==(Object other) {
    if (identical(this, other)) return true;
    return other is User && other.id == id && other.name == name && other.email == email;
  }

  [@override](/user/override)
  int get hashCode => id.hashCode ^ name.hashCode ^ email.hashCode;
}