空安全：常见问题

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

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

• 用户的静态空安全检查首先在他们迁移代码时应用。
• 当所有代码都迁移并且启用健全模式时，会发生完整的空安全检查。

需要注意的两个例外是

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

如果一个值只在测试中为 null，则可以通过将其标记为不可为空并使测试传递不可为空的值来改进代码。

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

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

当从旧代码调用空安全代码时，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]!;

如果 map 返回 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。这不是一个错误。编译器一直以这种方式编码一些空检查。也就是说，编译器通过对接收者的属性进行无保护访问来紧凑地表示一些空检查。因此，它生成 a.toString 而不是 if (a == null) throw。toString 方法在 JavaScript Object 中定义，并且是验证对象是否为空的快速方法。

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

  例如，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.6.0。页面最后更新于 2024-11-17。 查看源代码 或 报告问题。