Dart官網代碼實驗室:https://dart.dev/codelabs/async-await
重要説明:本博客基於Dart官網代碼實驗室,但並不是簡單的對官網文章進行翻譯,我會根據個人研發經驗,在覆蓋官網文章核心內容情況下,加入自己的一些擴展問題和問題演示和總結,包括名稱解釋、使用場景説明、代碼樣例覆蓋、最後完整的場景編程等。
啓蒙:錯誤的異步編程樣例
下面是一個錯誤的異步編程樣例,大概過程:通過模擬網絡API獲取訂單ID,然後組織訂單ID文案,最終輸出問題。
我們期望最終輸出的是正確的訂單ID文案,可結果並不符合我們的期望:訂單ID並不是T2023092900001,而是Instance of 'Future<String>'
// 1.1 創建訂單消息
String createOrderMessage() {
var order = fetchOrderID();
return '訂單ID: $order';
}
// 1.2 獲取訂單ID內容
Future<String> fetchOrderID() =>
// 假設獲取訂單ID是一次網絡交互,處理過程需要2秒鐘,因此模擬了2秒鐘返回訂單ID
Future.delayed(
const Duration(seconds: 2),
() => 'T2023092900001',
);
void main() {
// 1. 啓蒙:錯誤的異步編程樣例
final message = createOrderMessage();
print(message);
// 結果:訂單ID: Instance of 'Future<String>'
}
同步編程和異步編程説明:
- 同步編程:按照代碼塊順序執行代碼塊,前面代碼塊沒有執行完成之前,後面代碼被阻塞。
- 異步編程:異步操作代碼塊完成初始化之後,後面代碼塊就可以執行了(非阻塞),異步代碼塊執行完成(如上面樣例等待2秒鐘),執行完成回調代碼塊(即回調)。
Future異步結果説明
異步操作的結果都是Future類的實例(https://api.dart.cn/stable/3.1.3/dart-async/Future-class.html),異步操作有2種狀態:未完成和完成狀態。調用異步代碼塊(或函數),返回值都是未完成狀態的結果。
- 未完成狀態:調用一個異步函數,返回一個
Future<T>結果,在異步操作執行結束或者執行出錯之前的狀態。 - 完成狀態:異步操作執行結束正常返回結果或者執行出錯,都是完成狀態。正常完成的返回結果即
Futrue<T>的T(如:Future<String>),如果無需返回結果,則為void,即異步函數的返回值為Future<void>。如果異步函數執行出錯,則返回結果是一個Error,可以進行捕獲。
下面2個代碼樣例,分別為返回值為void和出錯結果:
// 2.1 異步操作無返回值
Future<void> fetchOrderID2() {
// 模擬了2秒鐘輸出了訂單ID
return Future.delayed(const Duration(seconds: 2), () => print('ID2:T2023092900002'));
}
// 2.2 異常操作返回錯誤
Future<void> fetchOrderID3() {
return Future.delayed(const Duration(seconds: 2), () => throw Exception('網絡異常'));
}
void main() {
// 2. Future/async/await異步結果説明
fetchOrderID2();
print('2. fetchOrderID2-Future/async/await異步結果説明...');
// 結果:
// 2. fetchOrderID2-Future/async/await異步結果説明...
// ID2:T2023092900002
fetchOrderID3();
print('2. fetchOrderID3-Future/async/await異步結果説明...');
// 結果:
// 2. fetchOrderID3-Future/async/await異步結果説明...
// Unhandled exception:
// Exception: 網絡異常
}
async/await異步操作定義和使用
async定義一個異步操作,而await則是使用一個異步操作的結果。
在應用async和await是,有2點需要遵守的基本規則:
- 如果需要定義一個異步函數,則在函數體之前增加async關鍵字
- 只有在異步函數中(即函數體前有async關鍵字的函數),await關鍵字才會生效(也就是await必須配合async使用)
定義一個異步函數方法樣例(即增加async關鍵字):
// 1. 同步函數轉異步函數:無返回結果
// 1.1 同步函數
void funcVoid() {}
// 1.2 異步返回
Future<void> funcVoid() async {}
// 2. 同步函數轉異步函數:有返回結果
// 2.1 同步函數
String funcResult() {}
// 2.2 異常函數
Future<String> funcResult() async {}
接下來,我們來重寫第1張中,異步函數代碼,以使結果符合我們預期:
- 獲取訂單ID函數
fetchOrderID()前,增加await關鍵字。 - 創建訂單消息的函數
createOrderMessageV2(),增加async關鍵字變成異步函數,同返回結果由String變成Future<String>異步結果。 - 同樣的,
main()函數調用了異步函數,因此也需要增加async關鍵字。
// 3. async/await異步操作定義和使用
Future<String> createOrderMessageV2() async {
var order = await fetchOrderID();
return '訂單ID: $order';
}
void main() async {
// 3. async/await異步操作定義和使用
final messageV2 = await createOrderMessageV2();
print('3. async/await異步操作定義和使用');
print('$messageV2');
// 結果:
// 3. async/await異步操作定義和使用
// 訂單ID: T2023092900001
}
try/catch異步操作的異常處理
在第2章節中,fetchOrderID3()異步方法會拋出異常,從而中斷程序處理。異步操作的異常,我們也可以和同步函數調用一樣,通過try-catch的方式進行處理。
下面我們把fetchOrderID3()使用的地方進行改寫,捕獲異常從而不中斷我們的程序:
void main() async {
// 4. try/catch異步操作的異常處理
try {
await fetchOrderID3();
print('4. try/catch異步操作的異常處理.');
} catch (e) {
print('4. try/catch異步操作的異常處理: $e');
}
// 結果:4. try/catch異步操作的異常處理: Exception: 網絡異常
}
場景編程:異步編程的大合唱
應用場景假設:對當前登錄的用户打個招呼,同時用户退出登錄。因為退出登錄操作可被降級,因此退出登錄需要捕獲所有異常。
- 獲取當前登錄的用户名,因為是網絡API操作,因此是異步操作。
- 退出登錄時,需要獲取當前緩存的用户名,設計到存儲操作,因此也是異步操作。
// 5.1 組裝用户歡迎語
String makeGreeting(String userName) {
return '歡迎你 $userName';
}
// 5.2 獲取用户名,異步操作
Future<String> fetchUserName() async {
return Future.delayed(const Duration(seconds: 2), () => 'NTopic.CN');
}
// 5.3 用户登錄-打聲招呼
Future<String> greeting() async {
final userName = await fetchUserName();
return makeGreeting(userName);
}
// 5.4 用户退出-再見
Future<String> goodbye() async {
final userName = await fetchUserName();
return '$userName 下次再見!';
}
void main() async {
// 5. 場景編程:異步編程的大合唱
print('5. 場景編程:異步編程的大合唱...');
print(await greeting());
try {
print(await goodbye());
} catch (e) {
print('5. 場景編程:異步編程的大合唱-Goodbye異常: $e');
}
// 結果:
// 5. 場景編程:異步編程的大合唱...
// 歡迎你 NTopic.CN
// NTopic.CN 下次再見!
}
最後-完整的實例代碼
本文介紹的完整的實例代碼:
// 第04天:異步編程
// 1.1 創建訂單消息
String createOrderMessage() {
var order = fetchOrderID();
return '訂單ID: $order';
}
// 1.2 獲取訂單ID內容
Future<String> fetchOrderID() =>
// 假設獲取訂單ID是一次網絡交互,處理過程需要2秒鐘,因此模擬了2秒鐘返回訂單ID
Future.delayed(
const Duration(seconds: 2),
() => 'T2023092900001',
);
// 2.1 異步操作無返回值
Future<void> fetchOrderID2() {
// 模擬了2秒鐘輸出了訂單ID
return Future.delayed(const Duration(seconds: 2), () => print('ID2:T2023092900002'));
}
// 2.2 異常操作返回錯誤
Future<void> fetchOrderID3() {
return Future.delayed(const Duration(seconds: 2), () => throw Exception('網絡異常'));
}
// 3. async/await異步操作定義和使用
Future<String> createOrderMessageV2() async {
var order = await fetchOrderID();
return '訂單ID: $order';
}
// 5.1 組裝用户歡迎語
String makeGreeting(String userName) {
return '歡迎你 $userName';
}
// 5.2 獲取用户名,異步操作
Future<String> fetchUserName() async {
return Future.delayed(const Duration(seconds: 2), () => 'NTopic.CN');
}
// 5.3 用户登錄-打聲招呼
Future<String> greeting() async {
final userName = await fetchUserName();
return makeGreeting(userName);
}
// 5.4 用户退出-再見
Future<String> goodbye() async {
final userName = await fetchUserName();
return '$userName 下次再見!';
}
void main() async {
// 1. 啓蒙:錯誤的異步編程樣例
final message = createOrderMessage();
print(message);
// 2. Future/async/await異步結果説明
fetchOrderID2();
print('2. fetchOrderID2-Future/async/await異步結果説明...');
// fetchOrderID3();
print('2. fetchOrderID3-Future/async/await異步結果説明...');
// 3. async/await異步操作定義和使用
final messageV2 = await createOrderMessageV2();
print('3. async/await異步操作定義和使用');
print('$messageV2');
// 4. try/catch異步操作的異常處理
try {
await fetchOrderID3();
print('4. try/catch異步操作的異常處理.');
} catch (e) {
print('4. try/catch異步操作的異常處理: $e');
}
// 5. 場景編程:異步編程的大合唱
print('5. 場景編程:異步編程的大合唱...');
print(await greeting());
try {
print(await goodbye());
} catch (e) {
print('5. 場景編程:異步編程的大合唱-Goodbye異常: $e');
}
}
我的本博客原地址:https://ntopic.cn/p/2023092901