Pub 工作区（Monorepo 支持）

在项目开发中，您可能会在同一个版本控制仓库（monorepo）中开发多个 Dart 包。

例如，您可能具有如下目录布局

/
  packages/
    shared/
      pubspec.yaml
      pubspec.lock
      .dart_tool/package_config.json
    client_package/
      pubspec.yaml
      pubspec.lock
      .dart_tool/package_config.json
    server_package/
      pubspec.yaml
      pubspec.lock
      .dart_tool/package_config.json

这种设置有一些缺点

• 您需要为每个包运行一次 dart pub get。
• 您可能会最终为每个包使用不同版本的依赖项，从而在包之间切换上下文时导致混淆。
• 如果您在 IDE 中打开根文件夹，Dart 分析器将为每个包创建单独的分析上下文，从而增加内存使用量。

Pub 允许您使用所有包的单个共享解析将仓库组织为工作区。对于大型仓库，使用工作区可以减少分析所需的内存量，从而提高性能。

要创建工作区

• 在仓库根目录中添加一个 pubspec.yaml 文件，其中包含一个 workspace 条目，用于枚举仓库包（工作区包）的路径

  yaml

  name: _
  publish_to: none
  environment:
    sdk: ^3.6.0
  workspace:
    - packages/helper
    - packages/client_package
    - packages/server_package

• 对于每个现有的 pubspec.yaml 文件，请确保它们的 SDK 约束至少为 ^3.6.0，并添加一个 resolution 条目

  yaml

  environment:
    sdk: ^3.6.0
  resolution: workspace

• 在仓库中的任何位置运行 dart pub get。这将

  • 在根 pubspec.yaml 文件旁边创建一个单独的 pubspec.lock 文件，其中包含所有工作区包的所有 dependencies 和 dev_dependencies 的解析。
  • 创建一个单独的共享 .dart_tool/package_config.json 文件，将包名称映射到文件位置。
  • 删除工作区包旁边的任何其他现有 pubspec.lock 和 .dart_tool/package_config.json 文件。

现在文件结构看起来像这样

/
  packages/
    shared/
      pubspec.yaml
    client_package/
      pubspec.yaml
    server_package/
      pubspec.yaml
  pubspec.yaml
  pubspec.lock
  .dart_tool/package_config.json

当您迁移现有的 monorepo 以使用 Pub 工作区时，每个 pubspec 旁边都会存在现有的“零散” pubspec.lock 和 .dart_tool/package_config.json 文件。这些文件会遮蔽放置在根目录旁边的 pubspec.lock 和 .dart_tool/package_config.json 文件。

因此，pub get 将删除位于根目录和（包括）任何工作区包之间的目录中的任何 pubspec.lock 和 .dart_tool/package_config.json 文件。

/
  pubspec.yaml                       # Root
  packages/
    pubspec.lock                     # Deleted by `pub get`
    .dart_tool/package_config.json   # Deleted by `pub get`
    foo/
      pubspec.yaml                   # Workspace member
      pubspec.lock                   # Deleted by `pub get`
      .dart_tool/package_config.json # Deleted by `pub get`

如果工作区根目录和工作区包之间的任何目录包含不属于工作区的“零散” pubspec.yaml 文件，则 pub get 将报告错误并解析失败。这是因为解析此类 pubspec.yaml 将创建一个 .dart_tool/package_config.json 文件，该文件会遮蔽根目录下的文件。

例如

/
  pubspec.yaml                      # Root `workspace: ['foo/']`
  packages/
    pubspec.yaml                    # Not workspace member => error
    foo/
      pubspec.yaml                  # Workspace member

如果任何工作区包相互依赖，它们将自动解析为工作区中的包，而与来源无关。

例如。packages/client_package/pubspec.yaml 可能会依赖于 shared

dependencies:
  shared: ^2.3.0

当在工作区内解析时，将使用 shared 的本地版本。

但是，shared 的本地版本仍然必须与约束 (^2.3.0) 匹配。

但是，当包作为依赖项被使用，而不是作为工作区的一部分时，将使用原始来源（此处隐式为 hosted）。

因此，如果 client_package 发布到 pub.dev 并且有人依赖它，他们将获得 shared 的 hosted 版本作为传递依赖项。

工作区包中的所有 dependency_overrides 部分都将受到尊重。您还可以将 pubspec_overrides.yaml 文件放在任何工作区 pubspec.yaml 文件旁边。

您在工作区中只能覆盖一个包一次。为了保持覆盖的组织性，最好将 dependency_overrides 保留在根 pubspec.yaml 文件中。

某些 pub 命令（例如 dart pub add 和 dart pub publish）对“当前”包进行操作。您可以更改目录，也可以使用 -C 将 pub 指向目录

$ dart pub -C packages/client_package publish
# Same as
$ cd packages/client_package ; dart pub publish ; cd -

有时您可能希望单独解析工作区包，例如验证其依赖项约束。

一种方法是创建一个 pubspec_overrides.yaml 文件，该文件重置 resolution 设置，如下所示

# packages/client_package/pubspec_overrides.yaml
resolution:

现在在 packages/client_package 内运行 dart pub get 将创建一个独立的解析。

您可以运行 dart pub workspace list 以列出工作区的包。

$ dart pub workspace list
Package         Path                      
_               ./                        
client_package  packages/client_package/  
server_package  packages/server_package/  
shared          packages/shared/

除非另有说明，否则本网站上的文档反映的是 Dart 3.7.1 版本。页面上次更新于 2025-01-17。 查看源代码 或 报告问题。