Dart Academy · 课时

构建可发布的库

规划 lib、src 与公共 API

第 1 / 4 课13 个步骤

构建可发布的库 是 CoddyKit 上的免费 Dart Academy 课时。 这是第 1 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Dart Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Dart Academy 课程共包含 4 节课。

软件包就是一个文件夹

一个可发布的 Dart 软件包,本质上就是一个根目录中包含 pubspec.yaml 的文件夹。这个文件会将普通代码变成 pub.dev 可以托管的内容。📦

lib 文件夹是公共归属地

您希望用户导入的所有内容都应放在 lib 下。直接位于 lib 中的文件属于软件包的公共接口,因此请谨慎安排它们的位置。

在 lib/src 中隐藏内部实现

不希望公开的代码应放入 lib/src。按照惯例,这些文件属于私有实现细节,不供用户直接导入。

lib/
  my_package.dart
  src/
    helper.dart

入口文件

大多数软件包会在 lib 中放置一个以软件包命名的主文件。这个入口是用户导入整个库的地方。

import 'package:my_package/my_package.dart';

使用 export 关键字重新导出

您的入口文件使用导出功能,将 lib/src 中用户实际需要的部分公开出来。这样您就能维护一个整洁、明确且经过筛选的公共 API。

export 'src/calculator.dart';
export 'src/parser.dart';

有意识地决定公共 API

您导出的名称集合就是公共 API。请让它保持精简和稳定,因为每个导出的符号都是对用户作出的承诺。

下划线表示私有

在 Dart 中,以下划线开头的名称属于库私有。即使在 lib/src 中,也请在不希望泄露的辅助名称前加一个下划线。

int _internalCount = 0;

示例文件夹

添加一个包含小型可运行程序的示例文件夹。它可以向用户展示软件包的用法,还能为您在 pub.dev 上赢得评分。✨

测试应放在 test 中

自动化测试应放在 lib 外部的 test 文件夹中。它们不会随软件包发布给用户,但能证明软件包的行为符合承诺。

顶层文件很重要

一个完善的软件包根目录还应包含 README、CHANGELOG 和 LICENSE。这三个文件是 pub.dev 向访客展示的首要内容。

一眼看懂的整洁布局

将它们组合起来,结构就像一张地图:lib 存放 API,src 存放内部实现,此外还有 example、test 和元数据文件。

my_package/
  lib/
  example/
  test/
  pubspec.yaml

快速检查

您应将哪些代码放在内部实现细节中,使其保持不对外公开?

回顾:整洁的库

您已经了解了布局:lib 存放公共 API,lib/src 隐藏内部实现,而导出功能负责筛选用户能看到的内容。先组织好结构,再发布。🚀

免费开始

用 AI 导师学习 Dart — 免费

在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。

课程
30
课程
120

常见问题解答

「构建可发布的库」课时是免费的吗?

是的 — 「构建可发布的库」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Dart Academy 课程的其余内容,请升级到 CoddyKit PRO。 Dart Academy 课程共包含 4 节课。

「构建可发布的库」这节课中我会学到什么?

规划 lib、src 与公共 API 你通过在浏览器中直接运行的动手代码来练习 Dart Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Dart Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 Dart Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 4 节。

「构建可发布的库」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 Dart Academy 课中编写并运行代码吗?

能。每节 Dart Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 构建可发布的库
  2. 使用 dartdoc 注释编写文档
  3. 代码检查、格式化与 pana 评分
  4. 使用 dart pub publish 发布到 pub.dev
← 返回 Dart Academy