跳到主要内容

如何使用包

Dart 生态系统使用来管理共享软件,例如库和工具。要获取 Dart 包,您可以使用 pub 包管理器。您可以在 pub.dev 站点上找到公开可用的包,或者您可以从本地文件系统或其他地方(例如 Git 仓库)加载包。无论您的包来自何处,pub 都会管理版本依赖关系,帮助您获取彼此兼容且与您的 SDK 版本兼容的包版本。

大多数Dart 友好的 IDE 都提供对 pub 的支持,包括创建、下载、更新和发布包。或者,您可以在命令行上使用dart pub

最低限度,Dart 包是一个包含pubspec 文件的目录。pubspec 包含有关包的一些元数据。此外,包可以包含依赖项(在 pubspec 中列出)、Dart 库、应用程序、资源、测试、图像和示例。

要使用包,请执行以下操作:

  • 创建 pubspec(一个名为 pubspec.yaml 的文件,其中列出包依赖项并包含其他元数据,例如版本号)。
  • 使用dart pub get 来检索包的依赖项。
  • 如果您的 Dart 代码依赖于包中的库,请导入该库。

创建 pubspec

#

pubspec 是应用程序顶级目录中名为 pubspec.yaml 的文件。最简单的 pubspec 只列出包名:

yaml
name: my_app

以下是 pubspec 的一个示例,它声明了对 pub.dev 站点上托管的两个包 (intlpath) 的依赖:

yaml
name: my_app

dependencies:
  intl: ^0.20.2
  path: ^1.9.1

要更新 pubspec.yaml 文件而无需手动编辑,可以运行 dart pub add 命令。以下示例添加了对 vector_math 的依赖。

dart pub add vector_math
Resolving dependencies... 
+ vector_math 2.1.3
Downloading vector_math 2.1.3...
Changed 1 dependency!

有关创建 pubspec 的详细信息,请参阅 pubspec 文档以及您要使用的包的文档。

获取包

#

有了 pubspec 后,您可以从应用程序的顶层目录运行dart pub get

cd <path-to-my_app>
dart pub get

此过程称为获取依赖项

dart pub get 命令确定您的应用程序依赖哪些包,并将它们放在一个中央系统缓存中。如果您的应用程序依赖于已发布的包,pub 会从pub.dev 站点下载该包。对于 Git 依赖项,pub 会克隆 Git 仓库。传递依赖项也包括在内。例如,如果 js 包依赖于 test 包,pub 会同时获取 js 包和 test 包。

Pub 会创建一个 package_config.json 文件(位于 .dart_tool/ 目录下),它将您的应用程序依赖的每个包名映射到系统缓存中对应的包。

从包导入库

#

要导入包中找到的库,请使用 package: 前缀:

dart
import 'package:js/js.dart' as js;
import 'package:intl/intl.dart';

Dart 运行时会获取 package: 后面的所有内容,并在应用程序的 package_config.json 文件中查找它。

您也可以使用这种样式从自己的包中导入库。假设 transmogrify 包的布局如下:

transmogrify/
  lib/
    transmogrify.dart
    parser.dart
  test/
    parser/
      parser_test.dart

parser_test.dart 文件可以像这样导入 parser.dart

dart
import 'package:transmogrify/parser.dart';

升级依赖项

#

当您第一次为您的包获取新依赖项时,pub 会下载与您的其他依赖项兼容的最新版本。然后它会通过创建一个锁定文件来锁定您的包始终使用该版本。这是一个名为 pubspec.lock 的文件,由 pub 创建并存储在您的 pubspec 旁边。它列出了您的包使用的每个依赖项(直接和传递)的特定版本。

如果您的包是一个应用程序包,您应该将此文件提交到源代码管理中。这样,所有开发您应用程序的人都会使用其所有依赖项的相同版本。提交锁定文件还可以确保您的部署应用程序使用相同版本的代码。

当您准备将依赖项升级到最新版本时,请使用dart pub upgrade 命令:

dart pub upgrade

dart pub upgrade 命令告诉 pub 重新生成锁定文件,使用您的包依赖项的最新可用版本。如果您只想升级一个依赖项,可以指定要升级的包:

dart pub upgrade transmogrify

该命令将 transmogrify 升级到最新版本,但保持其他所有内容不变。

由于 pubspec 中版本约束冲突,dart pub upgrade 命令不总是能将每个包升级到最新版本。要识别需要编辑 pubspec 的过时包,请使用dart pub outdated

获取生产环境依赖项

#

在某些情况下,dart pub get 不会检索 pubspec.lock 文件中锁定的确切包版本:

  • 如果 pubspec.lock 文件上次更新后,pubspec.yaml 中添加或删除了新的依赖项。
  • 如果锁定的版本在包仓库中不再存在。
  • 如果您更改了 Dart SDK 的版本,并且某些包不再与该新版本兼容。

在这些情况下,dart pub get 将会:

  • 解锁足够多的锁定依赖版本,以便能够解决冲突。
  • 通知您任何相对于现有 pubspec.lock 的依赖项更改。

例如,在您的依赖项中添加 retry: ^3.0.0 之后:

dart pub get
Resolving dependencies... (1.0s)
Downloading packages... 
+ retry 3.1.2

此外,如果已发布包版本的内容哈希pubspec.lock 文件中的哈希不同,pub 会警告您并更新锁定文件以反映已发布的版本。

例如,如果您手动更改 pubspec.lockretry 的哈希:

dart pub get
Resolving dependencies... 
Downloading packages... 
~ retry 3.1.2 (was 3.1.2)
The existing content-hash from pubspec.lock doesn't match contents for:
 * retry-3.1.2 from "https://pub.dev"

This indicates one of:
 * The content has changed on the server since you created the pubspec.lock.
 * The pubspec.lock has been corrupted.

The content-hashes in pubspec.lock has been updated.

For more information see:
https://dart.ac.cn/go/content-hashes
Changed 1 dependency!

将项目部署到生产环境时,使用 dart pub get --enforce-lockfile 来检索依赖项。

如果项目的依赖约束无法与 pubspec.lock 中精确的版本和内容哈希匹配,则包检索和命令将失败。这有助于避免将未经测试的依赖项和依赖项版本部署到生产环境。

dart pub get --enforce-lockfile
Resolving dependencies... 
Downloading packages... 
~ retry 3.1.2 (was 3.1.2)
The existing content-hash from pubspec.lock doesn't match contents for:
 * retry-3.1.2 from "https://pub.dev"

This indicates one of:
 * The content has changed on the server since you created the pubspec.lock.
 * The pubspec.lock has been corrupted.

For more information see:
https://dart.ac.cn/go/content-hashes
Would change 1 dependency.
Unable to satisfy `pubspec.yaml` using `pubspec.lock`.

To update `pubspec.lock` run `dart pub get` without `--enforce-lockfile`.

更多信息

#

以下页面包含有关包和 pub 包管理器的更多信息。

操作方法

#

参考

#

Pub 子命令

#

dart pub 工具提供以下子命令:

有关所有 dart pub 子命令的概览,请参阅pub 工具文档

故障排除

#

Pub 故障排除提供了您在使用 pub 时可能遇到的问题的解决方案。