Kotlin Arrow: Dominando a navegação na mônada Either
Publié le 24 September 2024
- Introdução
- O que é a mónada Either ?
- Contexto
- As diferentes abordagens
- A abordagem clássica com `when
- Uso de
foldpara uma abordagem mais concisa - Transformação com
mape `mapLeft - Tratamento de erros com `getOrElse
- Ações laterais com
onLefte `onRight - Encadeamento de operações com `flatMap
- Transformação bidirecional com `bimap
- Inversão dos lados com `swap
- Utilização de
tapetapLeft: - Utilização de
recover:
- Casos de uso práticos
- Conclusão
- Para ir além
Introdução
No mundo da programação funcional em Kotlin, a biblioteca Arrow oferece ferramentas poderosas para lidar com erros e casos alternativos. Entre essas ferramentas, a mônada`Either`destaca-se pela sua capacidade de representar dois estados possíveis: sucesso (Right) ou fracasso (Left). Mas como navegar eficientemente entre esses dois estados? É isto que vamos explorar neste artigo.
O que é a mónada Either ?
A mônada`Either`é uma estrutura de dados que representa duas possibilidades mutualmente exclusivas. Em Kotlin com Arrow, ela é frequentemente usada para lidar com os casos de sucesso e de falha de uma operação, oferecendo uma alternativa elegante às exceções tradicionais.
Por que usar Either?
-
Gerenciamento explícito de erros: Obriga o desenvolvedor a considerar os casos de erro.
-
Composição funcional: facilita o encadeamento de operações que podem falhar.
-
Type‑safety : Os erros são tipados, o que ajuda a manipulá-los de maneira mais precisa.
-
Sem exceções: Evite efeitos colaterais e interrupções inesperadas do fluxo de execução.
Contexto
Imagine que você está desenvolvendo uma API REST comhttps://spring.io/projects/spring-boot/[Spring Boot,windows=ler-mais-tarde] et Kotlin, usando a bibliotecahttps://arrow-kt.io/[Arrow,janelas=ler-mais-tarde]. Você tem uma função`findOneUserByEmail`que retorna um`Either<Throwable, User>`. Como você pode tratar esse resultado de forma elegante e funcional?
Temos uma classe User :
@file:Suppress(
"RemoveRedundantQualifierName",
"MemberVisibilityCanBePrivate",
"SqlNoDataSourceInspection"
)
package webapp.users
import arrow.core.Either
import arrow.core.left
import arrow.core.right
import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.databind.ObjectMapper
import jakarta.validation.constraints.NotNull
import jakarta.validation.constraints.Pattern
import jakarta.validation.constraints.Size
import org.springframework.beans.factory.getBean
import org.springframework.context.ApplicationContext
import org.springframework.data.r2dbc.core.R2dbcEntityTemplate
import org.springframework.r2dbc.core.DatabaseClient
import org.springframework.r2dbc.core.awaitOne
import org.springframework.r2dbc.core.awaitRowsUpdated
import webapp.core.property.ANONYMOUS_USER
import webapp.core.property.EMPTY_STRING
import webapp.core.utils.AppUtils.cleanField
import webapp.users.EntityModel.Companion.ID_MEMBER
import webapp.users.User.UserDao.Attributes.EMAIL_ATTR
import webapp.users.User.UserDao.Attributes.ID_ATTR
import webapp.users.User.UserDao.Attributes.LANG_KEY_ATTR
import webapp.users.User.UserDao.Attributes.LOGIN_ATTR
import webapp.users.User.UserDao.Attributes.PASSWORD_ATTR
import webapp.users.User.UserDao.Attributes.VERSION_ATTR
import webapp.users.User.UserDao.Constraints.LOGIN_REGEX
import webapp.users.User.UserDao.Fields.EMAIL_FIELD
import webapp.users.User.UserDao.Fields.ID_FIELD
import webapp.users.User.UserDao.Fields.LANG_KEY_FIELD
import webapp.users.User.UserDao.Fields.LOGIN_FIELD
import webapp.users.User.UserDao.Fields.PASSWORD_FIELD
import webapp.users.User.UserDao.Fields.VERSION_FIELD
import webapp.users.User.UserDao.Relations.INSERT
import webapp.users.security.Role
import webapp.users.security.Role.RoleDao
import webapp.users.security.UserRole.UserRoleDao
import java.util.*
import jakarta.validation.constraints.Email as EmailConstraint
data class User(
override val id: UUID? = null,
@field:NotNull
@field:Pattern(regexp = LOGIN_REGEX)
@field:Size(min = 1, max = 50)
val login: String,
@JsonIgnore
@field:NotNull
@field:Size(min = 60, max = 60)
val password: String = EMPTY_STRING,
@field:EmailConstraint
@field:Size(min = 5, max = 254)
val email: String = EMPTY_STRING,
@JsonIgnore
val roles: MutableSet<Role> = mutableSetOf(Role(ANONYMOUS_USER)),
@field:Size(min = 2, max = 10)
val langKey: String = EMPTY_STRING,
@JsonIgnore
val version: Long = -1,
) : EntityModel<UUID>() {
companion object {
@JvmStatic
fun main(args: Array<String>) = println(UserDao.Relations.sqlScript)
}
object UserDao {
object Constraints {
// Regex for acceptable logins
const val LOGIN_REGEX =
"^(?>[a-zA-Z0-9!$&*+=?^_`{|}~.-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*)|(?>[_.@A-Za-z0-9-]+)$"
const val PASSWORD_MIN: Int = 4
const val PASSWORD_MAX: Int = 16
const val IMAGE_URL_DEFAULT = "https://placehold.it/50x50"
const val PHONE_REGEX = "^(\\+|00)?[1-9]\\d{0,49}\$"
}
object Members {
const val PASSWORD_MEMBER = "password"
const val ROLES_MEMBER = "roles"
}
object Fields {
const val ID_FIELD = "`id`"
const val LOGIN_FIELD = "`login`"
const val PASSWORD_FIELD = "`password`"
const val EMAIL_FIELD = "`email`"
const val LANG_KEY_FIELD = "`lang_key`"
const val VERSION_FIELD = "`version`"
}
object Attributes {
val ID_ATTR = ID_FIELD.cleanField()
val LOGIN_ATTR = LOGIN_FIELD.cleanField()
val PASSWORD_ATTR = PASSWORD_FIELD.cleanField()
val EMAIL_ATTR = EMAIL_FIELD.cleanField()
const val LANG_KEY_ATTR = "langKey"
val VERSION_ATTR = VERSION_FIELD.cleanField()
}
object Relations {
const val TABLE_NAME = "`user`"
const val SQL_SCRIPT = """
CREATE TABLE IF NOT EXISTS $TABLE_NAME (
$ID_FIELD UUID default random_uuid() PRIMARY KEY,
$LOGIN_FIELD VARCHAR,
$PASSWORD_FIELD VARCHAR,
$EMAIL_FIELD VARCHAR,
$LANG_KEY_FIELD VARCHAR,
$VERSION_FIELD bigint
);
CREATE UNIQUE INDEX IF NOT EXISTS `uniq_idx_user_login`
ON $TABLE_NAME ($LOGIN_FIELD);
CREATE UNIQUE INDEX IF NOT EXISTS `uniq_idx_user_email`
ON $TABLE_NAME ($EMAIL_FIELD);
"""
@Suppress("SqlDialectInspection")
const val INSERT = """
insert into $TABLE_NAME (
$LOGIN_FIELD, $EMAIL_FIELD,
$PASSWORD_FIELD, $LANG_KEY_FIELD,
$VERSION_FIELD
) values ( :login, :email, :password, :langKey, :version)"""
@JvmStatic
val sqlScript: String
get() = setOf(
UserDao.Relations.SQL_SCRIPT,
RoleDao.Relations.SQL_SCRIPT,
UserRoleDao.Relations.SQL_SCRIPT
).joinToString("")
.trimMargin()
}
object Dao {
val Pair<User, ApplicationContext>.toJson: String
get() = second.getBean<ObjectMapper>().writeValueAsString(first)
suspend fun Pair<User, ApplicationContext>.save(): Either<Throwable, Long> = try {
second.getBean<R2dbcEntityTemplate>()
.databaseClient
.sql(INSERT)
.bind(LOGIN_ATTR, first.login)
.bind(EMAIL_ATTR, first.email)
.bind(PASSWORD_ATTR, first.password)
.bind(LANG_KEY_ATTR, first.langKey)
.bind(VERSION_ATTR, first.version)
.fetch()
.awaitRowsUpdated()
.right()
} catch (e: Throwable) {
e.left()
}
suspend fun ApplicationContext.findOneUserByEmail(
email: String
): Either<Throwable, User> = try {
getBean<DatabaseClient>()
.sql("SELECT * FROM `user` WHERE LOWER(email) = LOWER(:email)")
.bind("email", email)
.fetch()
.awaitOne()
.let { row ->
User(
id = row[ID_ATTR] as UUID?,
login = row[LOGIN_ATTR] as String,
password = row[PASSWORD_ATTR] as String,
email = row[EMAIL_ATTR] as String,
langKey = row[LANG_KEY_ATTR] as String,
version = row[VERSION_ATTR] as Long
)
}.right()
} catch (e: Throwable) {
e.left()
}
}
}
/** Account REST API URIs */
object UserRestApis {
const val API_AUTHORITY = "/api/authorities"
const val API_USERS = "/api/users"
const val API_SIGNUP = "/signup"
const val API_SIGNUP_PATH = "$API_USERS$API_SIGNUP"
const val API_ACTIVATE = "/activate"
const val API_ACTIVATE_PATH = "$API_USERS$API_ACTIVATE?key="
const val API_ACTIVATE_PARAM = "{activationKey}"
const val API_ACTIVATE_KEY = "key"
const val API_RESET_INIT = "/reset-password/init"
const val API_RESET_FINISH = "/reset-password/finish"
const val API_CHANGE = "/change-password"
const val API_CHANGE_PATH = "$API_USERS$API_CHANGE"
}
}
// Abstract entity model with Generic ID, which can be of any type
abstract class EntityModel<T>(
open val id: T? = null
) {
companion object {
const val ID_MEMBER = "id"
}
}
// Generic extension function that allows the ID to be applied to any EntityModel type
inline fun <reified T : EntityModel<ID>, ID> T.withId(id: ID): T {
// Use reflection to create a copy with the passed ID
return this::class.constructors.first { it.parameters.any { param -> param.name == ID_MEMBER } }
.call(id, *this::class.constructors.first().parameters.drop(1).map { param ->
this::class.members.first { member -> member.name == param.name }.call(this)
}.toTypedArray())
}
As diferentes abordagens
A abordagem clássica com `when
val user: User by lazy { userFactory(USER) }
val result: Either<Throwable, User> = context.findOneUserByEmail(user.email)
when (result) {
is Either.Left -> {
val error = result.value
println("Erreur : ${error.message}")
}
is Either.Right -> {
val user = result.value
println("Utilisateur trouvé : ${user.login}")
}
}
Este método, embora simples e legível, não aproveita plenamente as capacidades funcionais do Arrow.
Uso de fold para uma abordagem mais concisa
result.fold(
{ error -> println("Erreur : ${error.message}") },
{ user -> println("Utilisateur trouvé : ${user.login}") }
)
`fold`permite definir ações para os dois casos (Left e Right) de forma concisa e elegante.
Transformação com map e `mapLeft
val processedResult = result
.map { user -> "Utilisateur trouvé : ${user.login}" }
.mapLeft { error -> "Erreur : ${error.message}" }
println(processedResult.merge())
Esta abordagem permite transformar os valores contidos em Either, preservando sua estrutura, ideal para cadeias de processamento mais complexas.
Tratamento de erros com `getOrElse
val user = result.getOrElse { error ->
println("Erreur : ${error.message}")
User(login = "default", email = "[email protected]") // utilisateur par défaut
}
println("Login : ${user.login}")
`getOrElse`oferece um tratamento elegante de erros ao permitir fornecer um valor padrão.
Ações laterais com onLeft e `onRight
result.onLeft { error -> println("Erreur : ${error.message}") }
.onRight { user -> println("Utilisateur trouvé : ${user.login}") }
Esses métodos permitem executar ações em cada lado sem modificar o Either, perfeito para o registro ou os efeitos secundários leves.
Encadeamento de operações com `flatMap
fun findUser(email: String): Either<Throwable, User> = // ... implémentation
fun getUserPermissions(user: User): Either<Throwable, List<String>> = // ... implémentation
val userPermissions = findUser("[email protected]")
.flatMap { user -> getUserPermissions(user) }
flatMap`é útil para encadear operações que retornam elas próprias`Either, evitando assim os`Either`aninhados.
Transformação bidirecional com `bimap
val result: Either<Throwable, User> = // ... obtention du résultat
val processedResult = result.bimap(
{ error -> "Erreur: ${error.message}" },
{ user -> "Utilisateur: ${user.login}" }
)
`bimap`permite transformar tanto o lado esquerdo quanto o lado direito em uma única operação.
Inversão dos lados com `swap
val result: Either<Throwable, User> = // ... obtention du résultat
val swapped = result.swap()
swap`é útil quando você quiser inverter os lados de um`Either, por exemplo para adaptar a interface de uma função para outra.
Utilização de tap e tapLeft :
result.tap { user -> println("Utilisateur trouvé : ${user.login}") }
.tapLeft { error -> println("Erreur : ${error.message}") }
Similar a`onLeft` et onRight, mas esses métodos retornam o Either original, o que é útil para o encadeamento de operações.
Utilização de recover :
val recoveredUser = result.recover { error ->
println("Erreur récupérée : ${error.message}")
User(login = "recovered", email = "[email protected]")
}
println("Login : ${recoveredUser.login}")
Este método permite transformar um Either.Left em Either.Right fornecendo um valor de substituição.
Casos de uso práticos
Utilize`fold`para operações simples que exigem um tratamento para cada caso. - Prefiram`map` et mapLeft`para transformações de dados sem mudar a estrutura da`Either. - Opte por`flatMap`durante o encadeamento de operações que podem falhar. Use`recover`para fornecer um valor padrão em caso de erro. Escolha`onLeft` et onRight (ou tap et tapLeft) para efeitos colaterais como logging. Use`bimap`para transformar os dois lados em uma única operação. - Aplique`swap`quando você precisar adaptar a interface de uma função para outra.
Conclusão
Cada uma dessas abordagens tem suas vantagens de acordo com o contexto de uso. Os métodos como`fold`, map/mapLeft, et `recover`são particularmente úteis quando você deseja encadear várias operações ou transformar os dados de forma funcional.
A mônade`Either`O d’Arrow oferece uma flexibilidade notável para lidar com os casos de sucesso e erro em suas aplicações Kotlin. Ao dominar essas diferentes abordagens, você será capaz de escrever um código mais robusto, mais legível e mais funcional.
No seu próximo projeto, não hesite em explorar essas técnicas para tirar o máximo proveito da programação funcional com Kotlin e Arrow!
Para ir além
-
Documentação oficial do Arrow :https://arrow-kt.io/docs/apidocs/arrow-core/arrow.core/-either/[Seta Ou] - Kotlin Coroutines com Arrow :https://arrow-kt.io/docs/fx/[Flecha Fx Corrotinas]
Não se esqueça de compartilhar suas experiências e suas técnicas favoritas para trabalhar com`Either`nos comentários abaixo !