透過網際網路更新資料
對於大多數應用程式來說,透過網際網路更新資料是必要的。 http 套件已經幫你處理好了!
本教學將採用以下步驟:
- 新增
http套件。 - 使用
http套件透過網際網路更新資料。 - 將回應轉換為自訂的 Dart 物件。
- 從網際網路取得資料。
- 根據使用者輸入更新現有的
title。 - 更新並在螢幕上顯示回應。
1. 新增 http 套件
#若要將 http 套件加入為相依套件, 請執行 flutter pub add:
flutter pub add http匯入 http 套件。
import 'package:http/http.dart' as http;If you are deploying to Android, edit your AndroidManifest.xml file to add the Internet permission.
<!-- Required to fetch data from the internet. -->
<uses-permission android:name="android.permission.INTERNET" />Likewise, if you are deploying to macOS, edit your macos/Runner/DebugProfile.entitlements and macos/Runner/Release.entitlements files to include the network client entitlement.
<!-- Required to fetch data from the internet. -->
<key>com.apple.security.network.client</key>
<true/>2. 使用 http 套件透過網際網路更新資料
#本教學將說明如何使用 http.put() 方法,將專輯標題更新至 JSONPlaceholder。
Future<http.Response> updateAlbum(String title) {
return http.put(
Uri.parse('https://jsonplaceholder.typicode.com/albums/1'),
headers: <String, String>{
'Content-Type': 'application/json; charset=UTF-8',
},
body: jsonEncode(<String, String>{'title': title}),
);
}http.put() 方法會回傳一個包含 Response 的 Future。
Future是 Dart 的核心類別,用於處理非同步操作。Future物件代表一個未來某個時間點可能會取得的值或錯誤。http.Response類別包含從成功的 HTTP 呼叫中接收到的資料。updateAlbum()方法會接收一個參數title,該參數會傳送到伺服器以更新Album。
3. 將 http.Response 轉換為自訂 Dart 物件
#雖然發送網路請求很簡單,但直接處理原始的 Future<http.Response> 並不方便。為了讓開發更容易,建議將 http.Response 轉換成 Dart 物件。
建立 Album 類別
#首先,建立一個 Album 類別,用來存放從網路請求取得的資料。這個類別包含一個工廠建構子,可以從 JSON 建立 Album。
使用 pattern matching 轉換 JSON 只是其中一種方式。欲了解更多資訊,請參閱完整文章:JSON and serialization。
class Album {
final int id;
final String title;
const Album({required this.id, required this.title});
factory Album.fromJson(Map<String, dynamic> json) {
return switch (json) {
{'id': int id, 'title': String title} => Album(id: id, title: title),
_ => throw const FormatException('Failed to load album.'),
};
}
}將 http.Response 轉換為 Album
#現在,請依照以下步驟,將 updateAlbum() 函式更新為回傳 Future<Album>:
- 使用
dart:convert套件,將回應主體(response body)轉換為 JSONMap。 - 如果伺服器回傳狀態碼為 200 的
UPDATED回應,則使用fromJson()工廠方法,將 JSONMap轉換為Album。 - 如果伺服器未回傳狀態碼為 200 的
UPDATED回應,則拋出例外(exception)。 (即使伺服器回傳 "404 Not Found",也請拋出例外,不要回傳null。 這在檢查snapshot中的資料時非常重要,如下所示。)
Future<Album> updateAlbum(String title) async {
final response = await http.put(
Uri.parse('https://jsonplaceholder.typicode.com/albums/1'),
headers: <String, String>{
'Content-Type': 'application/json; charset=UTF-8',
},
body: jsonEncode(<String, String>{'title': title}),
);
if (response.statusCode == 200) {
// If the server did return a 200 OK response,
// then parse the JSON.
return Album.fromJson(jsonDecode(response.body) as Map<String, dynamic>);
} else {
// If the server did not return a 200 OK response,
// then throw an exception.
throw Exception('Failed to update album.');
}
}太棒了! 你現在已經有一個可以更新相簿名稱的函式了。
從網路取得資料
#在你能夠更新資料之前,必須先從網路取得資料。 完整範例請參考 Fetch data 教學。
Future<Album> fetchAlbum() async {
final response = await http.get(
Uri.parse('https://jsonplaceholder.typicode.com/albums/1'),
);
if (response.statusCode == 200) {
// If the server did return a 200 OK response,
// then parse the JSON.
return Album.fromJson(jsonDecode(response.body) as Map<String, dynamic>);
} else {
// If the server did not return a 200 OK response,
// then throw an exception.
throw Exception('Failed to load album');
}
}理想情況下,你會在initState期間使用此方法來設定_futureAlbum,以便從網路上擷取資料。
4. 根據使用者輸入更新現有標題
#建立一個TextField來輸入標題,以及一個ElevatedButton來更新伺服器上的資料。 同時定義一個TextEditingController,用於從TextField讀取使用者輸入。
當按下ElevatedButton時, _futureAlbum會被設定為 updateAlbum()方法所回傳的值。
Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
Padding(
padding: const EdgeInsets.all(8),
child: TextField(
controller: _controller,
decoration: const InputDecoration(hintText: 'Enter Title'),
),
),
ElevatedButton(
onPressed: () {
setState(() {
_futureAlbum = updateAlbum(_controller.text);
});
},
child: const Text('Update Data'),
),
],
);當按下 Update Data 按鈕時,會發送一個網路請求,將 TextField 中的資料以 PUT 請求的方式傳送到伺服器。_futureAlbum 變數會在下一步中使用。
5. 在螢幕上顯示回應
#若要在螢幕上顯示資料,請使用 FutureBuilder 元件 (Widget)。FutureBuilder 元件 (Widget) 是 Flutter 內建的元件,能讓你更輕鬆處理非同步資料來源。你必須提供兩個參數:
- 你想要處理的
Future。在本例中,為updateAlbum()函式所回傳的 future。 - 一個
builder函式,用來告訴 Flutter 根據Future的狀態(載入中、成功或錯誤)該渲染什麼內容。
請注意,snapshot.hasData 僅在 snapshot 包含非 null 資料值時才會回傳 true。這也是為什麼即使伺服器回應 "404 Not Found",updateAlbum 函式仍應該拋出例外。如果 updateAlbum 回傳 null,那麼 CircularProgressIndicator 將會無限顯示下去。
FutureBuilder<Album>(
future: _futureAlbum,
builder: (context, snapshot) {
if (snapshot.hasData) {
return Text(snapshot.data!.title);
} else if (snapshot.hasError) {
return Text('${snapshot.error}');
}
return const CircularProgressIndicator();
},
);完整範例
#import 'dart:async';
import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:http/http.dart' as http;
Future<Album> fetchAlbum() async {
final response = await http.get(
Uri.parse('https://jsonplaceholder.typicode.com/albums/1'),
);
if (response.statusCode == 200) {
// If the server did return a 200 OK response,
// then parse the JSON.
return Album.fromJson(jsonDecode(response.body) as Map<String, dynamic>);
} else {
// If the server did not return a 200 OK response,
// then throw an exception.
throw Exception('Failed to load album');
}
}
Future<Album> updateAlbum(String title) async {
final response = await http.put(
Uri.parse('https://jsonplaceholder.typicode.com/albums/1'),
headers: <String, String>{
'Content-Type': 'application/json; charset=UTF-8',
},
body: jsonEncode(<String, String>{'title': title}),
);
if (response.statusCode == 200) {
// If the server did return a 200 OK response,
// then parse the JSON.
return Album.fromJson(jsonDecode(response.body) as Map<String, dynamic>);
} else {
// If the server did not return a 200 OK response,
// then throw an exception.
throw Exception('Failed to update album.');
}
}
class Album {
final int id;
final String title;
const Album({required this.id, required this.title});
factory Album.fromJson(Map<String, dynamic> json) {
return switch (json) {
{'id': int id, 'title': String title} => Album(id: id, title: title),
_ => throw const FormatException('Failed to load album.'),
};
}
}
void main() {
runApp(const MyApp());
}
class MyApp extends StatefulWidget {
const MyApp({super.key});
@override
State<MyApp> createState() {
return _MyAppState();
}
}
class _MyAppState extends State<MyApp> {
final TextEditingController _controller = TextEditingController();
late Future<Album> _futureAlbum;
@override
void initState() {
super.initState();
_futureAlbum = fetchAlbum();
}
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Update Data Example',
theme: ThemeData(
colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
),
home: Scaffold(
appBar: AppBar(title: const Text('Update Data Example')),
body: Container(
alignment: Alignment.center,
padding: const EdgeInsets.all(8),
child: FutureBuilder<Album>(
future: _futureAlbum,
builder: (context, snapshot) {
if (snapshot.connectionState == ConnectionState.done) {
if (snapshot.hasData) {
return Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
Text(snapshot.data!.title),
TextField(
controller: _controller,
decoration: const InputDecoration(
hintText: 'Enter Title',
),
),
ElevatedButton(
onPressed: () {
setState(() {
_futureAlbum = updateAlbum(_controller.text);
});
},
child: const Text('Update Data'),
),
],
);
} else if (snapshot.hasError) {
return Text('${snapshot.error}');
}
}
return const CircularProgressIndicator();
},
),
),
),
);
}
}