Flutter插件ft_cli的介绍与安装使用

Flutter插件ft_cli的介绍与安装使用

概述

为了更方便地实现“Bob叔叔的干净架构”，该插件提供了一个基础结构，可以动态生成类。此外，你还可以通过编辑模板文件和触发器来轻松动态地修改代码，并创建新文件。

安装插件ft_cli

首先，你需要安装ft_cli插件。可以通过以下命令全局激活：

dart pub global activate ft_cli

或者，如果你有一个本地副本，可以通过以下命令激活：

dart pub global activate --source path ./RepositoryProject

命令

初始化项目

运行以下命令来初始化你的项目，生成基本结构：

ft_cli init

这将生成一个.ft_cli文件夹，其中包含配置变量。

生成微前端组件

ft_cli mf

选择你要创建的组件，并输入组件名称（使用蛇形命名法）。

生成层

ft_cli g layer lib/app/module/home
# 或者
ft_cli g l lib/app/module/home

生成页面

ft_cli g page lib/app/module/home HomeCards
# 或者
ft_cli g p lib/app/module/home HomeCards

生成的页面类如下：

// presentation/ui/pages/home_cards/home_cards_page.dart
import 'package:flutter/material.dart';
import 'home_cards_controller.dart';

class HomeCardsPage extends StatefulWidget {

  @override
  _HomeCardsPageState createState() => _HomeCardsPageState();
}

class _HomeCardsPageState extends State<HomeCardsPage> {
  final GlobalKey<ScaffoldState> scaffoldKey = GlobalKey<ScaffoldState>();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      key: scaffoldKey,
      appBar: const AppBar(),
      body: const Container(),
    );
  }
}

生成控制器

ft_cli g controller lib/app/module/home HomeCards
# 或者
ft_cli g c lib/app/module/home HomeCards

生成的控制器类如下：

// presentation/ui/pages/home_cards/home_cards_controller.dart
class HomeCardsController {
  bool loading = false;

  void setLoading(bool value) {
    loading = value;
  }
}

生成数据源

ft_cli g datasource lib/app/module/home GetHomeCards
# 或者
ft_cli g d lib/app/module/home GetHomeCards

生成的数据源类如下：

// data/datasources/get_home_cards_datasource.dart
abstract class GetHomeCardsDatasource {
  Future<void> call();
}

// external/datasources/get_home_cards_imp_datasource.dart
import '../../data/datasources/get_home_cards_datasource.dart';

class GetHomeCardsImpDatasource implements GetHomeCardsDatasource {
  @override
  Future<void> call() {
    // TODO: implement call
    throw UnimplementedError();
  }
}

生成仓库

ft_cli g repository lib/app/module/home GetHomeCards
# 或者
ft_cli g repository lib/app/module/home GetHomeCards

生成的仓库类如下：

// domain/repositories/get_home_cards_repository.dart
abstract class GetHomeCardsRepository {
  Future<void> call();
}

// data/repositories/get_home_cards_imp_repository.dart
import '../../repositories/get_home_cards_repository.dart';

class GetHomeCardsImpRepository implements GetHomeCardsRepository {
  @override
  Future<void> call() {
    // TODO: implement call
    throw UnimplementedError();
  }
}

生成用例

ft_cli g usecase lib/app/module/home GetHomeCards
# 或者
ft_cli g u lib/app/module/home GetHomeCards

生成的用例类如下：

// domain/usecases/get_home_cards_usecase.dart
abstract class GetHomeCardsUsecase {
  Future<void> call();
}

// domain/usecases/get_home_cards_imp_usecase.dart
import 'get_home_cards_usecase.dart';

class GetHomeCardsImpUsecase implements GetHomeCardsUsecase {
  @override
  Future<void> call() {
    // TODO: implement call
    throw UnimplementedError();
  }
}

生成服务

ft_cli g service lib/app/module/home HomeCards
# 或者
ft_cli g s lib/app/module/home HomeCards

生成的服务类如下：

// domain/services/home_cards_service.dart
abstract class HomeCardsService {
  Future<void> call();
}

// domain/services/home_cards_imp_service.dart
import 'home_cards_service.dart';

class HomeCardsImpService implements HomeCardsService {
  @override
  Future<void> call() {
    // TODO: implement call
    throw UnimplementedError();
  }
}

生成实体

ft_cli g entity lib/app/module/home Home
# 或者
ft_cli g e lib/app/module/home Home

生成的实体类如下：

// domain/models/entities/home_entity.dart 
class HomeEntity {
  HomeEntity();
}

生成 DTO

ft_cli g dto lib/app/module/home Home

生成的 DTO 类如下：

// domain/models/dtos/home_dto.dart
import '../../models/entities/home_entity.dart';

class HomeDto extends HomeEntity {
  HomeDto() : super();
}

帮助信息

-------------------------- HELPS --------------------------

i, init             生成项目的可配置文件...
示例: ft_cli init

mf, microfrontend  选择创建新的微前端组件...
示例: ft_cli mf

l, layer            生成模块的文件夹结构...
示例: ft_cli g l lib/app/modules/nome_modulo

p, page             创建带控制器的新页面...
示例: ft_cli g p lib/app/modules/nome_modulo Nome

c, controller       创建新的控制器...
示例: ft_cli g c lib/app/modules/nome_modulo Nome

d, datasource       创建外部数据源的查找层...
示例: ft_cli g d lib/app/modules/nome_modulo Nome

r, repository       创建处理数据的层...
示例: ft_cli g r lib/app/modules/nome_modulo Nome

u, usecase          创建处理业务规则的层...
示例: ft_cli g u lib/app/modules/nome_modulo Nome

s, service          创建处理服务的层...
示例: ft_cli g s lib/app/modules/nome_modulo Nome

e, entity           创建实体...
示例: ft_cli g e lib/app/modules/nome_modulo Nome

dto                 创建用于数据传输的 DTO...
示例: ft_cli g dto lib/app/modules/nome_modulo Nome

预留词

预留词可以在生成的模板文件中使用，这些文件位于.ft_cli/templete目录下。预留词必须在花括号内使用，例如{{name}}。预留词也可以使用扩展名，例如{{name.pascalCase}}，它会根据需要格式化单词。你可以查看下面的列表以获取所有预留词及其扩展名。

方法

方法可以在触发器或模板中使用，并按顺序工作。例如{{path.replace(str1,str2).replace(str3, str4)}}。

扩展名

触发器

在.ft_cli/templete目录下，生成了{{term}}_replace_trigger.json文件，可以从注释中应用替换到任何输入表达式。例如：

[
    {
        "pathFile": "{{path}}\\{{module}}_module.dart",
        "from": "//imports",
        "to": "//imports\nimport '{{controllerPath}}/{{controllerNameFile}}.dart';"
    },
    {
        "pathFile": "{{path}}\\{{module}}_module.dart",
        "from": "//Dependence",
        "to": "//Dependence\nfinal {{controllerNameClass.camelCase}} = {{controllerNameClass.pascalCase}};"
    }
]

模板

.ft_cli/template/layer/complete_new_file_exemple.template文件内容如下：

class {{module.pascalCase}}Module extends Module {
  @override
  final List<Bind> binds = [
    //Usecases

    //Repositories

    //Datasources
      
    //Controllers
  ];

  @override
  final List<ModularRoute> routes = [
    //Pages
  ];
}

测试

要添加测试，只需创建一个模板，例如：

import 'package:flutter_test/flutter_test.dart';

import 'package:{{path.replace(\,/).replace(lib/,)}}/{{name.snakeCase}}';

void main() {
  test('adds one to input values', () {
    final calculator = Calculator();
    expect(calculator.addOne(2), 3);
    expect(calculator.addOne(-7), -6);
    expect(calculator.addOne(0), 1);
  });
}

然后在类创建的触发器中添加模板路径，进行替换，将测试文件转发到测试文件夹中，例如：

[
    {
        "pathFile": "{{path.replace(lib/app,test)}}/{{name.snakeCase}}_test",
        "pathTemplete": ".ft_cli/template/example_test.template",
        "extension": "dart",
        "replaceOldFileWithNew": false,
        "generate": true
    }
]