-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
105 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
--- | ||
title: Error handling | ||
description: Error handling best practices. | ||
--- | ||
|
||
## Document when a call may throw | ||
|
||
Inform about the potential risks associated with calling a function, helping understand under what conditions an exception might be thrown. | ||
|
||
This transparency allows developers to handle exceptions properly, leading to more robust and error-resistant code. Thus, reducing the likelihood of unintended errors. | ||
|
||
<Tabs> | ||
<TabItem label="Good ✅"> | ||
|
||
```dart | ||
/// Deletes permanenetly an account with the given [name]. | ||
/// | ||
/// Throws: | ||
/// | ||
/// * [UnothorizedException] if the active role is not [Role.admin], since only | ||
/// admins are authorized to delete accounts. | ||
void deleteAccount(String name) { | ||
if (activeRole != Role.admin) { | ||
throw UnothorizedException('Only admin can delete account'); | ||
} | ||
// ... | ||
} | ||
``` | ||
|
||
</TabItem> | ||
<TabItem label="Bad ❗️"> | ||
|
||
```dart | ||
/// Deletes permanenetly an account with the given [name]. | ||
void deleteAccount(String name) { | ||
if (activeRole != Role.admin) { | ||
throw UnothorizedException('Only admin can delete account'); | ||
} | ||
// ... | ||
} | ||
``` | ||
|
||
</TabItem> | ||
</Tabs> | ||
|
||
## Define implemented exceptions | ||
|
||
Implement `Exception` with descriptive names rather than simply throwing a generic `Exception`. | ||
|
||
By creating custom exceptions, developers can provide more meaningful error messages and handle different error types in a more granular way. This enhances code readability and maintainability, as it becomes clear what type of error is being dealt with. | ||
|
||
<Tabs> | ||
<TabItem label="Good ✅"> | ||
|
||
```dart | ||
class UnothorizedException implements Exception { | ||
UnothorizedException(this.message); | ||
final String message; | ||
@override | ||
String toString() => 'UnothorizedException: $message'; | ||
} | ||
void deleteAccount(String name) { | ||
if (activeRole != Role.admin) { | ||
throw UnothorizedException('Only admin can delete account'); | ||
} | ||
// ... | ||
} | ||
void main() { | ||
try { | ||
deleteAccount('user'); | ||
} on UnothorizedException catch (e) { | ||
// Handle the exception. | ||
} | ||
} | ||
``` | ||
|
||
</TabItem> | ||
<TabItem label="Bad ❗️"> | ||
|
||
```dart | ||
void deleteAccount(String name) { | ||
if (activeRole != Role.admin) { | ||
throw Exception('Only admin can delete account'); | ||
} | ||
// ... | ||
} | ||
void main() { | ||
try { | ||
deleteAccount('user'); | ||
} on Exception catch (e) { | ||
// Exception is a marker interface implemented by all core library exceptions, | ||
// it is very generic and it could be catching many different types of exceptions, | ||
// lacking intent and making the code harder to understand. | ||
} | ||
} | ||
``` | ||
|
||
</TabItem> | ||
</Tabs> |