Flutter代码清理与生成插件clean_dart_generate的使用

发布于 1周前 作者 phonegap100 来自 Flutter

Flutter代码清理与生成插件clean_dart_generate的使用

Clean Dart Generate 是一个命令行工具，旨在帮助开发者遵循 Flutterando 的 Clean Dart 架构原则快速生成代码。此工具可以自动化创建必要的文件夹结构和文件，使得在 Dart/Flutter 项目中实现和维护清洁架构变得更加容易。

使用步骤

1. 安装依赖

首先，确保你已经安装了 Dart SDK 和 Flutter SDK。接下来，通过以下命令安装 clean_dart_generate 插件：

dart pub global activate clean_dart_generate

2. 初始化项目

在你的 Flutter 项目目录中运行初始化命令，这会自动创建所需的文件夹结构和基本文件：

cd your_flutter_project
clean_dart_generate init

这将生成以下文件和文件夹结构：

your_flutter_project/
├── lib/
│   ├── core/
│   │   ├── constants/
│   │   ├── errors/
│   │   └── utils/
│   ├── data/
│   │   ├── models/
│   │   ├── repositories/
│   │   └── sources/
│   ├── domain/
│   │   ├── entities/
│   │   ├── repositories/
│   │   └── usecases/
│   └── presentation/
│       ├── screens/
│       ├── viewmodels/
│       └── widgets/
├── test/
│   ├── integration/
│   ├── unit/
│   └── widget/
└── pubspec.yaml

3. 生成具体模块

你可以使用 clean_dart_generate 命令来生成具体的模块，例如：

生成一个新的 UseCase 模块

clean_dart_generate make:usecase --name=FetchUserDataUseCase

这将在 lib/domain/usecases/ 文件夹下生成 fetch_user_data_use_case.dart 文件，内容如下：

// lib/domain/usecases/fetch_user_data_use_case.dart
import 'package:your_flutter_project/core/utils/failure.dart';
import 'package:dartz/dartz.dart';

abstract class FetchUserDataUseCase {
  Future<Either<Failure, String>> call();
}

生成一个新的 Repository 模块

clean_dart_generate make:repository --name=UserDataRepository

这将在 lib/data/repositories/ 文件夹下生成 user_data_repository.dart 文件，内容如下：

// lib/data/repositories/user_data_repository.dart
import 'package:your_flutter_project/data/sources/user_data_source.dart';
import 'package:your_flutter_project/domain/repositories/user_data_repository.dart';

class UserDataRepositoryImpl implements UserDataRepository {
  final UserDataDataSource _userDataDataSource;

  UserDataRepositoryImpl(this._userDataDataSource);

  @override
  Future<String> getUserData() async {
    return await _userDataDataSource.getUserData();
  }
}

4. 配置和自定义

你可以根据项目需求进行进一步配置和自定义。例如，修改生成的文件模板或添加额外的生成规则。

5. 清理和重构

当你需要清理或重构项目时，可以使用 clean_dart_generate 提供的清理功能，例如删除未使用的文件或文件夹：

clean_dart_generate clean

更多关于Flutter代码清理与生成插件clean_dart_generate的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter代码清理与生成插件clean_dart_generate的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是如何在Flutter项目中集成和使用clean_dart_generate插件来进行代码清理和生成的示例。clean_dart_generate是一个有助于自动化清理和生成Dart代码的工具，通过配置一些规则，它可以自动处理一些重复性的任务。

1. 安装插件

首先，在你的Flutter项目的根目录下，打开终端并运行以下命令来添加clean_dart_generate到你的pubspec.yaml文件中：

flutter pub add clean_dart_generate

这将自动在pubspec.yaml文件中添加依赖项，并下载必要的包。

2. 配置插件

接下来，你需要在pubspec.yaml文件中配置clean_dart_generate。在dev_dependencies部分，确保clean_dart_generate已经被列出，然后添加一个build_runner的依赖，因为clean_dart_generate通常与build_runner一起使用：

dev_dependencies:
  build_runner: ^x.y.z  # 替换为最新版本
  clean_dart_generate: ^x.y.z  # 替换为最新版本

3. 创建生成脚本

在项目的根目录下创建一个名为build.yaml的文件，这个文件用于配置clean_dart_generate的行为。以下是一个简单的示例配置：

targets:
  $default:
    builders:
      clean_dart_generate:clean_dart_generate:
        enabled: true
        options:
          # 在这里添加你的清理和生成规则
          # 例如，你可以指定哪些文件或目录需要被清理或生成
          rules:
            - glob: "**/*.g.dart"  # 清理所有生成的.g.dart文件
            - glob: "lib/generated/**"  # 生成到lib/generated目录

4. 创建清理和生成逻辑

通常，clean_dart_generate会与其他代码生成工具（如json_serializable）结合使用。在你的Flutter项目中，你可能已经有了一些代码生成逻辑。例如，你可能有一个用于生成JSON序列化和反序列化代码的文件：

// data/user.dart
import 'package:json_annotation/json_annotation.dart';

part 'user.g.dart';

@JsonSerializable()
class User {
  final String name;
  final int age;

  User({required this.name, required this.age});

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);

  Map<String, dynamic> toJson() => _$UserToJson(this);
}

5. 运行生成命令

现在，你可以使用flutter pub run build_runner命令来运行代码生成逻辑：

flutter pub run build_runner build --delete-conflicting-outputs

这个命令会根据build.yaml中的配置和代码中的注解来生成或清理代码。如果配置了clean_dart_generate，它会自动处理与clean_dart_generate相关的清理和生成任务。

总结

以上是如何在Flutter项目中集成和使用clean_dart_generate插件的基本步骤。通过配置build.yaml文件和运行flutter pub run build_runner命令，你可以自动化地清理和生成Dart代码，从而提高开发效率。

请注意，clean_dart_generate的具体使用方式和配置选项可能会根据插件的版本和更新而有所变化，因此建议查阅最新的官方文档以获取最准确的信息。

回到顶部