空安全：常见问题解答

此页面收集了一些我们根据迁移 Google 内部代码的经验听到的关于 空安全 的常见问题。

迁移的大多数影响不会立即影响迁移代码的用户

• 对于用户来说，静态空安全检查首先在他们迁移代码时应用。
• 当所有代码都迁移并且打开健全模式时，会进行完全的空安全检查。

需要注意的两个例外是

• ! 运算符是所有模式下所有用户的运行时空检查。因此，在迁移时，确保仅在null 流到该位置是错误时添加 !，即使调用代码尚未迁移。
• 与 late 关键字相关的运行时检查在所有模式下对所有用户都有效。只有当你确定在使用之前始终初始化字段时，才将其标记为 late。

如果一个值仅在测试中为 null，可以通过将其标记为非空并将测试通过非空值来改进代码。

@required 注释标记必须传递的命名参数；如果没有，分析器会报告一个提示。

使用空安全，具有非空类型的命名参数必须具有默认值或使用新的 required 关键字标记。否则，它不能是不可空的，因为它在没有传递时会默认为 null。

当空安全代码从遗留代码调用时，required 关键字与 @required 注释的处理方式完全相同：如果未提供参数，分析器会发出提示。

当空安全代码从空安全代码调用时，如果未提供 required 参数，则会发生错误。

这对于迁移意味着什么？如果在之前没有 @required 的情况下添加 required，请小心。任何没有传递新 required 参数的调用者将不再编译。相反，你可以添加一个默认值或使参数类型可空。

一些计算可以移到静态初始化器中。不要使用

// Initialized without values
ListQueue _context;
Float32List _buffer;
dynamic _readObject;

Vec2D(Map<String, dynamic> object) {
  _buffer = Float32List.fromList([0.0, 0.0]);
  _readObject = object['container'];
  _context = ListQueue<dynamic>();
}

你可以使用

// Initialized with values
final ListQueue _context = ListQueue<dynamic>();
final Float32List _buffer = Float32List.fromList([0.0, 0.0]);
final dynamic _readObject;

Vec2D(Map<String, dynamic> object) : _readObject = object['container'];

但是，如果一个字段是在构造函数中进行计算后初始化的，那么它不能是 final。使用空安全，你会发现这也会使它更难成为不可空的；如果初始化太晚，那么它在初始化之前是 null，并且必须是可空的。幸运的是，你有一些选择

• 将构造函数转换为工厂，然后使其委托给一个实际的构造函数，该构造函数直接初始化所有字段。这种私有构造函数的常用名称只是一个下划线：_。然后，该字段可以是 final 且不可空。这种重构可以在迁移到空安全之前完成。
• 或者，将字段标记为 late final。这强制它只初始化一次。它必须在读取之前初始化。

以前被注释为 @nullable 的 getter 应该具有可空类型；然后删除所有 @nullable 注释。例如

@nullable
int get count;

变为

int? get count; //  Variable initialized with ?

那些没有被标记为 @nullable 的 getter 应该不具有可空类型，即使迁移工具建议使用它们。根据需要添加 ! 提示，然后重新运行分析。

优先使用不返回 null 的工厂。我们看到过一些代码，这些代码原本打算由于输入无效而抛出异常，但最终却返回了 null。

不要使用

  factory StreamReader(dynamic data) {
    StreamReader reader;
    if (data is ByteData) {
      reader = BlockReader(data);
    } else if (data is Map) {
      reader = JSONBlockReader(data);
    }
    return reader;
  }

使用

  factory StreamReader(dynamic data) {
    if (data is ByteData) {
      // Move the readIndex forward for the binary reader.
      return BlockReader(data);
    } else if (data is Map) {
      return JSONBlockReader(data);
    } else {
      throw ArgumentError('Unexpected type for data');
    }
  }

如果工厂的意图确实是要返回 null，那么你可以将其转换为静态方法，这样它就可以返回 null。

当一切都完全迁移后，断言将变得不必要，但现在如果你真的想保留检查，它是必要的。一些选择

• 确定断言实际上并不必要，并将其删除。当断言启用时，这是一个行为改变。
• 确定断言可以始终检查，并将其转换为 ArgumentError.checkNotNull。当断言未启用时，这是一个行为改变。
• 保持行为不变：添加 // ignore: unnecessary_null_comparison 以绕过警告。

如果将 arg 设置为非空类型，编译器会将显式运行时空检查标记为不必要的比较。

if (arg == null) throw ArgumentError(...)`

如果程序是混合版本程序，则必须包含此检查。在所有内容完全迁移并代码切换到使用健全空安全运行之前，arg 可能被设置为 null。

保留行为最简单的方法是将检查更改为 ArgumentError.checkNotNull。

同样适用于一些运行时类型检查。如果 arg 的静态类型为 String，则 if (arg is! String) 实际上检查的是 arg 是否为 null。迁移到空安全可能看起来意味着 arg 永远不会是 null，但在不健全的空安全中它可能是 null。因此，为了保留行为，空检查应该保留。

导入 package:collection 并使用扩展方法 firstWhereOrNull 代替 firstWhere。

与上面的 late final 建议不同，这些属性不能标记为 final。通常，可设置属性也没有初始值，因为它们预计将在以后某个时间被设置。

在这种情况下，您有两个选择。

• 将其设置为初始值。很多时候，省略初始值是由于错误而不是故意。

• 如果您 *确定* 属性需要在访问之前设置，请将其标记为 late。

  警告：late 关键字添加了运行时检查。如果任何用户在 set 之前调用 get，他们将在运行时收到错误。

Map 上的 查找运算符 ([]) 默认情况下返回一个可空类型。无法向语言表明该值保证存在。

在这种情况下，应使用感叹号运算符 (!) 将值强制转换回 V

return blockTypes[key]!;

如果映射返回 null，这将抛出异常。如果您想为此情况进行显式处理

var result = blockTypes[key];
if (result != null) return result;
// Handle the null case here, e.g. throw with explanation.

以这种方式最终得到可空代码通常是一个代码异味

List<Foo?> fooList; // fooList can contain null values

这意味着 fooList 可能包含空值。如果您使用长度初始化列表并在循环中填充列表，则可能会发生这种情况。

如果您只是使用相同的值初始化列表，则应改用 filled 构造函数。

_jellyCounts = List<int?>(jellyMax + 1);
for (var i = 0; i <= jellyMax; i++) {
  _jellyCounts[i] = 0; // List initialized with the same value
}

_jellyCounts = List<int>.filled(jellyMax + 1, 0); // List initialized with filled constructor

如果您正在通过索引设置列表的元素，或者您正在用不同的值填充列表的每个元素，则应改用列表文字语法构建列表。

_jellyPoints = List<Vec2D?>(jellyMax + 1);
for (var i = 0; i <= jellyMax; i++) {
  _jellyPoints[i] = Vec2D(); // Each list element is a distinct Vec2D
}

_jellyPoints = [
  for (var i = 0; i <= jellyMax; i++)
    Vec2D() // Each list element is a distinct Vec2D
];

要生成固定长度的列表，请使用 List.generate 构造函数，并将 growable 参数设置为 false

_jellyPoints = List.generate(jellyMax, (_) => Vec2D(), growable: false);

您可能会遇到此错误

The default 'List' constructor isn't available when null safety is enabled. #default_list_constructor

默认列表构造函数使用 null 填充列表，这是一个问题。

将其更改为 List.filled(length, default)。

通过 ffi 发送的列表只能是 List<dynamic>，不能是 List<Object> 或 List<Object?>。如果您在迁移中没有显式更改列表类型，则类型可能仍然会发生更改，因为在启用空安全时，类型推断也会发生变化。

解决方法是显式创建 List<dynamic> 类型的列表。

迁移工具在看到在健全模式下运行时始终为 false 或 true 的条件时，会添加 /* == false */ 或 /* == true */ 注释。此类注释可能表明自动迁移不正确，需要人工干预。例如

if (registry.viewFactory(viewDescriptor.id) == null /* == false */)

在这些情况下，迁移工具无法区分防御性编码情况和确实期望空值的情况。因此，该工具会告诉您它知道的内容（“看起来此条件将始终为 false！”）并让您决定该怎么做。

空安全带来了许多好处，例如减少代码大小和提高应用程序性能。当编译为 Flutter 和 AOT 等原生目标时，这些好处会更加突出。以前在生产 Web 编译器方面的努力已经引入了类似于空安全后来引入的优化。这可能使生产 Web 应用程序的最终收益看起来不如它们的原生目标。

以下是一些值得注意的要点

• 生产 JavaScript 编译器会生成 ! 空断言。在比较编译器在添加空断言之前和之后输出时，您可能不会注意到它们。这是因为编译器已经为非空安全的程序生成了空检查。

• 编译器会生成这些空断言，无论空安全的健全性或优化级别如何。事实上，编译器在使用 -O3 或 --omit-implicit-checks 时不会删除 !。

• 生产 JavaScript 编译器可能会删除不必要的空检查。这是因为生产 Web 编译器在空安全之前进行的优化会在已知值为非空时删除这些检查。

• 默认情况下，编译器会生成参数子类型检查。这些运行时检查确保协变虚调用具有适当的参数。编译器会使用 --omit-implicit-checks 选项跳过这些检查。如果代码包含无效类型，则使用此选项可能会生成行为异常的应用程序。为了避免任何意外，请继续为您的代码提供强大的测试覆盖率。特别是，编译器根据输入应符合类型声明这一事实来优化代码。如果代码提供了无效类型的参数，这些优化将是错误的，并且程序可能会出现故障。这在以前对于不一致类型来说是正确的，现在对于具有健全空安全的代码来说也是如此，即使不一致的空类型也是如此。

• 您可能会注意到，开发 JavaScript 编译器和 Dart VM 对空检查有特殊的错误消息，但为了使应用程序更小，生产 JavaScript 编译器没有。

• 您可能会看到错误，指示在 null 上找不到 .toString。这不是错误。编译器一直以这种方式编码一些空检查。也就是说，编译器通过对接收器的属性进行无保护访问来紧凑地表示一些空检查。因此，它不会生成 if (a == null) throw，而是生成 a.toString。toString 方法是在 JavaScript 对象中定义的，是一种快速验证对象是否为 null 的方法。

  如果在空检查后的第一个操作是在值为空时会崩溃的操作，则编译器可以删除空检查并让该操作导致错误。

  例如，Dart 表达式 print(a!.foo()); 可以直接转换为

  js

    P.print(a.foo$0());

  这是因为如果 a 为 null，则调用 a.foo$() 将会崩溃。如果编译器内联 foo，它将保留空检查。因此，例如，如果 foo 是 int foo() => 1;，则编译器可能会生成

  js

    a.toString;
    P.print(1);

  如果内联方法首先访问接收器上的字段，例如 int foo() => this.x + 1;，那么生产编译器可以删除多余的 a.toString 空检查（因为非内联调用）并生成

  js

    P.print(a.x + 1);

• 带有空安全的 DartPad
• 健全的空安全

除非另有说明，否则本网站上的文档反映了 Dart 3.5.3。页面最后更新于 2024 年 2 月 7 日。 查看源代码 或 报告问题。