自定义包仓库

内容

使用自定义包仓库进行身份验证
从自定义包仓库检索依赖项
- 使用多个包仓库
发布到自定义包仓库
- 覆盖默认包仓库
设置自定义包仓库
- Dart 包仓库即服务

dart pub 工具支持第三方包仓库。包仓库是用于托管 Dart 包的服务器，供 dart pub 工具使用。使用的默认包仓库是 pub.dev，由 Dart 团队运营，用于促进为公共使用发布 Dart 包。包仓库由一个托管 URL标识，例如 https://dart-packages.example.com/。

在某些情况下，自定义包仓库可能会有用，例如托管私有包，包括以下场景：

在组织内共享内部专有包。
在企业环境中严格控制依赖项。
没有公共互联网访问权限的安全环境。

使用 git 依赖项托管私有包也很常见，但是 dart pub 工具不支持针对 git 仓库解析版本；它只获取 git 仓库的特定修订版本。因此，当许多人协作时，使用私有包仓库通常是更好的选择。

大多数自定义包仓库都是私有包仓库，需要身份验证。为了对自定义包仓库进行身份验证，dart pub 工具会将一个秘密令牌附加到请求中。

您可以从自定义包仓库获取秘密令牌，并手动指定它或通过环境变量指定它。要手动指定秘密令牌，请使用 dart pub token add 命令，该命令会提示您输入令牌

$ dart pub token add https://dart-packages.example.com
Enter secret token: [enter secret token]
Requests to "https://dart-packages.example.com" will now be authenticated using the secret token.

您还可以告诉 dart pub 从环境变量（包括 CI 环境）读取令牌，方法是使用 --env-var 标志

$ dart pub token add https://dart-packages.example.com --env-var MY_SECRET_TOKEN
Requests to "https://dart-packages.example.com" will now be authenticated using the secret token stored in the environment variable "MY_SECRET_TOKEN".

这确保了 dart pub 不会实际在其配置中存储秘密令牌，而只是存储一个事实，即它应该从环境变量 $MY_SECRET_TOKEN 读取秘密。这降低了秘密在 CI 作业之间共享时意外泄露的风险。

要从自定义包仓库获取包，您必须使用托管包的语法，在 pubspec.yaml 中为包指定托管 URL。例如

yamldependencies:
  example_package:
    hosted: https://dart-packages.example.com
    version: ^1.4.0

在前面的示例中，package:example_package 从 https://dart-packages.example.com 获取。如果此包仓库需要身份验证，请参阅使用自定义包仓库进行身份验证，了解有关如何对请求进行身份验证的更多信息。

您还可以使用 dart pub add 命令，并带有 --hosted 标志，从自定义包仓库添加依赖项

$ dart pub add example_package --hosted https://dart-packages.example.com

您还可以从不同的包仓库获取不同的依赖项，因为每个依赖项都可以指定托管 URL

yamldependencies:
  # package retry is fetched from pub.dev (the default package repository)
  retry: ^3.0.0
  # package example_package is fetched from https://dart-packages.example.com
  example_package:
    hosted: https://dart-packages.example.com
    version: ^1.4.0

这使您能够将私有包保存在私有包仓库中，同时使用最新公共包作为依赖项。

但是，如果您的依赖项需要来自不同仓库的同名包，则很容易出现冲突。例如，如果包 retry 需要来自 pub.dev 的 meta，而 example_package 需要来自 https://dart-packages.example.com 的 meta。因此，如果将任何包镜像到私有包仓库中，通常需要镜像所有依赖项，并更新每个包的 dependencies 部分，或覆盖默认包仓库。

要将包发布到自定义包仓库，而不是 pub.dev，请在 pubspec.yaml 中指定 publish_to 属性。如果启用了身份验证，则发布会使用与检索包相同的令牌身份验证。

要准备将包发布到 https://dart-packages.example.com，您的 pubspec.yaml 应该至少如下所示

yamlname: example_package
version: 1.0.0
# Ensures the package is published to https://dart-packages.example.com
publish_to: https://dart-packages.example.com

然后，要发布包的新版本，请使用 dart pub publish

$ dart pub publish
Publishing example_package 1.0.0 to https://dart-packages.example.com
|-- CHANGELOG.md
|-- LICENSE
|-- README.md
|-- lib
|   '-- example_package.dart
'-- pubspec.yaml
...