Flutter架构生成插件clean_arch_generator的使用

本文档介绍了如何使用 clean_arch_generator 插件来生成 Clean Architecture 的文件夹结构。如果你将此包发布到 pub.dev，此文档的内容将出现在你的包的首页。

对于如何编写一个好的包文档，请参阅 撰写包页面指南。

对于开发包的一般信息，请参阅 Dart 的 创建库包指南 和 Flutter 的 开发包和插件指南。

介绍

clean_arch_generator 是一个用于生成 Clean Architecture 文件夹结构的 Dart 项目。通过使用该插件，你可以快速地创建符合 Clean Architecture 规范的项目结构。

安装

在你的 pubspec.yaml 文件中添加以下依赖项：

dev_dependencies:
  clean_arch_generator: ^1.0.0

然后运行 flutter pub get 命令以安装插件。

使用

1. 初始化项目

首先，你需要创建一个新的 Flutter 项目或打开一个现有的项目。

flutter create clean_arch_example
cd clean_arch_example

2. 配置插件

在你的项目根目录下，创建一个名为 build.yaml 的文件，并添加以下内容：

targets:
  $default:
    builders:
      clean_arch_generator:
        options:
          output_directory: lib/src

3. 生成文件夹结构

在你的项目根目录下，运行以下命令以生成 Clean Architecture 的文件夹结构：

flutter packages pub run build_runner build

4. 查看生成的文件夹结构

执行上述命令后，你将在 lib/src 目录下看到以下文件夹结构：

lib/src
├── core
│   ├── exceptions.dart
│   └── failures.dart
├── data
│   ├── datasource
│   │   └── remote_data_source.dart
│   ├── models
│   │   └── movie_model.dart
│   └── repositories
│       └── movie_repository_impl.dart
├── domain
│   ├── entities
│   │   └── movie_entity.dart
│   ├── repositories
│   │   └── movie_repository.dart
│   └── usecases
│       └── get_movies_usecase.dart
└── presentation
    ├── controllers
    │   └── movie_controller.dart
    └── widgets
        └── movie_list_widget.dart

每个文件夹都包含了一些基本的类和接口，你可以根据实际需求进行修改和扩展。

5. 示例代码

lib/src/core/exceptions.dart

class ApiException implements Exception {
  final String message;

  ApiException(this.message);
}

lib/src/data/datasource/remote_data_source.dart

import 'package:http/http.dart' as http;
import 'dart:convert';

class RemoteDataSource {
  final http.Client client;

  RemoteDataSource({required this.client});

  Future<List<dynamic>> fetchMovies() async {
    final response = await client.get(Uri.parse('https://api.example.com/movies'));
    if (response.statusCode == 200) {
      return json.decode(response.body);
    } else {
      throw ApiException('Failed to load movies');
    }
  }
}

lib/src/domain/entities/movie_entity.dart

class MovieEntity {
  final int id;
  final String title;
  final String overview;

  MovieEntity({required this.id, required this.title, required this.overview});
}

lib/src/presentation/controllers/movie_controller.dart

import 'package:flutter/material.dart';
import 'package:get/get.dart';
import '../usecases/get_movies_usecase.dart';

class MovieController extends GetxController {
  final GetMoviesUseCase _getMoviesUseCase;

  MovieController(this._getMoviesUseCase);

  var movies = [].obs;

  void fetchMovies() async {
    try {
      movies.value = await _getMoviesUseCase.execute();
    } catch (e) {
      print(e);
    }
  }
}