Tutorial 8: Flutter Networking, Authentication, and Integration
Pemrograman Berbasis Platform (CSGE602022) — diselenggarakan oleh Fakultas Ilmu Komputer Universitas Indonesia, Semester Genap 2023/2024
Tujuan Pembelajaran
Setelah menyelesaikan tutorial ini, mahasiswa diharapkan untuk dapat:
- Memahami struktur dan pembuatan model pada Flutter.
- Memahami cara mengambil, mengolah, dan menampilkan data dari web service.
- Memahami state management dasar menggunakan Provider pada Flutter.
- Dapat melakukan autentikasi dengan web service Django dengan aplikasi Flutter.
Model pada Flutter
Pada tutorial kali ini, kita akan memanggil web service dan menampilkan hasil yang didapatkan ke halaman Flutter yang kita buat. Akan tetapi, sebelum melakukan pemanggilan web service, kita perlu mendefinisikan model yang akan kita gunakan ketika melakukan pemanggilan web service. Model pada Flutter menggunakan prinsip class seperti layaknya yang sudah dipelajari pada DDP2 bagian OOP.
Kode di bawah ini adalah contoh, tidak wajib diikuti, tetapi sangat disarankan dibaca karena konsepnya akan digunakan pada bagian-bagian selanjutnya.
Berikut merupakan contoh class pada Flutter.
class Mobil {
Mobil({
this.id,
this.brand,
this.model
this.color
});
int id;
String brand;
String model;
String color;
}
Catatan: Jika kamu mengalami error saat membuat class, tambahkan keyword required
pada setiap parameter class pada bagian constructor.
Sampai saat ini, kita telah berhasil membuat class. Selanjutnya, kita akan menambahkan beberapa kode sehingga terbentuk sebuah model Mobil
. Mobil
ini merupakan suatu model yang merepresentasikan respons dari pemanggilan web service.
Import dart:convert
pada bagian paling atas file.
Pada class Mobil
, tambahkan kode berikut.
factory Mobil.fromJson(Map<String, dynamic> json) => Mobil(
id: json["id"],
brand: json["brand"],
model: json["model"],
color: json["color"],
);
Map<String, dynamic> toJson() => {
"id": id,
"brand": brand,
"model": model,
"color": color,
};
Tambahkan kode berikut di luar class Mobil
.
Mobil mobilFromJson(String str) => Mobil.fromJson(json.decode(str));
String mobilToJson(Mobil data) => json.encode(data.toJson());
Pada akhirnya, kode akan terbentuk seperti berikut untuk menampilkan satu objek Mobil
dari web service.
import 'dart:convert';
Mobil mobilFromJson(String str) => Mobil.fromJson(json.decode(str));
String mobilToJson(Mobil data) => json.encode(data.toJson());
class Mobil {
Mobil({
this.id,
this.brand,
this.model,
this.color,
});
int id;
String brand;
String model;
String color;
factory Mobil.fromJson(Map<String, dynamic> json) => Mobil(
id: json["id"],
brand: json["brand"],
model: json["model"],
color: json["color"],
);
Map<String, dynamic> toJson() => {
"id": id,
"brand": brand,
"model": model,
"color": color,
};
}
Penjelasan
Terdapat beberapa kode-kode tambahan seperti method toJson
dan fromJson
di dalam class Mobil
. Hal tersebut disebabkan ketika kita me-request suatu web service dengan method GET, umumnya kita mendapatkan hasil pemanggilan berupa JSON. Oleh karena itu, kita perlu melakukan konversi data dengan method fromJson
agar Flutter mengenali JSON tersebut sebagai objek class Mobil
. Selain itu, terdapat juga method toJson
yang akan digunakan ketika kita melakukan pengiriman data ke web service (seperti POST atau PUT).
Berikut adalah contoh respons dari web service dengan method GET yang dapat dikonversi ke class model Mobil
.
Lalu, bagaimana jika respons dari web service berupa kumpulan objek JSON? Sebenarnya sama saja dengan kode di atas, hanya saja terdapat pengubahan pada method mobilFromJson
dan mobilToJson
.
Kodenya adalah sebagai berikut.
List<Mobil> mobilFromJson(String str) => List<Mobil>.from(json.decode(str).map((mobil) => Mobil.fromJson(mobil)));
String mobilToJson(List<Mobil> data) => json.encode(List<dynamic>.from(data.map((mobil) => mobil.toJson())));
Berikut adalah contoh respons dari web service dengan method GET yang dapat dikonversi ke model Mobil
.
[
{
"id": 1,
"brand": "Honda",
"model": "Civic",
"color": "Yellow"
},
{
"id": 2,
"brand": "Toyota",
"model": "Supra",
"color": "Red"
}
]
Fetch Data dari Web Service pada Flutter
Pada saat pengembangan aplikasi, ada kalanya kita perlu mengambil data eksternal dari luar aplikasi kita (Internet) untuk ditampilkan di aplikasi kita. Tutorial ini bertujuan untuk memahami cara melakukan fetching data dari sebuah web service pada Flutter.
Secara umum terdapat beberapa langkah ketika ingin menampilkan data dari web service lain ke aplikasi Flutter, yaitu:
-
Menambahkan dependensi
http
ke proyek; dependensi ini digunakan untuk bertukar HTTP request. -
Membuat model sesuai dengan respons dari data yang berasal dari web service tersebut.
-
Membuat http request ke web service menggunakan dependensi
http
. -
Mengkonversikan objek yang didapatkan dari web service ke model yang telah kita buat di langkah kedua.
-
Menampilkan data yang telah dikonversi ke aplikasi dengan
FutureBuilder
.
Penjelasan lebih lanjut dapat dibaca pada tautan berikut: http://docs.flutter.dev/cookbook/networking/fetch-data#5-display-the-data.
State Management Dasar menggunakan Provider
Provider
adalah sebuah pembungkus di sekitar InheritedWidget
agar InheritedWidget
lebih mudah digunakan dan lebih dapat digunakan kembali. InheritedWidget
sendiri adalah kelas dasar untuk widget Flutter yang secara efisien menyebarkan informasi ke widget lainnya yang berada pada satu tree.
Manfaat menggunakan provider
adalah sebagai berikut.
- Mengalokasikan resource menjadi lebih sederhana.
- Lazy-loading.
- Mengurangi boilerplate tiap kali membuat class baru.
- Didukung oleh Flutter Devtool sehingga
provider
dapat dilacak dari Devtool. - Peningkatan skalabilitas untuk class yang memanfaatkan mekanisme listen yang dibangun secara kompleks.
Untuk mengetahui provider
secara lebih lanjut, silakan buka halaman package Provider: http://pub.dev/packages/provider
Tutorial: Integrasi Autentikasi Django-Flutter
Setup Autentikasi pada Django untuk Flutter
Ikuti langkah-langkah berikut untuk melakukan integrasi sistem autentikasi pada Django.
-
Buatlah
django-app
bernamaauthentication
pada project Django yang telah kamu buat sebelumnya. -
Tambahkan
authentication
keINSTALLED_APPS
pada main projectsettings.py
aplikasi Django kamu.Hint: Apabila lupa cara untuk langkah 1 dan 2, coba baca lagi Tutorial 1.
-
Jalankan perintah
pip install django-cors-headers
untuk menginstal library yang dibutuhkan. Jangan lupa untuk menyalakan virtual environment Python terlebih dahulu. -
Tambahkan
corsheaders
keINSTALLED_APPS
pada main projectsettings.py
aplikasi Django kamu. -
Tambahkan
corsheaders.middleware.CorsMiddleware
pada main projectsettings.py
aplikasi Django kamu. -
Tambahkan beberapa variabel berikut ini pada main project
settings.py
aplikasi Django kamu. -
Buatlah sebuah metode view untuk login pada
authentication/views.py
.from django.contrib.auth import authenticate, login as auth_login from django.http import JsonResponse from django.views.decorators.csrf import csrf_exempt @csrf_exempt def login(request): username = request.POST['username'] password = request.POST['password'] user = authenticate(username=username, password=password) if user is not None: if user.is_active: auth_login(request, user) # Status login sukses. return JsonResponse({ "username": user.username, "status": True, "message": "Login sukses!" # Tambahkan data lainnya jika ingin mengirim data ke Flutter. }, status=200) else: return JsonResponse({ "status": False, "message": "Login gagal, akun dinonaktifkan." }, status=401) else: return JsonResponse({ "status": False, "message": "Login gagal, periksa kembali email atau kata sandi." }, status=401)
-
Buat file
urls.py
pada folderauthentication
dan tambahkan URL routing terhadap fungsi yang sudah dibuat dengan endpointlogin/
. -
Terakhir, tambahkan
path('auth/', include('authentication.urls')),
pada filebook_tracker/urls.py
.
Integrasi Sistem Autentikasi pada Flutter
Untuk memudahkan pembuatan sistem autentikasi, tim asisten dosen telah membuatkan package Flutter yang dapat dipakai untuk melakukan kontak dengan web service Django (termasuk operasi GET
dan POST
).
Package dapat diakses melalui tautan berikut: pbp_django_auth
Ikuti langkah-langkah berikut untuk melakukan integrasi sistem autentikasi pada Flutter.
-
Instal package yang telah disediakan oleh tim asisten dosen dengan menjalankan perintah berikut di Terminal. Jalankan pada direktori root dari proyek Flutter kamu.
-
Untuk menggunakan package tersebut, kamu perlu memodifikasi root widget untuk menyediakan
CookieRequest
library ke semua child widgets dengan menggunakanProvider
.Sebagai contoh, jika aplikasimu sebelumnya seperti ini:
class MyApp extends StatelessWidget { const MyApp({Key? key}) : super(key: key); @override Widget build(BuildContext context) { return MaterialApp( title: 'Flutter App', theme: ThemeData( colorScheme: ColorScheme.fromSeed(seedColor: Colors.indigo), useMaterial3: true, ), home: MyHomePage(), ); } }
Ubahlah menjadi:
class MyApp extends StatelessWidget { const MyApp({Key? key}) : super(key: key); @override Widget build(BuildContext context) { return Provider( create: (_) { CookieRequest request = CookieRequest(); return request; }, child: MaterialApp( title: 'Flutter App', theme: ThemeData( colorScheme: ColorScheme.fromSeed(seedColor: Colors.indigo), useMaterial3: true, ), home: MyHomePage(), ), ); } }
Hal ini akan membuat objek
Provider
baru yang akan membagikan instanceCookieRequest
dengan semua komponen yang ada di aplikasi. -
Buatlah berkas baru pada folder
screens
dengan namalogin.dart
. -
Isilah berkas
login.dart
dengan kode berikut.import 'package:book_tracker/screens/menu.dart'; import 'package:flutter/material.dart'; import 'package:pbp_django_auth/pbp_django_auth.dart'; import 'package:provider/provider.dart'; void main() { runApp(const LoginApp()); } class LoginApp extends StatelessWidget { const LoginApp({super.key}); @override Widget build(BuildContext context) { return MaterialApp( title: 'Login', theme: ThemeData( primarySwatch: Colors.blue, ), home: const LoginPage(), ); } } class LoginPage extends StatefulWidget { const LoginPage({super.key}); @override State<LoginPage> createState() => _LoginPageState(); } class _LoginPageState extends State<LoginPage> { final TextEditingController _usernameController = TextEditingController(); final TextEditingController _passwordController = TextEditingController(); @override Widget build(BuildContext context) { final request = context.watch<CookieRequest>(); return Scaffold( appBar: AppBar( title: const Text('Login'), ), body: Container( padding: const EdgeInsets.all(16.0), child: Column( mainAxisAlignment: MainAxisAlignment.center, children: [ TextField( controller: _usernameController, decoration: const InputDecoration( labelText: 'Username', ), ), const SizedBox(height: 12.0), TextField( controller: _passwordController, decoration: const InputDecoration( labelText: 'Password', ), obscureText: true, ), const SizedBox(height: 24.0), ElevatedButton( onPressed: () async { String username = _usernameController.text; String password = _passwordController.text; // Cek kredensial // TODO: Ganti URL dan jangan lupa tambahkan trailing slash (/) di akhir URL! // Untuk menyambungkan Android emulator dengan Django pada localhost, // gunakan URL http://10.0.2.2/ final response = await request.login("http://<APP_URL_KAMU>/auth/login/", { 'username': username, 'password': password, }); if (request.loggedIn) { String message = response['message']; String uname = response['username']; if (context.mounted) { Navigator.pushReplacement( context, MaterialPageRoute(builder: (context) => MyHomePage()), ); ScaffoldMessenger.of(context) ..hideCurrentSnackBar() ..showSnackBar( SnackBar(content: Text("$message Selamat datang, $uname."))); } } else { if (context.mounted) { showDialog( context: context, builder: (context) => AlertDialog( title: const Text('Login Gagal'), content: Text(response['message']), actions: [ TextButton( child: const Text('OK'), onPressed: () { Navigator.pop(context); }, ), ], ), ); } } }, child: const Text('Login'), ), ], ), ), ); } }
-
Pada file
main.dart
, pada WidgetMaterialApp(...)
, ubahhome: MyHomePage()
menjadihome: LoginPage()
-
Jalankan aplikasi Flutter kamu dan cobalah untuk login.
Pembuatan Model Kustom
Dalam membuat model yang menyesuaikan dengan data JSON, kita dapat memanfaatkan website Quicktype dengan tahapan sebagai berikut.
-
Bukalah endpoint
JSON
yang sudah kamu buat sebelumnya pada tutorial 2. -
Salinlah data
JSON
dan buka situs web Quicktype. -
Pada situs web Quicktype, ubahlah setup name menjadi
Book
, source type menjadiJSON
, dan language menjadiDart
. -
Tempel data JSON yang telah disalin sebelumnya ke dalam textbox yang tersedia pada Quicktype.
-
Klik pilihan
Copy Code
pada Quicktype.Berikut adalah contoh hasilnya.
Setelah mendapatkan kode model melalui Quicktype, buka kembali proyek Flutter dan buatlah folder baru models/
pada subdirektori lib/
. Buatlah file baru pada folder tersebut dengan nama book.dart
, dan tempel kode yang sudah disalin dari Quicktype.
Penerapan Fetch Data dari Django Untuk Ditampilkan ke Flutter
Menambahkan Dependensi HTTP
Untuk melakukan perintah HTTP request, kita membutuhkan package tambahan yakni package http.
-
Lakukan
flutter pub add http
pada terminal proyek Flutter untuk menambahkan packagehttp
. -
Pada file
android/app/src/main/AndroidManifest.xml
, tambahkan kode berikut untuk memperbolehkan akses Internet pada aplikasi Flutter yang sedang dibuat.
Melakukan Fetch Data dari Django
-
Buatlah berkas baru pada direktori
lib/screens
dengan namalist_book.dart
. -
Pada file
list_book.dart
, impor library yang dibutuhkan. Ubahlahsesuai dengan nama proyek Flutter yang kalian buat. -
Salinlah potongan kode berikut dan paste pada
list_book.dart
. Jangan lupa untuk mengimpor file atau modul yang diperlukan.... import 'package:<APP_NAME>/widgets/left_drawer.dart'; class BookPage extends StatefulWidget { const BookPage({Key? key}) : super(key: key); @override State<BookPage> createState() => _BookPageState(); } class _BookPageState extends State<BookPage> { Future<List<Book>> fetchBook() async { // TODO: Ganti URL dan jangan lupa tambahkan trailing slash (/) di akhir URL! var url = Uri.parse( 'http://<URL_APP_KAMU>/json/'); var response = await http.get( url, headers: {"Content-Type": "application/json"}, ); // melakukan decode response menjadi bentuk json var data = jsonDecode(utf8.decode(response.bodyBytes)); // melakukan konversi data json menjadi object Book List<Book> listBook = []; for (var d in data) { if (d != null) { listBook.add(Book.fromJson(d)); } } return listBook; } @override Widget build(BuildContext context) { return Scaffold( appBar: AppBar( title: const Text('Book'), ), drawer: const LeftDrawer(), body: FutureBuilder( future: fetchBook(), builder: (context, AsyncSnapshot snapshot) { if (snapshot.data == null) { return const Center(child: CircularProgressIndicator()); } else { if (!snapshot.hasData) { return const Column( children: [ Text( "Tidak ada data buku.", style: TextStyle( color: Color(0xff59A5D8), fontSize: 20 ), ), SizedBox(height: 8), ], ); } else { return ListView.builder( itemCount: snapshot.data!.length, itemBuilder: (_, index) => Container( margin: const EdgeInsets.symmetric( horizontal: 16, vertical: 12 ), padding: const EdgeInsets.all(20.0), child: Column( mainAxisAlignment: MainAxisAlignment.start, crossAxisAlignment: CrossAxisAlignment.start, children: [ Text( "${snapshot.data![index].fields.name}", style: const TextStyle( fontSize: 18.0, fontWeight: FontWeight.bold, ), ), const SizedBox(height: 10), Text("${snapshot.data![index].fields.page}"), const SizedBox(height: 10), Text("${snapshot.data![index].fields.description}") ], ), ), ); } } }), ); } }
-
Tambahkan halaman
list_book.dart
kewidgets/left_drawer.dart
dengan menambahkan kode berikut. -
Ubah fungsi tombol
Lihat Buku
pada halaman utama agar mengarahkan ke halamanBookPage
. Kamu dapat melakukan redirection dengan menambahkanelse if
setelah kodeif(...){...}
di bagian akhironTap: () { }
yang ada pada filewidgets/tracker_card.dart
-
Impor file yang dibutuhkan saat menambahkan
BookPage
keleft_drawer.dart
dantracker_card.dart
. -
Jalankan aplikasi dan cobalah untuk menambahkan beberapa
Book
di situs web kamu. Kemudian, coba lihat hasilnya melalui halamanDaftar Buku
yang baru saja kamu buat di aplikasi Flutter
Integrasi Form Flutter Dengan Layanan Django
Langkah-langkah berikut akan dilakukan pada kode proyek Django.
-
Buatlah sebuah fungsi view baru pada
main/views.py
aplikasi Django kamu dengan potongan kode berikut. Jangan lupa juga untuk menambahkan import-import yang diperlukan pada bagian atas kode.from django.views.decorators.csrf import csrf_exempt import json from django.http import JsonResponse ... @csrf_exempt def create_book_flutter(request): if request.method == 'POST': data = json.loads(request.body) new_book = Book.objects.create( user = request.user, name = data["name"], page = int(data["page"]), description = data["description"] ) new_book.save() return JsonResponse({"status": "success"}, status=200) else: return JsonResponse({"status": "error"}, status=401)
-
Tambahkan path baru pada
main/urls.py
dengan kode berikut. -
Jalankan ulang (dan deploy ulang) aplikasi kamu. Apabila kamu telah men-deploy aplikasimu, maka data akun dan transaksi akan hilang setelah di-redeploy.
Langkah-langkah berikut akan dilakukan pada kode proyek Flutter.
-
Hubungkan halaman
trackerlist_form.dart
denganCookieRequest
dengan menambahkan baris kode berikut. -
Ubahlah perintah pada
onPressed: ()
button tambah menjadi kode berikut.... onPressed: () async { if (_formKey.currentState!.validate()) { // Kirim ke Django dan tunggu respons // TODO: Ganti URL dan jangan lupa tambahkan trailing slash (/) di akhir URL! final response = await request.postJson( "http://<URL_APP_KAMU>/create-flutter/", jsonEncode(<String, String>{ 'name': _name, 'page': _page.toString(), 'description': _description, // TODO: Sesuaikan field data sesuai dengan aplikasimu }), ); if (context.mounted) { if (response['status'] == 'success') { ScaffoldMessenger.of(context) .showSnackBar(const SnackBar( content: Text("Buku baru berhasil disimpan!"), )); Navigator.pushReplacement( context, MaterialPageRoute(builder: (context) => MyHomePage()), ); } else { ScaffoldMessenger.of(context) .showSnackBar(const SnackBar( content: Text("Terdapat kesalahan, silakan coba lagi."), )); } } } }, ...
-
Lakukan quick fix pada baris-baris yang bermasalah untuk mengimpor file yang dibutuhkan.
-
Jalankan ulang aplikasi dan coba untuk menambahkan transaksi baru dari aplikasi Flutter kamu.
Implementasi Fitur Logout
Langkah-langkah berikut akan dilakukan pada kode proyek Django.
-
Buatlah sebuah metode view untuk logout pada
authentication/views.py
.from django.contrib.auth import logout as auth_logout ... @csrf_exempt def logout(request): username = request.user.username try: auth_logout(request) return JsonResponse({ "username": username, "status": True, "message": "Logout berhasil!" }, status=200) except: return JsonResponse({ "status": False, "message": "Logout gagal." }, status=401)
-
Tambahkan path baru pada
authentication/urls.py
dengan kode berikut.
Langkah-langkah berikut akan dilakukan pada kode proyek Flutter.
-
Buka file
lib/widgets/tracker_card.dart
dan tambahkan potongan kode berikut. Selesaikan masalah impor library setelah menambahkan potongan kode ke dalam file tersebut. -
Ubahlah perintah
onTap: () {...}
pada widgetInkwell
menjadionTap: () async {...}
agar widgetInkwell
dapat melakukan proses logout secara asinkronus. -
Tambahkan kode berikut ke dalam
async {...}
di bagian akhir:... // statement if sebelumnya // tambahkan else if baru seperti di bawah ini else if (item.name == "Logout") { final response = await request.logout( // TODO: Ganti URL dan jangan lupa tambahkan trailing slash (/) di akhir URL! "http://<APP_URL_KAMU>/auth/logout/"); String message = response["message"]; if (context.mounted) { if (response['status']) { String uname = response["username"]; ScaffoldMessenger.of(context).showSnackBar(SnackBar( content: Text("$message Sampai jumpa, $uname."), )); Navigator.pushReplacement( context, MaterialPageRoute(builder: (context) => const LoginPage()), ); } else { ScaffoldMessenger.of(context).showSnackBar( SnackBar( content: Text(message), ), ); } } } ...
-
Jalankan ulang aplikasi dan coba untuk lakukan logout.
Akhir Kata
Selamat! Kamu telah menyelesaikan Tutorial 8! Semoga dengan tutorial ini, kalian dapat memahami mengenai model, fetch data, state management dasar, dan integrasi Django-Flutter dengan baik. 😄
-
Pelajari dan pahami kembali kode yang sudah kamu tuliskan di atas dengan baik. Jangan lupa untuk menyelesaikan semua TODO yang ada!
-
Lakukan
add
,commit
danpush
untuk memperbarui repositori GitHub.- Ubah
<pesan_commit>
sesuai dengan keinginan. Contoh:git commit -m "tutorial 7 selesai"
. - Ubah
<branch_utama>
sesuai dengan nama branch utamamu. Contoh:git push -u origin main
ataugit push -u origin master
.
- Ubah
Referensi Tambahan
- Fetch Data From the Internet
- How to create models in Flutter Dart
- Simple app state management | Flutter
- Flutter State Management with Provider
- Pengenalan State Management Flutter dan Jenis-jenisnya
Kontributor
- Muhammad Nabil Mu'afa
- Muhammad Iqbal Dwitama
Credits
Tutorial ini dikembangkan berdasarkan PBP Ganjil 2024 yang ditulis oleh Tim Pengajar Pemrograman Berbasis Platform 2023. Segala tutorial serta instruksi yang dicantumkan pada repositori ini dirancang sedemikian rupa sehingga mahasiswa yang sedang mengambil mata kuliah Pemrograman Berbasis Platform dapat menyelesaikan tutorial saat sesi lab berlangsung.