库和导入

import 和 library 指令可以帮助您创建模块化和可共享的代码库。库不仅提供 API，还是一个隐私单元：以下划线 (_) 开头的标识符仅在库内部可见。每个 Dart 文件（及其组成部分）都是一个库，即使它不使用 library 指令。

库可以使用包进行分发。

使用 import 来指定一个库的命名空间如何在另一个库的作用域中使用。

例如，Dart Web 应用通常使用 dart:js_interop 库，它们可以像这样导入它

import 'dart:js_interop';

import 的唯一必需参数是指定库的 URI。对于内置库，URI 具有特殊的 dart: 方案。对于其他库，您可以使用文件系统路径或 package: 方案。package: 方案指定由包管理器（如 pub 工具）提供的库。例如

import 'package:test/test.dart';

如果您导入的两个库具有冲突的标识符，则可以为一个或两个库指定前缀。例如，如果 library1 和 library2 都有一个 Element 类，那么您可能会有这样的代码

import 'package:lib1/lib1.dart';
import 'package:lib2/lib2.dart' as lib2;

// Uses Element from lib1.
Element element1 = Element();

// Uses Element from lib2.
lib2.Element element2 = lib2.Element();

带有通配符名称 _ 的导入前缀是非绑定的，但将提供对该库中非私有扩展的访问。

如果您只想使用库的一部分，则可以选择性地导入库。例如

// Import only foo.
import 'package:lib1/lib1.dart' show foo;

// Import all names EXCEPT foo.
import 'package:lib2/lib2.dart' hide foo;

延迟加载（也称为懒加载）允许 Web 应用按需加载库，只要在需要库时即可。当您想要满足以下一个或多个需求时，请使用延迟加载。

• 减少 Web 应用的初始启动时间。
• 执行 A/B 测试——例如，尝试算法的替代实现。
• 加载很少使用的功能，例如可选屏幕和对话框。

这并不意味着 Dart 在启动时加载所有延迟组件。Web 应用可以在需要时通过 Web 下载延迟组件。

dart 工具不支持除 Web 以外的目标的延迟加载。如果您正在构建 Flutter 应用，请查阅 Flutter 指南中关于 延迟组件 的延迟加载实现。

要延迟加载库，首先使用 deferred as 导入它。

import 'package:greetings/hello.dart' deferred as hello;

当您需要库时，使用库的标识符调用 loadLibrary()。

Future<void> greet() async {
  await hello.loadLibrary();
  hello.printGreeting();
}

在前面的代码中，await 关键字暂停执行，直到库加载完成。有关 async 和 await 的更多信息，请参阅异步支持。

您可以多次对库调用 loadLibrary() 而不会出现问题。库只加载一次。

当您使用延迟加载时，请记住以下几点

• 延迟库的常量在导入文件中不是常量。请记住，这些常量在延迟库加载之前不存在。
• 您不能在导入文件中使用延迟库中的类型。相反，请考虑将接口类型移动到由延迟库和导入文件都导入的库中。
• Dart 隐式地将 loadLibrary() 插入到您使用 deferred as namespace 定义的命名空间中。loadLibrary() 函数返回一个 Future。

要指定库级别的文档注释或元数据注解，请将它们附加到文件开头的 library 声明中。

/// A really great test library.
@TestOn('browser')
library;

请参阅创建包，以获取有关如何实现包的建议，包括

• 如何组织库源代码。
• 如何使用 export 指令。
• 何时使用 part 指令。
• 如何使用条件导入和导出来实现支持多平台的库。

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