前言
当程序运行过程中发生错误的时候,Dart 会抛出异常。在 Dart 中使用了on ... catch 方式来捕获指定类型的异常,例如:
class Person {
late String name;
late int age;
Person(this.name, this.age);
Person.fromJson(Map<String, dynamic> json) {
name = json['name'];
age = json['age'];
}
}
// 这里只是演示on...catch,实际上不应该捕获 Error
void main() {
try {
var person = Person.fromJson({'name': 'Jack'});
print(person);
} on TypeError catch (e, s) {
print('Error: $e, Stack: $s');
}
}
这种方式的好处就是能够明确可能发生的错误类型,做到精准捕获,从而更容易定位问题发生的原因。本篇来介绍 Dart 错误和异常处理的规范。
规则1:尽可能地使用 on 语句
上面的例子,其实我们写成下面的形式也能够正常捕获异常。
// 错误示例
void main() {
try {
var person = Person.fromJson({'name': 'Jack'});
print(person);
} catch (e, s) {
print('Error: $e, Stack: $s');
}
}
这种方式称之为“宝可梦式异常处理”(Pokémon Exception Handling)。这样一方面是对特定错误做特定处理,例如 StackOverflowError
或 OutOfMemoryError
。或者是当调用方法传错参数后,准确捕获 ArgumentError
的话能够帮助我们快速定位问题。
在大多数情况下,应该使用 on...catch 的方式来限制我们编程的时候的错误类型,这样会清楚地提醒我们有哪些可能的错误,以及如何正确地处理它们。
极少数情况下,可能会需要捕获任何运行时错误。这对于框架设计或底层代码为了避免应用程序出现问题来说会有用。即便是这样,指定捕获 Exception
也比捕获全部类型要好。Exception
是所有运行时错误的基类,但不包括那些代码中指明程序 bug 的错误。
假设你真的需要捕获某个代码片段的所有异常的话,那么捕获后应该做一些处理,比如记录运行日志,上报错误,向用户显示错误信息或重新抛出错误,而不是静默地处理掉 —— 那样 bug 就也被静默处理了!
规则2:只对程序化错误(bug)抛出 Error 的子类
Error
类是用于抛出程序化错误的基类。当一个 Error
的对象或其子类对象抛出时,意味着代码中存在 bug。当你的 API 想要告知调用者他的调用方式是错误的时候,抛出一个 Error
能够清晰地告诉调用者错误所在。
相反地,如果是一个运行时错误而不是代码的 bug 的话,那样抛出错误其实是一个误导。这个时候,应该抛出系统的异常类对象或其他类型对象。
规则3:不要直接捕获 Error 或它的子类
这是因为 Error 代表的是代码错误,当错误发生的时候,我们应该查看整个调用堆栈,暂停程序,然后打印堆栈信息来定位和修复 bug。如果捕获这些错误的话,会打断进执行过程,隐藏 bug。相比增加错误处理代码,更应该做的是查看对应代码,并在错误一开始发生的地方修复它。
规则4:使用 rethrow 抛出捕获的异常
如果要将捕获的异常抛出,那么应该优先使用 rethrow
语句,而不是使用 throw
抛出同一个异常对象。这是因为rethrow
会保留原异常的堆栈信息,而 throw 会重置堆栈信息到最近一个抛出点。
// 正确示例
try {
somethingRisky();
} catch (e) {
if (!canHandle(e)) rethrow;
handle(e);
}
// 错误示例
try {
somethingRisky();
} catch (e) {
if (!canHandle(e)) throw e;
handle(e);
}
异常(Exception)和错误(Error)的区别
异常在 Dart 中是被认为是常规的,预期运行过程中可能发生的,而且应该被捕获的问题。也就是说,这种问题我们无法避免,举个例子,网络请求超时、数据不存在就属于典型的异常,这个时候我们应该捕获这个异常,并且应该提示用户有用的信息,以引导用户完成后续操作。
错误在 Dart 中是意料之外的,不应该被捕获而应该有程序员修复解决的问题。典型的例子包括了类型错误(TypeError),这个在接收后端参数时经常发生,比如Dart 定义的是整型,结果后端返回的是字符串就会报下面的错误:
type 'String' is not a subtype of type 'int'
这种就属于程序员制造的 bug,应该有由程序员搞定,而不是通过异常捕获解决。
总结
Dart 对程序运行问题做了两种区分,一种是非人为,运行过程可能发生的问题,即 Exception;另一种是人为的,不应该发生的问题,即 Error。这两种处理方式是不同的,错误不应该捕获,而应该暴露出来以便修复。同时,捕获异常的时候最好是使用 on...catch 形式,以便清晰地知道有哪些异常,以及如何处理。对于需要重新抛出异常,应该优先使用 rethrow 来操作以保持堆栈信息。