Redes Sociais
 Telegram  YouTube
Pegar endereço com CEP usando coroutines e retrofit em Kotlin
4 de novembro de 2020

Nesse tutorial vou mostrar como fazer um aplicativo em MVVM para pegar endereço com CEP usando coroutines e retrofit em Kotlin.

Vamos utilizar MVVM nesse tutorial usando coroutines e o retrofit para fazer a requisição.

Se deseja conhecer um pouco mais sobre coroutines acesse portanto kotlinlang.org.

Primeiramente vamos criar um projeto vazio(Empty) com o nome de br.com.uware.cep_mvvm .

Logo depois de ter criado o projeto vamos montar a base para que possamos programar.

Base do projeto

Vamos então editar o gradle(app) do nosso projeto deixando com o seguinte código para que tenha as bibliotecas que vamos usar.

plugins {
    id 'com.android.application'
    id 'kotlin-android'
    id 'kotlin-android-extensions'
}

android {
    compileSdkVersion 30
    buildToolsVersion "30.0.2"

    defaultConfig {
        applicationId "br.com.uware.cep_mvvm"
        minSdkVersion 24
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = '1.8'
    }
}

dependencies {

    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    implementation 'androidx.core:core-ktx:1.3.2'
    implementation 'androidx.appcompat:appcompat:1.2.0'
    implementation 'com.google.android.material:material:1.2.1'
    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.2'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'

    // ViewModel e activity-ktx
    implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.2.0'
    implementation 'androidx.activity:activity-ktx:1.1.0'
    implementation "androidx.fragment:fragment-ktx:1.2.5"

    // Retrofit
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.google.code.gson:gson:2.8.6'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'

    // Coroutines
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9'
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'

    // Material Design
    implementation 'com.google.android.material:material:1.3.0-alpha03'
}

Logo após de termos modificado o gradle não podemos esquecer de sincronizar para que sejam inseridas as bibliotecas.





Então vamos modificar também o AndroidManifest.xml para que tenha permissão de uso da internet deixando igual ao código a seguir.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="br.com.uware.cep_mvvm">

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

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.CEPMVVM">
        <activity android:name=".ui.MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

Vamos agora colocar as strings que vamos usar em nosso projeto no arquivo strings.xml e então o código deve ficar igual ao seguinte.

<resources>
    <string name="app_name">CEP-MVVM</string>
    <string name="init">Digite um CEP para procurar o endereço.</string>
    <string name="input_cep">Digite o CEP:</string>
    <string name="send">Enviar</string>
    <string name="cep">CEP: </string>
    <string name="logradouro">Endereço: </string>
    <string name="bairro">Bairro: </string>
    <string name="localidade">Cidade: </string>
    <string name="uf">Estado: </string>
    <string name="ddd">DDD: </string>
    <string name="error">Houve um erro na requisição.</string>
    <string name="error_numbers">O CEP precisa ter de 8 digitos.</string>
    <string name="error_exist">O número não existe na base de dados.</string>
</resources>

Pegar endereço com CEP usando coroutines e retrofit em Kotlin

Para começar a programar vamos então criar alguns packages para deixar o nosso projeto organizado.

Packages

Vamos portanto criar os packages com os seguintes nomes:

  • model
  • ui
  • util
  • viewmodel

No final do nosso projeto deve ficar com os arquivos assim como a imagem a seguir.

Pegar endereço com CEP usando coroutines e retrofit em Kotlin
Packages criados

Util

Neste package vamos então criar um arquivo com o nome de Utils.kt que vai conter algumas funções que nosso projeto vai usar, este arquivo deve estar com o seguinte código.

package br.com.uware.cep_mvvm.util

import android.content.Context
import android.text.Editable
import android.text.TextWatcher
import android.view.View
import android.view.inputmethod.InputMethodManager
import android.widget.EditText
import androidx.fragment.app.Fragment
import androidx.fragment.app.FragmentActivity
import br.com.uware.cep_mvvm.R
import com.google.android.material.snackbar.Snackbar

/**
 *   Author:     Rodrigo Leutz
 *   Site:       https://uware.com.br
 *   Project:    CEP-MVVM
 *   Date:       03/11/20
 */

// Máscara do EditText
object MaskEditUtil {
    fun mask(ediTxt: EditText): TextWatcher {
        return object : TextWatcher {
            var isUpdating: Boolean = false
            override fun beforeTextChanged(s: CharSequence?, start: Int, count: Int, after: Int) {}
            override fun onTextChanged(s: CharSequence?, start: Int, before: Int, count: Int) {
                val str = unmask(s.toString())
                var mascara = ""
                val mask = "#####-###"
                if (isUpdating) {
                    isUpdating = false
                    return
                }
                var i = 0
                for (m in mask.toCharArray()) {
                    if (m != '#' && count > before) {
                        mascara += m
                        continue
                    }
                    try {
                        mascara += str[i]
                    } catch (e: Exception) {
                        break
                    }
                    i++
                }
                isUpdating = true
                ediTxt.setText(mascara)
                ediTxt.setSelection(mascara.length)
            }
            override fun afterTextChanged(s: Editable?) {}
        }
    }
    fun unmask(s: String): String {
        return s.replace("-", "")
    }
}
// Carregar Fragment
fun Fragment.loadFragment(act: FragmentActivity) {
    act.supportFragmentManager.beginTransaction()
            .setCustomAnimations(android.R.anim.fade_in, android.R.anim.fade_out)
            .replace(R.id.fragment, this)
            .commitNow()
}
// SnackBar
fun View.snackBar(str: String){
    Snackbar.make(this , str, Snackbar.LENGTH_SHORT).show()
}

// Esconde o teclado
fun View.hideKeyboard() {
    val imm = context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
    imm.hideSoftInputFromWindow(windowToken, 0)
}




Model(Retrofit)

Dentro deste package vamos portanto criar o model que vai ser usado e a conexão com a página e a decodificação do json utilizando o retrofit.

Primeiramente nesta parte vamos criar o model de nossa requisição.

Vamos então criar o arquivo Cep.kt que vai conter a nossa data class.

package br.com.uware.cep_mvvm.model

import com.google.gson.annotations.SerializedName

/**
 *   Author:     Rodrigo Leutz
 *   Site:       https://uware.com.br
 *   Project:    CEP-MVVM
 *   Date:       02/11/20
 */

data class Cep(
    @SerializedName("cep")
    val cep: String?,
    @SerializedName("logradouro")
    val logradouro: String?,
    @SerializedName("bairro")
    val bairro: String?,
    @SerializedName("localidade")
    val localidade: String?,
    @SerializedName("uf")
    val uf: String?,
    @SerializedName("ddd")
    val ddd: String?,
    @SerializedName("erro")
    val erro: String?
)

Se é utilizado o nome da variável igual ao do arquivo json não é necessário colocar a anotação de @SerializedName, eu coloquei por motivos didáticos.

Vamos criar a interface ApiService.kt para fazer o get no arquivo json.

package br.com.uware.cep_mvvm.model

import retrofit2.http.GET

/**
 *   Author:     Rodrigo Leutz
 *   Site:       https://uware.com.br
 *   Project:    CEP-MVVM
 *   Date:       02/11/20
 */

interface ApiService {

    @GET("json/")
    suspend fun getCep(): Cep

}

Então depois de ter criado a interface vamos criar a requisição do Retrofit.

Vamos então criar o arquivo RetrofitBuilder.kt contendo o seguinte código.

package br.com.uware.cep_mvvm.model

import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory

/**
 *   Author:     Rodrigo Leutz
 *   Site:       https://uware.com.br
 *   Project:    CEP-MVVM
 *   Date:       02/11/20
 */

class RetrofitBuilder(cep: String) {

    private val cep = cep

    private fun getRetrofit(): Retrofit {
        return Retrofit.Builder()
            .baseUrl("https://viacep.com.br/ws/${cep}/")
            .addConverterFactory(GsonConverterFactory.create())
            .build()
    }

    val apiService: ApiService = getRetrofit().create(ApiService::class.java)
}

Então agora vamos criar o helper que vai fazer a chamada a nossa Api.

Agora vamos então criar o arquivo ApiHelper.kt com o seguinte código.

package br.com.uware.cep_mvvm.model

/**
 *   Author:     Rodrigo Leutz
 *   Site:       https://uware.com.br
 *   Project:    CEP-MVVM
 *   Date:       02/11/20
 */

class ApiHelper(private val apiService: ApiService) {
    suspend fun getCep() = apiService.getCep()
}

Com estes arquivos criado já vamos ter a nossa api que faz a conexão com o site e retorna o endereço do cep pesquisado.





ViewModel

Chegou a hora de criar o arquivo de ViewModel que vai fazer a requisição com coroutines e guardar os dados da nossa aplicação.

Então vamos criar o arquivo MainViewModel.kt dentro do package viewmodel contendo o seguinte código.

package br.com.uware.cep_mvvm.viewmodel

import androidx.lifecycle.MutableLiveData
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import br.com.uware.cep_mvvm.model.ApiHelper
import br.com.uware.cep_mvvm.model.Cep
import br.com.uware.cep_mvvm.model.RetrofitBuilder
import kotlinx.coroutines.launch

/**
 *   Author:     Rodrigo Leutz
 *   Site:       https://uware.com.br
 *   Project:    CEP-MVVM
 *   Date:       02/11/20
 */

class MainViewModel : ViewModel() {

    val loading = MutableLiveData<Boolean>()
    val error = MutableLiveData<Boolean>()
    val errorType = MutableLiveData<Int>()
    val cep = MutableLiveData<Cep>()

    // Recebendo CEP
    fun setCep(cep: String?){
        if (cep != null) {
            fetchCep(cep)
        }
    }

    // Pegando CEP com coroutines
    private fun fetchCep(str: String) {
        loading.value = true
        // Corroutine
        viewModelScope.launch {
            try {
                val currentCep = ApiHelper(RetrofitBuilder(str).apiService).getCep()
                if(currentCep.erro != null){
                    error.value = true
                    errorType.value = 1
                    loading.value = false
                }else {
                    cep.value = currentCep
                    error.value = false
                    loading.value = false
                }
            }catch (e: Exception){
                error.value = true
                errorType.value = 0
                loading.value = false
            }
        }
    }
}

ui

Vamos agora criar a nossa ui que é a interface do usuário então para começar vamos criar um arquivo de layout com o nome de content_cep.xml que vai ser um fragment.

Nesse arquivo de layout content_cep.xml deve conter o seguinte código.

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <ProgressBar
        android:id="@+id/progressBar"
        android:layout_width="100dp"
        android:layout_height="100dp"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintEnd_toEndOf="parent"/>
    <TextView
        android:id="@+id/tvError"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:gravity="center"
        android:text="@string/error"
        android:textSize="14sp"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintEnd_toEndOf="parent"/>

    <LinearLayout
        android:id="@+id/layCep"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="vertical"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintBottom_toBottomOf="parent">
        <LinearLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:orientation="horizontal">
            <TextView
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:text="@string/cep"
                android:textSize="14sp"
                android:gravity="end"
                android:layout_marginEnd="10dp"
                android:layout_weight="2"/>
            <TextView
                android:id="@+id/tvCep"
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:textSize="14sp"
                android:gravity="start"
                android:layout_weight="1"/>
        </LinearLayout>
        <LinearLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:orientation="horizontal">
            <TextView
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:text="@string/logradouro"
                android:textSize="14sp"
                android:gravity="end"
                android:layout_marginEnd="10dp"
                android:layout_weight="2"/>
            <TextView
                android:id="@+id/tvLogradouro"
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:textSize="14sp"
                android:gravity="start"
                android:layout_weight="1"/>
        </LinearLayout>
        <LinearLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:orientation="horizontal">
            <TextView
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:text="@string/bairro"
                android:textSize="14sp"
                android:gravity="end"
                android:layout_marginEnd="10dp"
                android:layout_weight="2"/>
            <TextView
                android:id="@+id/tvBairro"
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:textSize="14sp"
                android:gravity="start"
                android:layout_weight="1"/>
        </LinearLayout>
        <LinearLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:orientation="horizontal">
            <TextView
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:text="@string/localidade"
                android:textSize="14sp"
                android:gravity="end"
                android:layout_marginEnd="10dp"
                android:layout_weight="2"/>
            <TextView
                android:id="@+id/tvLocalidade"
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:textSize="14sp"
                android:gravity="start"
                android:layout_weight="1"/>
        </LinearLayout>
        <LinearLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:orientation="horizontal">
            <TextView
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:text="@string/uf"
                android:textSize="14sp"
                android:gravity="end"
                android:layout_marginEnd="10dp"
                android:layout_weight="2"/>
            <TextView
                android:id="@+id/tvUf"
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:textSize="14sp"
                android:gravity="start"
                android:layout_weight="1"/>
        </LinearLayout>
        <LinearLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:orientation="horizontal">
            <TextView
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:text="@string/ddd"
                android:textSize="14sp"
                android:gravity="end"
                android:layout_marginEnd="10dp"
                android:layout_weight="2"/>
            <TextView
                android:id="@+id/tvDdd"
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:textSize="14sp"
                android:gravity="start"
                android:layout_weight="1"/>
        </LinearLayout>
    </LinearLayout>

</androidx.constraintlayout.widget.ConstraintLayout>

Logo depois de ter criado o arquivo de layout, vamos então criar o fragment que vai utilizar este layout com o nome de MainFragment.kt dentro do package ui com o seguinte código.

package br.com.uware.cep_mvvm.ui

import android.os.Bundle
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import androidx.fragment.app.Fragment
import androidx.fragment.app.activityViewModels
import androidx.lifecycle.Observer
import br.com.uware.cep_mvvm.R
import br.com.uware.cep_mvvm.viewmodel.MainViewModel
import kotlinx.android.synthetic.main.content_cep.*

/**
 *   Author:     Rodrigo Leutz
 *   Site:       https://uware.com.br
 *   Project:    CEP-MVVM
 *   Date:       02/11/20
 */
class MainFragment : Fragment() {

    companion object {
        fun newInstance() = MainFragment()
    }

    // ViewModel da MainActivity
    private val viewModel: MainViewModel by activityViewModels()

    private var fragmentListViews: List<View>? = null

    override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        return inflater.inflate(R.layout.content_cep, container, false)
    }

    override fun onActivityCreated(savedInstanceState: Bundle?) {
        super.onActivityCreated(savedInstanceState)

        // Lista de Fragments
        fragmentListViews = listOf(layCep, progressBar, tvError)

        // Observadores do viewModel
        viewModel.cep.observe(viewLifecycleOwner, Observer {
            it.let {
                tvCep.text = it.cep
                tvLogradouro.text = it.logradouro
                tvBairro.text = it.bairro
                tvLocalidade.text = it.localidade
                tvUf.text = it.uf
                tvDdd.text = it.ddd
                layCep.setVisible(fragmentListViews)
            }
        })
        viewModel.error.observe(viewLifecycleOwner, Observer {
            if (it) tvError.setVisible(fragmentListViews)
        })
        viewModel.errorType.observe(viewLifecycleOwner, Observer {
            tvError.text =
                if (it == 0) getString(R.string.error) else getString(R.string.error_exist)
        })
        viewModel.loading.observe(viewLifecycleOwner, Observer {
            if (it) progressBar.setVisible(fragmentListViews)
        })
    }

    // Setando view atual no fragment
    private fun View.setVisible(listViews: List<View>?) = listViews?.map { if (it == this) it.visibility = View.VISIBLE else it.visibility = View.GONE }


}




Bom agora falta editar o nosso layout activity_main.xml e deixar como o seguinte.

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".ui.MainActivity">

    <com.google.android.material.textfield.TextInputLayout
        android:id="@+id/layoutInput"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:hint="@string/input_cep"
        android:layout_margin="16dp"
        style="@style/Widget.MaterialComponents.TextInputLayout.OutlinedBox"
        app:layout_constraintTop_toTopOf="parent">

        <com.google.android.material.textfield.TextInputEditText
            android:id="@+id/etCep"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:inputType="number"/>

    </com.google.android.material.textfield.TextInputLayout>
    <Button
        android:id="@+id/btnSend"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="@string/send"
        android:layout_margin="16dp"
        android:textColor="@color/white"
        android:backgroundTint="@color/purple_500"
        app:layout_constraintTop_toBottomOf="@+id/layoutInput"/>

    <TextView
        android:id="@+id/tvInit"
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:layout_margin="100dp"
        android:text="@string/init"
        android:textSize="18sp"
        android:gravity="center"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintTop_toBottomOf="@id/layoutInput"/>

    <FrameLayout
        android:id="@+id/fragment"
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:layout_margin="16dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintTop_toBottomOf="@id/btnSend" />


</androidx.constraintlayout.widget.ConstraintLayout>

E para finalizar vamos editar o arquivo MainActivity.kt que foi movido para dentro do package ui.

Então dentro do arquivo MainActivity.kt devemos deixar como o seguinte.

package br.com.uware.cep_mvvm.ui

import android.os.Bundle
import android.view.View
import androidx.activity.viewModels
import androidx.fragment.app.FragmentActivity
import br.com.uware.cep_mvvm.R
import br.com.uware.cep_mvvm.util.MaskEditUtil
import br.com.uware.cep_mvvm.util.hideKeyboard
import br.com.uware.cep_mvvm.util.loadFragment
import br.com.uware.cep_mvvm.util.snackBar
import br.com.uware.cep_mvvm.viewmodel.MainViewModel
import kotlinx.android.synthetic.main.activity_main.*

class MainActivity : FragmentActivity() {

    // ViewModel
    private val viewModel: MainViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // Adicionando máscara no EditText
        etCep.addTextChangedListener(MaskEditUtil.mask(etCep))

        // Funções do botão enviar
        btnSend.setOnClickListener {
            // Esconde o teclado
            it.hideKeyboard()
            if(etCep.text.toString().length == 9) {
                // Enviando CEP para o ViewModel
                viewModel.setCep(etCep.text.toString())
                tvInit.visibility = View.GONE
                MainFragment.newInstance().loadFragment(this)
            }
            else {
                it.snackBar(getString(R.string.error_numbers))
            }
        }
    }
}

Então agora é só compilar e rodar para ver como ficou o aplicativo.

Pegar endereço com CEP usando coroutines e retrofit em Kotlin

Pegar endereço com CEP usando coroutines e retrofit em Kotlin
Pegar endereço com CEP usando coroutines e retrofit em Kotlin

Enfim espero assim poder ter ajudado com mais este tutorial sobre pegar endereço com CEP usando coroutines e retrofit em Kotlin.

Autor: Rodrigo Leutz

Desenvolvedor Web e Android ( Kotlin e Java )


Converter Binário para Inteiro e Inteiro para Binário em Kotlin

Nesse tutorial vamos portanto ver como converter número binário para inteiro e também inteiro para binário em Kotlin no Android[...]

29 de outubro de 2020

Problema com Kotlin e synthetic no Android Studio

Notei que tem algumas pessoas com problemas com kotlin e synthetic no Android Studio então escrevi esta dica para solução desse[...]

27 de outubro de 2020

Como criar uma Calculadora em kotlin com ViewModel

Neste tutorial irei descrever como criar uma calculadora simples de quatro operações em kotlin mas vamos usar o recurso de[...]

27 de setembro de 2020