Flutter自定义构建插件mhu_dart_builder的使用

Flutter自定义构建插件mhu_dart_builder的使用

MHU Dart Commons

在Dart和Flutter项目中常用的构建工具集合。

Links

Usage

mhu_dart_builder 是一个用于Flutter项目的自定义构建插件，可以帮助开发者实现一些自动化任务。以下是一个完整的示例，展示如何使用 mhu_dart_builder 插件来生成自定义代码。

步骤 1: 添加依赖

首先，在你的 pubspec.yaml 文件中添加 mhu_dart_builder 作为开发依赖：

dev_dependencies:
  mhu_dart_builder: ^1.0.0

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

flutter pub get

步骤 2: 创建构建器类

接下来，创建一个自定义的构建器类，继承自 Builder。在这个类中，你可以定义如何生成自定义代码。

import 'package:mhu_dart_builder/mhu_dart_builder.dart';

// 定义一个自定义构建器
class MyCustomBuilder extends Builder {
  @override
  Future<void> build(BuildStep buildStep) async {
    // 获取输入文件
    final inputId = buildStep.inputId;
    final contents = await buildStep.readAsString(inputId);

    // 生成自定义代码
    final output = '''
class GeneratedClass {
  String message = "$contents";
}
''';

    // 输出到文件
    final outputPath = InputId(
      package: inputId.package,
      path: '${inputId.path}.g.dart',
    );
    await buildStep.writeAsString(outputPath, output);
  }

  @override
  Map<String, List<String>> get buildExtensions => {
        '.txt': ['.g.dart'], // 输入为.txt文件，输出为.g.dart文件
      };
}

步骤 3: 注册构建器

在 build.yaml 文件中注册自定义构建器。如果没有 build.yaml 文件，可以手动创建一个。

builders:
  my_custom_builder:
    import: "lib/my_custom_builder.dart"
    builder_factories: ["MyCustomBuilder.create"]
    build_extensions: {".txt": [".g.dart"]}
    auto_apply: dependents
    build_to: source

步骤 4: 使用构建器

创建一个 .txt 文件（例如 example.txt），并在其中写入一些文本内容。

example.txt

Hello, MHU Dart Commons!

运行以下命令触发构建：

flutter packages pub run build_runner build

构建完成后，会在同一目录下生成一个 .g.dart 文件，内容如下：

class GeneratedClass {
  String message = "Hello, MHU Dart Commons!";
}

更多关于Flutter自定义构建插件mhu_dart_builder的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter自定义构建插件mhu_dart_builder的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


mhu_dart_builder 是一个自定义的 Dart 代码生成工具，通常用于在 Flutter 项目中自动生成代码。它基于 build_runner 和 source_gen 库，允许你通过自定义的注解和生成器来生成 Dart 代码。

以下是使用 mhu_dart_builder 的步骤：

1. 添加依赖

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

dependencies:
  mhu_dart_builder: ^1.0.0  # 请根据实际版本号进行替换

dev_dependencies:
  build_runner: ^2.1.0

2. 创建自定义注解

你可以创建自定义的注解类，这些注解将用于标记需要生成代码的类或方法。

// lib/annotations.dart
class MyCustomAnnotation {
  const MyCustomAnnotation();
}

const myCustomAnnotation = MyCustomAnnotation();

3. 创建代码生成器

接下来，你需要创建一个代码生成器。这个生成器将读取被注解的类或方法，并生成相应的代码。

// lib/builders/my_custom_builder.dart
import 'package:build/build.dart';
import 'package:source_gen/source_gen.dart';
import 'package:mhu_dart_builder/mhu_dart_builder.dart';

class MyCustomBuilder extends GeneratorForAnnotation<MyCustomAnnotation> {
  @override
  Future<String> generateForAnnotatedElement(
      Element element, ConstantReader annotation, BuildStep buildStep) async {
    // 在这里编写生成代码的逻辑
    return '''
// 自动生成的代码
class GeneratedClass {
  void generatedMethod() {
    print('Hello, World!');
  }
}
''';
  }
}

4. 注册生成器

在 build.yaml 文件中注册你的生成器：

# build.yaml
builders:
  my_custom_builder:
    import: "package:my_project/builders/my_custom_builder.dart"
    builder_factories: ["myCustomBuilder"]
    build_extensions: {".dart": [".g.dart"]}
    auto_apply: dependents
    build_to: source

5. 使用注解

在你的 Dart 代码中使用自定义注解：

// lib/main.dart
import 'package:my_project/annotations.dart';

@myCustomAnnotation
class MyClass {
  // 这个类将被代码生成器处理
}

6. 运行代码生成

使用 build_runner 来运行代码生成：

flutter pub run build_runner build

这将生成一个 .g.dart 文件，其中包含生成的代码。

7. 使用生成的代码

你可以在你的项目中使用生成的代码：

// lib/main.dart
import 'package:my_project/main.g.dart';

void main() {
  var generatedClass = GeneratedClass();
  generatedClass.generatedMethod();  // 输出: Hello, World!
}

8. 自动重新生成代码

在开发过程中，你可以使用 watch 命令来自动重新生成代码：

flutter pub run build_runner watch
回到顶部