如何在运行时将build_runner作为普通依赖实现Dart代码生成

首先明确：不要把build_runner作为普通运行时依赖使用。它从设计定位上就是构建阶段的专用工具，所有逻辑都围绕「开发期静态扫描项目目录、输出构建产物到磁盘」设计，没有对运行时环境做适配，硬引入会带来大量冗余依赖、增大应用体积，且在打包后的应用环境中大概率因为拿不到完整项目源码路径、缺少构建配置文件直接崩溃。

为什么不推荐运行时直接调用build_runner #

• build_runner默认依赖项目根目录的pubspec.yaml、pubspec.lock、build.yaml配置，运行时（尤其是移动端、桌面端打包后的发行版）不存在完整的项目源码结构，路径解析逻辑会直接失效。
• 从dev_dependencies挪到普通dependencies会引入它整套构建链路依赖，包括文件监听、增量构建缓存、任务调度等仅构建期有用的模块，空项目引入后应用体积至少增加10M，性价比极低。
• 官方从未承诺build_runner的运行时调用API稳定性，版本迭代时内部逻辑随时可能变动，没有官方使用文档是正常的，因为本身就不支持这么用。

推荐方案：直接调用底层analyzer实现运行时解析与生成 #

你提到的build_runner核心解析能力本身就来自官方的analyzer包，这个包是明确支持作为普通依赖在运行时调用的，比硬套build_runner更轻量、稳定，实现步骤如下：

1. 添加依赖 #

在pubspec.yaml的普通依赖块中引入所需包，不需要引入build_runner：

dependencies:
  analyzer: ^6.4.0 # 选择和你当前Dart/Flutter版本匹配的版本即可
  path: ^1.9.0 # 用于跨平台文件路径处理

2. 运行时解析Dart文件核心实现 #

analyzer的解析逻辑和build_runner底层用的完全一致，可以拿到完整的AST语法树、语义信息、类/方法/注解/字段等所有结构：

import 'package:analyzer/dart/analysis/analysis_context_collection.dart';
import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/dart/ast/ast.dart';
import 'package:path/path.dart' as p;

/// 扫描指定目录下的所有Dart文件做语法语义解析
/// [targetDirPath] 为存放Dart源码/ Dart包的绝对路径
Future<void> scanAndParseDart(String targetDirPath) async {
  // 初始化分析上下文，等价于build_runner启动时的源码加载步骤
  final contextCollection = AnalysisContextCollection(
    includedPaths: [p.normalize(targetDirPath)],
  );

  // 遍历所有上下文下的Dart文件
  for (final analysisCtx in contextCollection.contexts) {
    for (final filePath in analysisCtx.contextRoot.analyzedFiles()) {
      if (!filePath.endsWith('.dart')) continue;
      // 获取文件的完整解析结果，包含语法、类型、引用等所有语义信息
      final parseResult = await analysisCtx.currentSession.getResolvedUnit(filePath);
      if (parseResult is! ResolvedUnitResult) continue;

      // 以下为自定义解析逻辑示例：遍历文件中所有类定义
      for (final classDecl in parseResult.unit.declarations.whereType<ClassDeclaration>()) {
        final className = classDecl.name.lexeme;
        print('解析到类：$className');
        // 可按需读取类的注解、字段、方法、继承关系等信息
      }
    }
  }
}

3. 代码生成实现 #

解析拿到所需的结构信息后，直接通过字符串模板拼接生成Dart代码即可，不需要依赖build_runner的生成模块：

/// 示例：根据解析到的类名生成对应的辅助类代码
String generateHelperClass(String targetClassName) {
  return '''
// 自动生成代码，请勿手动修改
class ${targetClassName}Helper {
  final $targetClassName instance;
  const ${targetClassName}Helper(this.instance);
}
''';
}

如果需要校验生成代码的语法正确性，可以再把生成的代码字符串传入analyzer做语法解析，确认没有错误后再写入文件或使用。

特殊场景：非要在运行时调用build_runner的临时方案 #

如果你是开发本地Dart命令行工具、运行时可以拿到完整项目源码和配置，确实要直接调用build_runner的构建逻辑，可以直接把它挪到普通dependencies中，手动调用内部构建API，但这种方式完全没有官方保障：

import 'package:build_runner/build_runner.dart';
import 'package:build/build.dart';

/// 注意：运行目录必须是完整的Dart/Flutter项目根目录，存在pubspec.yaml、build.yaml等配置
Future<void> runtimeRunBuild() async {
  // 手动注册所有需要用到的Builder，和build.yaml中的配置一一对应
  final builders = <BuilderApplication>[
    // 示例：apply(你的builder标识, builder工厂方法, toRoot())
  ];
  
  await build(
    builders,
    deleteFilesByDefault: true,
    verbose: false,
  );
}

警告：该用法属于非公开API调用，build_runner版本升级时可能随时失效，禁止在发行版应用中使用，仅适合本地工具临时调试用。

内容的提问来源于stack exchange，提问作者immeradon