Flutter架构生成插件clean_arch_usecase_generator的使用

Flutter架构生成插件clean_arch_usecase_generator的使用

clean_arch_usecase_generator

一个用于在Dart/Flutter项目中生成遵循干净架构原则的用例的Flutter插件。

特性

  • 简化了遵循干净架构原则的用例创建过程。

开始使用

要开始使用此插件，你需要将其依赖项添加到你的pubspec.yaml文件中：

dependencies:
  clean_arch_usecase_generator: ^0.0.1

完整示例Demo

以下是一个完整的示例，展示了如何使用clean_arch_usecase_generator来生成用例。

  1. 安装依赖

    首先，在pubspec.yaml文件中添加clean_arch_usecase_generator依赖：

    dependencies:
  clean_arch_usecase_generator: ^0.0.1

  2. 创建用例类

    创建一个新的文件，例如src/usecases/get_user.dart。在这个文件中定义一个用例类：

    import 'package:clean_arch_usecase_generator/clean_arch_usecase_generator.dart';

// 定义输入参数
class GetUserParams {
  final String userId;

  GetUserParams(this.userId);
}

// 定义用例接口
abstract class IGetUser {
  Future<User> call(GetUserParams params);
}

// 生成用例实现
[@GenerateUsecase](/user/GenerateUsecase)()
class GetUser implements IGetUser {
  // 实现具体逻辑
  @override
  Future<User> call(GetUserParams params) async {
    // 假设这里是调用API获取用户信息的逻辑
    return User(userId: params.userId, name: "John Doe");
  }
}

  3. 定义实体类

    创建一个新的文件，例如src/models/user.dart。在这个文件中定义实体类：

    class User {
  final String userId;
  final String name;

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

  4. 运行生成器

    在命令行中运行flutter packages pub run build_runner build来生成用例的实现代码。

  5. 使用生成的用例

    现在你可以在其他地方使用生成的用例。例如，在一个Repository中使用它：

    import 'package:your_project/src/models/user.dart';
import 'package:your_project/src/usecases/get_user.dart';

class UserRepository {
  final IGetUser _getUser;

  UserRepository(this._getUser);

  Future<User> getUser(String userId) async {
    final params = GetUserParams(userId);
    return await _getUser(params);
  }
}

更多关于Flutter架构生成插件clean_arch_usecase_generator的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter架构生成插件clean_arch_usecase_generator的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


clean_arch_usecase_generator 是一个用于生成 Clean Architecture 架构相关代码的 Flutter 插件。它可以帮助开发者快速生成 UseCase、Repository、Entity 等相关的代码，从而减少手动编写重复代码的工作量。

安装插件

首先，你需要在 pubspec.yaml 文件中添加 clean_arch_usecase_generator 插件作为开发依赖：

dev_dependencies:
  clean_arch_usecase_generator: ^版本号
  build_runner: ^2.1.0

然后运行以下命令来安装依赖：

flutter pub get

使用插件

  1. 创建 UseCase 文件
    在 lib 目录下创建一个新的 Dart 文件，例如 get_user_usecase.dart，然后使用 [@UseCase](/user/UseCase) 注解来标记 UseCase 类。

    import 'package:clean_arch_usecase_generator/clean_arch_usecase_generator.dart';

[@UseCase](/user/UseCase)()
class GetUserUseCase {
  // 这里可以定义 UseCase 的逻辑
}

  2. 生成代码
    运行以下命令来生成 UseCase 相关的代码：

    flutter pub run build_runner build

    这将会生成 GetUserUseCase 类所需的 Repository、Entity 等相关的代码。

  3. 生成的代码结构
    生成的代码通常会放在 lib/generated 目录下，包含以下文件：

    • get_user_usecase.g.dart: 包含 UseCase 的实现代码。
    • get_user_repository.dart: 包含 Repository 接口。
    • get_user_entity.dart: 包含 Entity 类。

  4. 使用生成的代码
    你可以在你的应用中使用生成的 UseCase、Repository 和 Entity。例如：

    import 'package:your_app/generated/get_user_usecase.g.dart';

void main() {
  final getUserUseCase = GetUserUseCase();
  // 使用 UseCase 获取用户数据
  final user = getUserUseCase.execute();
  print(user);
}

自定义生成代码

你可以通过配置 [@UseCase](/user/UseCase) 注解的参数来自定义生成的代码。例如：

[@UseCase](/user/UseCase)(
  repositoryName: 'CustomUserRepository',
  entityName: 'CustomUserEntity',
)
class GetUserUseCase {
  // UseCase 逻辑
}
回到顶部