纯Dart项目如何获取并打印pubspec.yaml中定义的包名？

方案1：直接读取并解析pubspec.yaml（最直接） #

这种方法适合常规开发场景，直接读取项目根目录的pubspec.yaml文件，借助yaml包解析出name字段。

步骤： #

1. 在pubspec.yaml中添加依赖：

dependencies:
  yaml: ^3.1.2

2. 编写解析代码：

import 'dart:io';
import 'package:yaml/yaml.dart';

void main() async {
  // 拼接项目根目录下pubspec.yaml的路径
  final pubspecPath = '${Directory.current.path}/pubspec.yaml';
  final pubspecFile = File(pubspecPath);
  
  if (await pubspecFile.exists()) {
    final fileContent = await pubspecFile.readAsString();
    final yamlData = loadYaml(fileContent) as Map;
    final packageName = yamlData['name'];
    print('包名：$packageName');
  } else {
    print('未找到pubspec.yaml文件');
  }
}

说明：该方法简单直观，但如果项目编译为独立可执行文件，pubspec.yaml不会被打包，编译后的程序无法通过此方法获取包名。

方案2：通过build_runner生成静态代码（适合编译场景） #

如果需要编译成可执行文件，或者不想在运行时读取文件，可以用build_runner预先将包名注入到代码中，运行时直接调用即可。

步骤： #

1. 添加依赖到pubspec.yaml：

dev_dependencies:
  build_runner: ^2.4.4

2. 创建生成脚本tool/pubspec_generator.dart：

import 'dart:io';
import 'package:yaml/yaml.dart';
import 'package:build/build.dart';

Builder pubspecNameBuilder(BuilderOptions options) => PubspecNameBuilder();

class PubspecNameBuilder implements Builder {
  @override
  final buildExtensions = const {
    'pubspec.yaml': ['lib/pubspec_info.g.dart'],
  };

  @override
  Future<void> build(BuildStep buildStep) async {
    final pubspecContent = await File('pubspec.yaml').readAsString();
    final yamlMap = loadYaml(pubspecContent) as Map;
    final packageName = yamlMap['name'] as String;

    final generatedCode = '''
// 自动生成代码，请勿手动修改
const String appPackageName = '$packageName';
''';

    await buildStep.writeAsString(
      AssetId(buildStep.inputId.package, 'lib/pubspec_info.g.dart'),
      generatedCode,
    );
  }
}

3. 在项目根目录创建build.yaml配置文件：

targets:
  $default:
    builders:
      pubspec_name_builder:
        import: 'tool/pubspec_generator.dart'
        builder_factories: ['pubspecNameBuilder']
        build_extensions:
          'pubspec.yaml': ['lib/pubspec_info.g.dart']
        auto_apply: root_package
        build_to: source

4. 运行生成命令：

dart run build_runner build

5. 在代码中使用生成的常量：

import 'pubspec_info.g.dart';

void main() {
  print('包名：$appPackageName');
}

说明：此方法会在编译前将包名硬编码到代码中，编译后的可执行文件也能正常获取包名，适合发布场景。

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