跳到主要内容
目录

包布局约定

目录 keyboard_arrow_down keyboard_arrow_up
more_horiz

当您构建 pub 包时，我们鼓励您遵循本页描述的约定。它们描述了如何组织包内的文件和目录，以及如何命名。

以下是一个完整包（名为 enchilada）的示例，它使用了这些指南的各个方面

enchilada/
  .dart_tool/ *
  pubspec.yaml
  pubspec_overrides.yaml **
  pubspec.lock ***
  LICENSE
  README.md
  CHANGELOG.md
  benchmark/
    make_lunch.dart
  bin/
    enchilada
  doc/
    api/ ****
    getting_started.md
  example/
    main.dart
  hook/
    build.dart
  integration_test/
    app_test.dart
  lib/
    enchilada.dart
    tortilla.dart
    guacamole.css
    src/
      beans.dart
      queso.dart
  test/
    enchilada_test.dart
    tortilla_test.dart
  tool/
    generate_docs.dart
  web/
    index.html
    main.dart
    style.css

* .dart_tool/ 目录在您运行 dart pub get 后存在。不要将其检入到源代码控制中。要了解更多信息，请参阅工具的项目特定缓存。

** pubspec_overrides.yaml 文件（如果存在）会覆盖 pubspec.yaml 的某些方面。通常您不希望将其检入到源代码控制中。

*** pubspec.lock 文件在您运行 dart pub get 后存在。除非您的包是应用包，否则请将其从源代码控制中排除。

**** doc/api 目录在您运行 dart doc 后本地存在。不要将 api 目录检入到源代码控制中。

pubspec

#
enchilada/
  pubspec.yaml
  pubspec.lock

每个包都有一个 pubspec，一个名为 pubspec.yaml 的文件，位于包的根目录中。这就是使它成为包的原因。

在包上运行 dart pub get、dart pub upgrade 或 dart pub downgrade 会创建一个锁定文件，名为 pubspec.lock。如果您的包是应用包，请将锁定文件检入到源代码控制中。否则，不要。

有关更多信息，请参阅 pubspec 页面。

LICENSE

#
enchilada/
  LICENSE

如果您要发布您的包，请包含一个名为 LICENSE 的许可证文件。我们建议使用 OSI 批准的许可证，例如 BSD-3-Clause，以便其他人可以重用您的工作。

README.md

#
enchilada/
  README.md

在开源中非常常见的一个文件是 README 文件，它描述了项目。这在 pub 中尤其重要。当您上传到 pub.dev 站点时，您的 README.md 文件会显示在您的包页面上，并渲染为 Markdown。这是向人们介绍您的代码的绝佳位置。

有关如何编写出色的 README 的指南，请参阅编写包页面。

CHANGELOG.md

#
enchilada/
  CHANGELOG.md

包含一个 CHANGELOG.md 文件，其中包含包的每个版本的章节，并附带注释以帮助您的包用户升级。您的包用户经常查看变更日志以发现错误修复和新功能，或确定升级到最新版本的包需要多少工作量。

为了支持解析 CHANGELOG.md 的工具，请使用以下格式

  • 每个版本都有自己的章节，带有标题。
  • 版本标题要么全部为 1 级标题，要么全部为 2 级标题。
  • 版本标题文本包含包版本号，可以选择以“v”为前缀。

当您将包上传到 pub.dev 站点时，您包的 CHANGELOG.md 文件（如果有）将显示在 Changelog 选项卡中，并渲染为 Markdown。

以下是 CHANGELOG.md 文件的示例。如示例所示，您可以添加子章节。

markdown
# 1.0.1

* Fixed missing exclamation mark in `sayHi()` method.

# 1.0.0

* **Breaking change:** Removed deprecated `sayHello()` method.
* Initial stable release.

## Upgrading from 0.1.x

Change all calls to `sayHello()` to instead be to `sayHi()`.

# 0.1.1

* Deprecated the `sayHello()` method; use `sayHi()` instead.

# 0.1.0

* Initial development release.

公共目录

#

包中的两个目录对其他包是公开的：lib 和 bin。您将公共库放在 lib 中，将公共工具放在 bin 中。

公共库

#

以下目录结构显示了 enchilada 的 lib 部分

enchilada/
  lib/
    enchilada.dart
    tortilla.dart

许多 包定义了其他包可以导入和使用的 Dart 库。这些公共 Dart 库文件放在名为 lib 的目录中。

大多数包定义了一个用户可以导入的库。在这种情况下，它的名称通常应与包的名称相同，例如此处示例中的 enchilada.dart。但是您也可以定义其他库，使用对您的包有意义的任何名称。

当您这样做时，用户可以使用包的名称和库文件导入这些库，如下所示

dart
import 'package:enchilada/enchilada.dart';
import 'package:enchilada/tortilla.dart';

如果您想组织您的公共库，您也可以在 lib 中创建子目录。如果您这样做，用户将在导入时指定该路径。假设您有以下文件层次结构

enchilada/
  lib/
    some/
      path/
        olives.dart

用户按如下方式导入 olives.dart

dart
import 'package:enchilada/some/path/olives.dart';

请注意，只有库应该放在 lib 中。入口点—带有 main() 函数的 Dart 脚本—不能放在 lib 中。如果您将 Dart 脚本放在 lib 中，您将发现它包含的任何 package: 导入都无法解析。相反，您的入口点应该放在适当的入口点目录中。

有关包的更多信息，请参阅创建包。

公共工具

#

放置在 bin 目录内的 Dart 脚本是公开的。如果您在包的目录中，则可以使用 dart run 运行包依赖的任何其他包的 bin 目录中的脚本。从任何目录，您可以运行脚本，这些脚本来自您使用 dart pub global activate 激活的包。

如果您希望您的包被依赖，并且您希望您的脚本对您的包是私有的，请将它们放在顶层 tool 目录中。如果您不希望您的包被依赖，您可以将您的脚本留在 bin 中。

公共资源

#
enchilada/
  lib/
    guacamole.css

虽然大多数包的存在是为了让您重用 Dart 代码，但您也可以重用其他类型的内容。例如，Bootstrap 的包可能包含许多 CSS 文件，供包的使用者使用。

这些文件放在顶层 lib 目录中。您可以将任何类型的文件放在那里，并使用子目录随意组织它。

实现文件

#
enchilada/
  lib/
    src/
      beans.dart
      queso.dart

lib 内的库是公开可见的：其他包可以自由导入它们。但是，包的大部分代码是内部实现库，这些库只应由包本身导入和使用。这些库放在 lib 的一个名为 src 的子目录中。如果子目录有助于您组织事物，您可以在其中创建子目录。

您可以自由地从同一包中的其他 Dart 代码（如 lib 中的其他库、bin 中的脚本和测试）导入位于 lib/src 中的库，但您绝不应从另一个包的 lib/src 目录导入。这些文件不是包的公共 API 的一部分，它们可能会以可能破坏您的代码的方式更改。

如何从您自己的包中导入库取决于库的位置

例如

lib/beans.dart
dart
// When importing from within lib:
import 'src/beans.dart';
test/beans_test.dart
dart
// When importing from outside lib:
import 'package:enchilada/src/beans.dart';

您在此处使用的名称（在本例中为 enchilada）是您在包的 pubspec 中指定的名称。

Web 文件

#
enchilada/
  web/
    index.html
    main.dart
    style.css

对于 Web 包，请将入口点代码—包含 main() 和支持文件（如 CSS 或 HTML）的 Dart 脚本—放在 web 下。您可以将 web 目录组织成子目录（如果需要）。

将库代码放在 lib 下。如果库没有被 web 下的代码或其他包直接导入，则将其放在 lib/src 下。将基于 Web 的示例放在 example 下。有关将资源（如图像）放在何处的提示，请参阅公共资源。

命令行应用

#
enchilada/
  bin/
    enchilada

某些包定义了可以直接从命令行运行的程序。这些可以是 shell 脚本或任何其他脚本语言，包括 Dart。

如果您的包定义了这样的代码，请将其放在名为 bin 的目录中。如果您使用 dart pub global 设置了它，则可以从命令行上的任何位置运行该脚本。

测试和基准测试

#
enchilada/
  test/
    enchilada_test.dart
    tortilla_test.dart

每个包都应该有测试。使用 pub，约定是将大多数测试放在 test 目录（或其中的某个目录，如果您喜欢）中，并在其文件名末尾添加 _test。

通常，这些测试使用 test 包。

enchilada/
  integration_test/
    app_test.dart

Flutter 应用包也可能具有特殊的集成测试，这些测试使用 integration_test 包。这些测试位于它们自己的 integration_test 目录中。

其他包可能会选择遵循类似的模式，将较慢的集成测试与单元测试分开，但请注意，默认情况下 dart test 不会运行这些测试。您必须使用 dart test integration_test 显式运行它们。

enchilada/
  benchmark/
    make_lunch.dart

具有性能关键代码的包也可能包含基准测试。这些测试 API 不是为了正确性，而是为了速度（或内存使用，或可能其他经验指标）。

文档

#
enchilada/
  doc/
    api/
    getting_started.md

如果您有代码和测试，您可能需要的下一部分是良好的文档。这放在名为 doc 的目录中。

当您运行 dart doc 工具时，默认情况下，它会将 API 文档放在 doc/api 下。由于 API 文档是从源代码生成的，因此您不应将其放在源代码控制之下。

除了生成的 api 之外，我们对您编写的文档的格式或组织没有任何指导。使用您喜欢的任何标记格式。

示例

#
enchilada/
  example/
    main.dart

代码、测试、文档，您的用户还想要什么？当然是使用您的包的独立示例程序！这些程序放在 example 目录中。如果示例很复杂并且使用了多个文件，请考虑为每个示例创建一个目录。否则，您可以将每个示例直接放在 example 中。

在您的示例中，使用 package: 从您自己的包中导入文件。这确保了您包中的示例代码看起来与包外部的代码完全一样。

如果您可能会发布您的包，请考虑使用以下名称之一创建一个示例文件

  • example/example[.md]
  • example[/lib]/main.dart
  • example[/lib]/package_name.dart
  • example[/lib]/package_name_example.dart
  • example[/lib]/example.dart
  • example/README[.md]

当您发布包含上述一个或多个文件的包时，pub.dev 站点会创建一个 示例 选项卡来显示它找到的第一个文件（按上面列表显示的顺序搜索）。例如，如果您的包的 example 目录下有许多文件，包括一个名为 README.md 的文件，那么您包的“示例”选项卡将显示 example/README.md 的内容（解析为 Markdown。）

内部工具和脚本

#
enchilada/
  tool/
    generate_docs.dart

成熟的包通常有一些小的辅助脚本和程序，人们在开发包本身时会运行这些脚本和程序。想想诸如测试运行器、文档生成器或其他自动化之类的东西。

与 bin 中的脚本不同，这些脚本不是为包的外部用户准备的。如果您有任何这些脚本，请将它们放在名为 tool 的目录中。

钩子

#
enchilada/
  hook/
    build.dart

包可以定义由 Dart 和 Flutter SDK 调用的钩子。这些钩子具有预定义的 CLI，如果存在，SDK 工具将调用它们。

由于这些钩子是在运行和构建时由 dart 和 flutter 工具调用的，因此这些钩子的依赖项必须是正常依赖项，而不是 dev_dependencies。

工具的项目特定缓存

#

.dart_tool/ 目录在您运行 dart pub get 时创建，并且可能随时删除。各种工具使用此目录来缓存特定于您的项目和/或本地计算机的文件。.dart_tool/ 目录永远不应检入到源代码控制中，或在计算机之间复制。

删除 .dart_tool/ 目录通常也是安全的，尽管某些工具可能需要重新计算缓存的信息。

示例： dart pub get 工具会将依赖项下载并提取到全局 $PUB_CACHE 目录，然后写入一个 .dart_tool/package_config.json 文件，该文件将包名称映射到全局 $PUB_CACHE 目录中的目录。.dart_tool/package_config.json 文件供其他工具（如分析器和编译器）在需要解析诸如 import 'package:foo/foo.dart' 之类的语句时使用。

在开发需要项目特定缓存的工具时，您可以考虑使用 .dart_tool/ 目录，因为大多数用户已经使用 .gitignore 忽略了它。当在用户的 .dart_tool/ 目录中缓存工具的文件时，您应该使用唯一的子目录。为了避免冲突，.dart_tool/<tool_package_name>/ 形式的子目录为名为 <tool_package_name> 的包保留。如果您的工具不是通过 pub.dev 站点分发的，您可以考虑发布一个占位符包以保留唯一的名称。

示例： package:build 提供了一个用于编写代码生成步骤的框架。当运行这些构建步骤时，文件会缓存在 .dart_tool/build/ 中。这有助于加速未来重新运行构建步骤。

除非另有说明，否则本站点上的文档反映的是 Dart 3.7.1 版本。页面上次更新时间为 2025-02-28。 查看源代码 或 报告问题。