内容

不健全的空安全

一个 Dart 程序可能包含一些空安全的库和一些不是空安全的库。这些混合版本程序依赖于不健全的空安全

混合语言版本的能力让包维护者可以迁移他们的代码,同时知道即使是遗留用户也可以获得新的错误修复和其他改进。然而,混合版本程序无法获得空安全所能带来的所有优势。

本页面描述了健全和不健全的空安全之间的区别,目的是帮助您决定何时迁移到空安全。在概念讨论之后,是关于增量迁移的说明,然后是关于测试和运行混合版本程序的详细信息。

健全和不健全的空安全

#

Dart 通过静态和运行时检查的组合提供健全的空安全。每个选择使用空安全的 Dart 库都会获得所有的静态检查,以及更严格的编译时错误。即使在包含不安全空库的混合版本程序中也是如此。您一旦开始将部分代码迁移到空安全,就开始获得这些好处。

但是,混合版本程序不能具有完全空安全应用程序所具有的运行时健全性保证。null 可能从不安全的空库泄漏到空安全的代码中,因为阻止这种情况会破坏未迁移代码的现有行为。

为了在为完全空安全程序提供健全性的同时保持与遗留库的运行时兼容性,Dart 工具支持两种模式

  • 混合版本程序以不健全的空安全运行。运行时可能发生 null 引用错误,但这只是因为 null 或可为空的类型从某些不安全的空库中逸出并进入了空安全的代码。

  • 当一个程序完全迁移并且所有它的库都是空安全时,那么它以健全的空安全运行,具有健全性所启用的所有保证和编译器优化。

如果可能,您想要健全的空安全。如果程序的入口点库已选择使用空安全,Dart 工具会自动以健全模式运行您的程序。如果您导入一个不安全的空库,工具会打印一个警告,让您知道它们只能以不健全的空安全运行。

增量迁移

#

由于 Dart 支持混合版本程序,您可以一次迁移一个库(通常是一个 Dart 文件),同时仍然能够运行您的程序及其测试。

我们建议您首先迁移叶子库——不从包中导入其他文件的库。然后迁移直接依赖于叶子库的库。最后迁移具有最多包内依赖项的库。

例如,假设您有一个 lib/src/util.dart 文件,它导入其他(空安全)包和核心库,但没有任何 import '<local_path>' 指令。考虑首先迁移 util.dart,然后迁移仅依赖于 util.dart 的文件。如果任何库具有循环导入(例如,A 导入 B,B 导入 C,C 导入 A),请考虑一起迁移这些库。

使用迁移工具

#

您可以使用迁移工具增量迁移。要选择退出文件或目录,请单击绿色复选框。在以下屏幕截图中,bin 目录中的所有文件都已选择退出。

Screenshot of file viewer in migration tool

每个选择退出的文件都将保持不变,除了一个 2.9 语言版本注释。您可以稍后再次运行 dart migrate 以继续迁移。任何已经迁移的文件都有一个禁用的复选框:一旦文件被迁移,您就无法取消迁移。

手动迁移

#

如果您想手动增量迁移一个包,请按照以下步骤操作

  1. 编辑包的 pubspec.yaml 文件,将最小 SDK 约束设置为至少 2.12.0

    yaml
    environment:
      sdk: '>=2.12.0 <3.0.0'
  2. 重新生成包配置文件

    $ dart pub get

    使用 2.12.0 的较低 SDK 约束运行 dart pub get 会将包中每个库的默认语言版本设置为 2.12,从而使它们全部选择使用空安全。

  3. 在您的 IDE 中打开包。
    您可能会看到很多分析错误。没关系。

  4. 在您不想在当前迁移期间考虑的任何 Dart 文件顶部添加一个语言版本注释

    dart
    // @dart=2.9

    对 2.12 包中的库使用语言版本 2.9 可以减少来自未迁移代码的分析错误(红色波浪线)。但是,不健全的空安全会减少分析器可以使用的信息。例如,分析器可能会假设参数类型是非可空的,即使 2.9 文件可能会传入 null 值。

  5. 使用分析器识别静态错误,迁移每个 Dart 文件的代码。
    根据需要添加 ?!requiredlate,消除静态错误。

测试或运行混合版本程序

#

要测试或运行混合版本代码,您需要禁用健全的空安全。您可以通过两种方式执行此操作

  • 使用 --no-sound-null-safety 标志在 dartflutter 命令中禁用健全的空安全。

    $ dart --no-sound-null-safety run
    $ flutter run --no-sound-null-safety
  • 或者,将入口点(包含 main() 函数的文件)中的语言版本设置为 2.9。在 Flutter 应用中,此文件通常命名为 lib/main.dart。在命令行应用中,此文件通常命名为 bin/<packageName>.dart。您也可以选择退出 test 下的文件,因为它们也是入口点。示例:

    dart
    // @dart=2.9
    import 'src/my_app.dart';
    
    void main() {
      //...
    }

在增量迁移过程中,使用这些机制选择退出测试可能很有用,但这意味着您没有在启用完全空安全的情况下测试您的代码。当您完成库的增量迁移后,务必将您的测试重新启用空安全。