Flutter 的build.yaml文件介绍：深入理解其参数及其用途

2023-11-23 08:49:20

在 Flutter 开发中，build.yaml 文件扮演着核心角色，它允许开发者自定义构建过程的诸多方面。本文旨在详细解析 build.yaml 文件中的参数及其用途，并提供具体的操作示例。

什么是 `build.yaml`

build.yaml 是一个配置文件，在 Flutter 模块化构建系统中使用。通过这个文件，开发团队能够定制构建流程，添加或修改构建步骤，如编译、打包和优化等，以满足项目的特定需求。

常用参数及作用

targets

targets 是一个配置项，它定义了可以执行的构建目标（tasks）。每个目标代表一组构建操作。例如：

targets:
  $default:
    dependencies: ["$buildConfig"]
  my_custom_target:
    builder: build_web_compilers|web_builder
    inputs:
      - some_input_file.txt
    outputs:
      - output.html

builders

builders 用于注册自定义构建器（builder），这些构建器可以处理特定类型的文件或任务。例如：

builders:
  my_custom_builder:
    imports: ["package:some_package"]
    build_extensions: {".dart": [".custom_extension"]}
    builder_factories: ["new MyCustomBuilder"]
    auto_apply: depend

dependency_graph

dependency_graph 参数控制了构建过程中依赖关系的处理方式。这对于优化构建速度和确保正确的编译顺序至关重要。
clean

清理构建缓存或输出目录的操作可以通过配置 clean 来实现，如下所示：
```
clean:
  targets: ["$default"]
```

应用场景及示例

假设有一个需求，需要为特定环境生成一个包含额外调试信息的版本。可以创建一个新的构建目标，并通过参数控制是否添加这些信息。

targets:
  $default:
    dependencies: ["$buildConfig"]
  debug_build:
    builder: custom_debug_builder|debug_info_injector
    inputs:
      - "app.dart"
    outputs:
      - "output_with_debug_info.app"

builders:
  custom_debug_builder:
    imports: []
    build_extensions: {".dart": [".with_debug"]}
    builder_factories: ["new DebugInfoInjectorBuilder"]