内容

空安全性:常见问题解答

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

对于已迁移代码的用户,我应该注意哪些运行时更改?

#

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

  • 用户在迁移代码时首先应用静态空安全检查。
  • 当所有代码都迁移并且开启了严格模式时,会进行完全的空安全检查。

需要注意的两个例外是

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

如果一个值仅在测试中为 null 怎么办?

#

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

@required 与新的 required 关键字相比如何?

#

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

使用空安全,具有非空类型且带默认值或用新 required 关键字标记的命名参数。否则,它是非空的就没有意义,因为它在未传递时会默认为 null

当从旧代码中调用空安全代码时,required 关键字的处理方式与 @required 注释完全相同:未提供参数会导致分析器提示。

当从空安全代码中调用空安全代码时,未提供 required 参数会引发错误。

这对迁移意味着什么?在以前没有 @required 的地方添加 required 时要小心。任何不传递新 required 参数的调用方都将无法再编译。相反,你可以添加默认值或使参数类型可空。

我应该如何迁移应该为 final 但不是的非空字段?

#

某些计算可以移至静态初始化程序。不要

baddart
// 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>();
}

你可以

gooddart
// 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。这强制它只初始化一次。在读取之前必须初始化它。

我应该如何迁移 built_value 类?

#

注释为 @nullable 的 getter 应具有可空类型;然后删除所有 @nullable 注释。例如

dart
@nullable
int get count;

变成

dart
int? get count; //  Variable initialized with ?

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

我应该如何迁移可以返回 null 的工厂?

#

优先选择不返回 null 的工厂。我们已经看到由于无效输入而打算抛出异常但最终返回 null 的代码。

不要

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

执行

gooddart
  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

我应该如何迁移现在显示为不必要的 assert(x != null)

#

当一切都完全迁移后,断言将是不必要的,但如果你确实想保留检查,那么现在需要的。选项

  • 决定断言实际上不是必需的,并将其移除。当启用断言时,这是行为上的改变。
  • 决定断言可以始终被检查,并将其转换为 ArgumentError.checkNotNull。当断言未启用时,这是行为上的改变。
  • 保持行为完全不变:添加 // ignore: unnecessary_null_comparison 以绕过警告。

我应该如何迁移一个运行时 null 检查,它现在显示为不必要?

#

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

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

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

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

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

Iterable.firstWhere 方法不再接受 orElse: () => null

#

导入 package:collection 并使用扩展方法 firstWhereOrNull 而不是 firstWhere

我如何处理具有 setter 的属性?

#

与上述 late final 建议不同,这些属性不能标记为 final。通常,可设置属性也没有初始值,因为它们预期稍后设置。

在这种情况下,你有两个选择

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

  • 如果你确定属性在访问之前需要设置,则将其标记为 late

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

我如何表示 Map 的返回值是非空的?

#

Map 上的 查找运算符[])默认返回一个可空类型。没有办法向语言发出信号,表明该值必定存在。

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

dart
return blockTypes[key]!;

如果映射返回 null,它将抛出异常。如果你想要对该情况进行显式处理

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

为什么我的 List/Map 上的泛型类型是可空的?

#

最终得到像这样的可空代码通常是一种代码异味

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

这意味着 fooList 可能包含 null 值。如果你使用长度初始化列表并通过循环填充它,则可能会发生这种情况。

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

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

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

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

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

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

默认的 List 构造器发生了什么?

#

您可能会遇到此错误

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

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

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

我正在使用 package:ffi,并且在迁移时遇到 Dart_CObject_kUnsupported 失败。发生了什么事?

#

通过 ffi 发送的列表只能是 List<dynamic>,而不是 List<Object>List<Object?>。如果您没有在迁移中明确更改列表类型,则由于启用空安全时发生类型推断的更改,类型可能仍然会发生更改。

解决方法是将此类列表明确创建为 List<dynamic>

为什么迁移工具会向我的代码添加注释?

#

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

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

在这些情况下,迁移工具无法区分防御性编码情况和确实预期空值的情况。因此,该工具会告诉您它所了解的信息(“看起来此条件始终为 false!”),并让您决定要做什么。

我应该了解有关编译到 JavaScript 和空安全性的哪些知识?

#

空安全带来了许多好处,例如减少代码大小和提高应用性能。当编译为 Flutter 和 AOT 等本机目标时,此类好处会更加明显。之前对生产 Web 编译器所做的工作已经引入了类似于空安全后来引入的优化。这可能会使生成的生产 Web 应用的收益看起来低于其本机目标。

值得强调的几点说明

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

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

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

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

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

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

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

    例如,Dart 表达式 print(a!.foo()); 可以直接变成

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

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

    js
      a.toString;
      P.print(1);

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

    js
      P.print(a.x + 1);

资源

#