Flutter插件管理工具插件pubspec_lock_copy的使用

在Flutter项目中，pubspec.lock 文件用于锁定项目的依赖版本，确保在不同环境中生成一致的结果。本文将介绍如何使用 pubspec_lock_copy 插件来读取、操作和导出 pubspec.lock 文件的内容。

使用场景

pubspec_lock_copy 是一个 Dart 库，允许开发者通过编程方式访问和修改 pubspec.lock 文件的内容。这对于需要分析或验证依赖项的自动化工具非常有用。

安装 pubspec_lock_copy

首先，在你的 pubspec.yaml 文件中添加 pubspec_lock_copy 作为依赖项：

dependencies:
  pubspec_lock_copy: ^0.1.0

然后运行以下命令以更新依赖：

flutter pub get

数据类

pubspec_lock_copy 提供了几个数据类来表示 pubspec.lock 文件中的内容。

PubspecLock

PubspecLock 表示 pubspec.lock 文件中的所有数据，包括 SDK 依赖和包依赖。

class PubspecLock {
  final Iterable<SdkDependency> sdks;
  final Iterable<PackageDependency> packages;
}

SdkDependency

SdkDependency 表示 SDK 的名称和版本。

@immutable
@FunctionalData()
class SdkDependency {
  const SdkDependency({
    @required this.sdk,
    @required this.version,
  });

  final String sdk;
  final String version;
}

PackageDependency

PackageDependency 表示包依赖，可以是托管依赖、SDK 依赖、Git 依赖或路径依赖。

@immutable
@SumType()
class PackageDependency extends _$PackageDependency {
  const PackageDependency.sdk(SdkPackageDependency sdk) : super(sdk: sdk);
  const PackageDependency.hosted(HostedPackageDependency hosted) : super(hosted: hosted);
  const PackageDependency.git(GitPackageDependency git) : super(git: git);
  const PackageDependency.path(PathPackageDependency path) : super(path: path);

  String package() => iswitch(
        sdk: (d) => d.package,
        hosted: (d) => d.package,
        git: (d) => d.package,
        path: (d) => d.package,
      );

  String version() => iswitch(
        sdk: (d) => d.version,
        hosted: (d) => d.version,
        git: (d) => d.version,
        path: (d) => d.version,
      );

  DependencyType type() => iswitch(
        sdk: (d) => d.type,
        hosted: (d) => d.type,
        git: (d) => d.type,
        path: (d) => d.type,
      );
}

导入 pubspec.lock 文件

要从 YAML 字符串加载 pubspec.lock 文件内容，可以使用 loadPubspecLockFromYaml() 方法。

final pubspecLock = File('pubspec.lock').readAsStringSync().loadPubspecLockFromYaml();

导出 pubspec.lock 文件

要将 PubspecLock 对象导出为 YAML 字符串，可以使用 toYamlString() 方法。

File('pubspec.lock').writeAsStringSync(pubspecLock.toYamlString());

示例代码

以下是一个完整的示例代码，展示如何检查 pubspec.lock 文件中的所有依赖是否都来自 pub.dev。

示例代码

import 'dart:io';

import 'package:pubspec_lock_copy/pubspec_lock_copy.dart';

// 忽略警告：避免打印
// ignore_for_file: avoid_print

void main() {
  // 读取 pubspec.lock 文件并解析为 PubspecLock 对象
  final file = File('pubspec.lock');
  final pubspecLock = file.readAsStringSync().loadPubspecLockFromYaml();
  
  // 打印解析结果
  print('Loaded pubspec.lock with '
      '${pubspecLock.packages.length} package dependencies:');

  // 查找未托管在 pub.dev 上的依赖
  final depsNotHostedByPubDev = [
    for (final package in pubspecLock.packages)
      if (!isHostedByPubDev(package)) package
  ];

  // 输出结果
  if (depsNotHostedByPubDev.isEmpty) {
    print('SUCCESS: All dependencies are hosted by pub.dev');
  } else {
    print('WARNING: Dependencies hosted outside of pub.dev:');
    depsNotHostedByPubDev.forEach(print);
  }

  // 将更新后的 PubspecLock 写回文件
  file.writeAsStringSync(pubspecLock.toYamlString());
}

// 检查包是否托管在 pub.dev
bool isHostedByPubDev(PackageDependency package) => package.iswitcho(
      hosted: (package) => package.url == 'https://pub.dartlang.org',
      otherwise: () => false,
    );

示例代码运行结果

假设 pubspec.lock 文件包含以下内容：

dependencies:
  flutter:
    sdk: flutter
  http:
    hosted:
      name: http
      url: https://pub.dartlang.org
    version: "0.13.3"
  path:
    path: ../path
    version: "1.8.0"

运行上述代码后，输出如下：

Loaded pubspec.lock with 2 package dependencies:
WARNING: Dependencies hosted outside of pub.dev:
PackageDependency(path: path, version: 1.8.0, type: Path)