Tutorial Kotlin 19 : Cara Menggunakan Retrofit Kotlin

Last Updated on September 10, 2021 by

Pada seri tutorial Kotlin sebelumnya, kita telah belajar tentang recyclerview Kotlin. Kali ini kita akan belajar memahami tentang Android retrofit Kotlin dan cara penggunaanya.

Pustaka Retrofit ini nantinya akan digunakan sebagai antar muka dalam mengakses HTTP API. Jika Anda tertarik untuk belajar kotlin dan tahu tentang Retrofit Kotlin pastikan Anda menyimak artikel ini sampai akhir!

Apa itu REST API?

Sebelum membahas lebih jauh tentang retrofit, Anda perlu mengetahui dulu tentang REST API. REST API (juga dikenal sebagai RESTful API) terdiri dari REST dan API. REST adalah singkatan dari Representational State Transfer. Sementara API adalah singkatan dari Application Programming Interface.

API adalah seperangkat definisi dan protokol untuk membangun dan mengintegrasikan perangkat lunak aplikasi. Kadang-kadang API juga dianggap sebagai kontrak antara penyedia informasi dan pengguna informasi menetapkan konten yang diperlukan dari konsumen (panggilan) dan konten yang dibutuhkan oleh produsen (tanggapan).

Misalnya, desain API untuk layanan cuaca dapat menentukan bahwa pengguna menyediakan kode pos dan produsen menjawab dengan jawaban 2 bagian, yang pertama adalah suhu tinggi, dan yang kedua adalah suhu rendah.

Dengan kata lain, jika Anda ingin berinteraksi dengan komputer atau sistem untuk mengambil informasi atau menjalankan suatu fungsi, API membantu Anda mengomunikasikan apa yang Anda inginkan ke sistem itu sehingga sistem tersebut dapat memahami dan memenuhi permintaan.

Hal ini juga merupakan cara bagi organisasi untuk berbagi sumber daya dan informasi sambil mempertahankan keamanan, kontrol, dan autentikasi menentukan siapa yang mendapatkan akses ke apa.

Sebaliknya, REST adalah seperangkat pedoman yang dapat diimplementasikan sesuai kebutuhan, membuat REST API lebih cepat dan lebih ringan, dengan peningkatan skalabilitas sempurna untuk Internet of Things (IoT) dan pengembangan aplikasi seluler. REST adalah seperangkat batasan arsitektur, bukan protokol atau standar.

Pengembang API dapat mengimplementasikan REST dalam berbagai cara. Ketika permintaan klien dibuat melalui RESTful API, itu mentransfer representasi status sumber daya ke pemohon atau titik akhir. Informasi ini, atau representasi, disampaikan dalam salah satu dari beberapa format melalui HTTP: JSON (Javascript Object Notation), HTML, XLT, Python, PHP, atau teks biasa.

Hal lain yang perlu diingat tentang REST adalah: Header dan parameter juga penting dalam metode HTTP dari permintaan HTTP API RESTful, karena berisi informasi pengenal penting untuk metadata permintaan, otorisasi, pengenal sumber daya seragam (URI), caching, cookie, dan lebih.

Agar API dianggap RESTful, API harus memenuhi kriteria berikut:

1. Arsitektur client-server yang terdiri dari klien, server, dan sumber daya, dengan permintaan yang dikelola melalui HTTP.
2. Komunikasi client-server stateless, artinya tidak ada informasi klien yang disimpan antara permintaan get dan setiap permintaan terpisah dan tidak terhubung.
3. Data yang dapat disimpan dalam cache yang menyederhanakan interaksi klien-server.
4. Antarmuka yang seragam antar komponen sehingga informasi ditransfer dalam bentuk standar. Ini mengharuskan:

• Resources atau sumber daya yang diminta dapat diidentifikasi dan terpisah dari representasi yang dikirim ke klien.
• sumber daya dapat dimanipulasi oleh klien melalui representasi yang mereka terima karena representasi berisi informasi yang cukup untuk melakukannya.
• pesan deskriptif diri yang dikembalikan ke klien memiliki informasi yang cukup untuk menggambarkan bagaimana klien harus memprosesnya.
• hypertext/hypermedia tersedia, artinya setelah mengakses sumber daya, klien harus dapat menggunakan hyperlink untuk menemukan semua tindakan lain yang tersedia saat ini yang dapat mereka ambil.
• Sistem berlapis yang mengatur setiap jenis server (mereka yang bertanggung jawab atas keamanan, penyeimbangan beban, dll.) melibatkan pengambilan informasi yang diminta ke dalam hierarki, yang tidak terlihat oleh klien.
• Code-on-demand (opsional): kemampuan untuk mengirim kode yang dapat dieksekusi dari server ke klien saat diminta, memperluas fungsionalitas klien.

Meskipun REST API memiliki kriteria untuk dipatuhi, ini masih dianggap lebih mudah digunakan daripada protokol yang ditentukan seperti SOAP (Simple Object Access Protocol), yang memiliki persyaratan khusus seperti pesan XML, dan keamanan bawaan dan kepatuhan transaksi yang membuatnya lebih lambat dan lebih berat.

Apa itu Retrofit Kotlin?

Retrofit adalah pustaka REST-client yang sangat aman untuk Java dan android. Retrofit sendiri dikembangkan oleh Square. Pustaka menyediakan kerangka kerja yang kuat untuk mengautentikasi dan berinteraksi dengan API dan mengirim permintaan jaringan dengan OkHttp.

Hal ini berarti developer bisa gunakan retrofit untuk melakukan panggilan jaringan dari aplikasi yang sudah dibuat. Dalam aplikasi android, Retrofit memanfaatkan OkHttp yang merupakan level rendah. Namun, retrofit menghadirkan fitur type-safe yang membantu developer untuk mengkonsumsi REST API di Android secara lebih teratrur dan terstruktur.

Klien Http untuk android dibuat oleh perusahaan yang sama yang membuat retrofit Square.io. Developer juga bisa menggunakan Gson saat bekerja dengan retrofit. Hal ini adalah perpustakaan yang digunakan untuk mengonversi objek Java ke dalam format JSON.

Setelah data diunduh kemudian diurai menjadi Plain Old Java Object (POJO) yang harus ditentukan untuk setiap “sumber daya” dalam respons.

Retrofit memiliki tiga komponen utama di dalamnya:

1. Database

Database adalah objek kelas (class object) yang dipakai untuk mendaftarkan kelas Data Access Object di mana ia nantinya berfungsi sebagai titik akses utama ke remote database atau REST API.

2. Model

Model adalah kelas yang dipakai untuk menyimpan suatu nilai atau data. Retrofit membutuhkan model kelas yang dipakai menyimpan data respon yang didapat berdasarkan REST API.

3. Data Access Object (DAO)

Data Access Object adalah antarmuka (interface) yang dipakai retrofit buat akses data berdasarkan group client ke remote database (REST API) dan memuat metode yg pada pakai buat mengakses resource-nya.

Keuntungan Menggunakan Retrofit Kotlin

• Retrofit android sangat mudah digunakan. Retrofit pada dasarnya memungkinkan Anda memperlakukan panggilan API sebagai panggilan metode Java sederhana. Jadi, Anda hanya menentukan URL mana yang akan dipukul dan jenis parameter permintaan/tanggapan sebagai kelas Java.
• Seluruh panggilan jaringan + penguraian JSON/XML sepenuhnya ditangani olehnya (dengan bantuan dari Gson untuk penguraian JSON), bersama dengan dukungan untuk format arbitrer dengan serialisasi/deserialisasi yang pluggable.

Tutorial Membuat Retrofit Kotlin

Belajar Kotlin tidak akan lengkap rasanya jika Anda tidak membaca tutorial cara membuatnya. Berikut ini adalah 6 langkah mudah membuat retrofit Kotlin.

1. Tambahkan Retrofit Dependency

Pertama-tama, tambahkan Internet Permission ke Aplikasi Anda di Android Manifest.xml

<uses-permission android:name="android.permission.INTERNET"></uses-permission>

Kemudian, Kita harus menambahkan ketergantungan retrofit ke dalam file build.grade. Anda dapat menemukan versi retrofit terbaru di situs web resmi retrofit. http://square.github.io/retrofit/

implementation 'com.squareup.retrofit2:retrofit:'+rootProject.retrofit_version

GSON Converter dari retrofit akan digunakan untuk mengkonversi respons JSON dari server.

2. Membuat Model Class

Sebelum membuat model, kita perlu mengetahui apa tipe dari respon yang akan kita terima.

[ { "id":"1", "image":"http://velmm.com/images/bottom_navigationview/coco.jpg", "title":"Coco" }, { "id":"2", "image":"http://velmm.com/images/bottom_navigationview/terminator_2.jpg", "title":"Terminator 2: Judgment Day 3D" }, { "id":"3", "image":"http://velmm.com/images/bottom_navigationview/dunkirk.jpg", "title":"Dunkirk" }, { "id":"4", "image":"http://velmm.com/images/bottom_navigationview/the_salesman.jpg", "title":"The Salesman" }, { "id":"5", "image":"http://velmm.com/images/bottom_navigationview/lion.png", "title":"Lion" }, { "id":"6", "image":"http://velmm.com/images/bottom_navigationview/star_war.jpg", "title":"Star Wars: The Last Jedi" }, { "id":"7", "image":"http://velmm.com/images/bottom_navigationview/thor_ragnarok.jpg", "title":"Thor: Ragnarok" }, { "id":"8", "image":"http://velmm.com/images/bottom_navigationview/blade_runner_2049.jpg", "title":"Blade Runner 2049" }, { "id":"9", "image":"http://velmm.com/images/bottom_navigationview/borg_mcenroe.jpg", "title":"Borg McEnroe" }, { "id":"10", "image":"http://velmm.com/images/bottom_navigationview/wonder.jpg", "title":"Wonder" } ]

Dalam respon JSON di sini, kami memiliki daftar dari beberapa film dengan judul, tahun, dan director-nya. Oleh karena itu, model kelas ini akan seperti sebuah kelas yang berisi film-film disertai nama kelas, judul film, tahun dibuat, dan director sebagai properties.

Movie.kt

data class Movie(var title: String, var image: String)

@SerializedName digunakan untuk map dari POJO object ke dalam properties respon JSON.

3. Membuat Instance Retrofit

Kita perlu membuat instance Retrofit untuk mengirim permintaan jaringan. Kita perlu menggunakan Retrofit Builder Class dan memastikan base URL untuk service-nya.

ApiInterface.kt

interface ApiInterface { @GET("volley_array.json") fun getMovies() : Call<List<Movie>> companion object { var BASE_URL = "http://velmm.com/apis/" fun create() : ApiInterface { val retrofit = Retrofit.Builder() .addConverterFactory(GsonConverterFactory.create()) .baseUrl(BASE_URL) .build() return retrofit.create(ApiInterface::class.java) } } }

4. Menyiapkan Antarmuka Retrofit

Retrofit menyediakan daftar anotasi untuk setiap metode HTTP:

@GET, @POST, @PUT, @DELETE, @PATCH atau @HEAD.

Titik akhir didefinisikan di dalam antarmuka menggunakan anotasi retrofit untuk menyandikan detail tentang parameter dan metode permintaan. Nilai kembalian T selalu merupakan Call<T> yang diparameterisasi. Karena kelas POJO dibungkus ke dalam kelas Retrofit Call yang diketik.

Parameter Method:

@Body — Mengirim objek Java sebagai badan permintaan.

@Url — gunakan URL dinamis.

@Query — Kita cukup menambahkan parameter metode dengan @Query() dan nama parameter kueri, yang menjelaskan tipenya.

Untuk mengkodekan URL kueri menggunakan formulir:

@Query(nilai = “auth_token”, dikodekan = true) String auth_token

ApiInterface.java

interface ApiInterface { @GET("volley_array.json") fun getMovies() : Call<List<Movie>> }

5. Konsumsikan REST Web Service

Semua pengaturan selesai. Sekarang kita siap untuk menggunakan layanan web REST. Di MainActivity.Java, inisialisasikan ApiClient.

Setelah inisialisasi, kita memanggil antarmuka getMovies() dan mengimplementasikan CallBacks. Sebagai bagian dari implementasi, kita perlu mengganti onResponse() dan onFailure().

Jika permintaan berhasil, panggilan balik akan masuk ke onResponse(). Jika ada kesalahan dalam permintaan, panggilan balik akan masuk ke metode onFailure(). Dalam metode onResponse() , kita bisa mendapatkan respons dari badan respon.

val apiInterface = ApiInterface.create().getMovies() //apiInterface.enqueue( Callback<List<Movie>>()) apiInterface.enqueue( object : Callback<List<Movie>>{ override fun onResponse(call: Call<List<Movie>>?, response: Response<List<Movie>>?) { if(response?.body() != null) recyclerAdapter.setMovieListItems(response.body()!!) } override fun onFailure(call: Call<List<Movie>>?, t: Throwable?) { } })

Sekarang data yang sudah kita buat diterima di onReceive(). Kami dapat menggunakan data untuk tujuan aplikasi kami. Dalam contoh ini, saya menggunakan data retrofit ini untuk menyiapkan di recyclerview.

6. Atur Retrofit Response Data ke Recyclerview

Jika Anda sudah mempelajari tentang Recyclerview Kotlin, maka tidak akan sulit melakukan step ini. Atur response yang diterima ke recyclerview:

recyclerView = findViewById(R.id.recyclerview) recyclerAdapter = RecyclerAdapter(this) recyclerview.layoutManager = LinearLayoutManager(this) recyclerView.adapter = recyclerAdapter val apiInterface = ApiInterface.create().getMovies() //apiInterface.enqueue( Callback<List<Movie>>()) apiInterface.enqueue( object : Callback<List<Movie>>{ override fun onResponse(call: Call<List<Movie>>?, response: Response<List<Movie>>?) { if(response?.body() != null) recyclerAdapter.setMovieListItems(response.body()!!) } override fun onFailure(call: Call<List<Movie>>?, t: Throwable?) { } })

Demikianlah penjelasan tentang  Retrofit Kotlin. Jika Anda tertarik untuk belajar Kotlin, pastikan Anda belajar bersama Codekey.

Situs Codekey menyediakan berbagai materi, tutorial, tips, dan trik yang dapat membantu Anda untuk belajar berbagai bahasa pemrograman. Jangan lewatkan update terbaru dari situ Codekey!