Kotlin Arrow : Dominar la navegación en la mónada Either
Publié le 24 September 2024
- Introducción
- ¿Qué es la mónada Either?
- Contexto
- Los diferentes enfoques
- El enfoque clásico con `when
- Uso de
foldpara un enfoque más conciso - Transformación con
mapy `mapLeft - Gestión de errores con `getOrElse
- Acciones laterales con
onLefty `onRight - Encadenamiento de operaciones con `flatMap
- Transformación bidireccional con `bimap
- Inversión de los lados con `swap
- Uso de
tapytapLeft: - Uso de
recover:
- Casos de uso prácticos
- Conclusión
- Para ir más lejos
Introducción
En el mundo de la programación funcional en Kotlin, la biblioteca Arrow ofrece herramientas poderosas para manejar errores y casos alternativos. Entre estas herramientas, la mónada`Either`se distingue por su capacidad para representar dos estados posibles: éxito (Right) o fracaso (Left). Pero, ¿cómo navegar eficazmente entre estos dos estados? Eso es lo que vamos a explorar en este artículo.
¿Qué es la mónada Either?
La monada`Either`es una estructura de datos que representa dos posibilidades mutuamente excluyentes. En Kotlin con Arrow, se utiliza a menudo para manejar los casos de éxito y error de una operación, proporcionando una alternativa elegante a las excepciones tradicionales.
¿Por qué usar Either?
-
Gestión explícita de errores: Obliga al desarrollador a considerar los casos de fallo.
-
Composición funcional: Facilita el encadenamiento de operaciones que pueden fallar.
-
Type-safety: Los errores están tipados, lo que ayuda a gestionarlos de manera más precisa.
-
Sin excepciones: Evita los efectos secundarios y las interrupciones inesperadas del flujo de ejecución.
Contexto
Imaginemos que estás desarrollando una API REST conhttps://spring.io/projects/spring-boot/[Spring Boot,windows=read-later] et Kotlin, utilizando la bibliotecahttps://arrow-kt.io/[Arrow,windows=read-later]. Tienes una función`findOneUserByEmail`que devuelve un`Either<Throwable, User>`. ¿Cómo puede tratar este resultado de manera elegante y funcional ?
Tenemos una clase 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())
}
Los diferentes enfoques
El enfoque clásico con `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, aunque simple y legible, no aprovecha plenamente las capacidades funcionales de Arrow.
Uso de fold para un enfoque más conciso
result.fold(
{ error -> println("Erreur : ${error.message}") },
{ user -> println("Utilisateur trouvé : ${user.login}") }
)
`fold`permite definir acciones para los dos casos (Left y Right) de forma concisa y elegante.
Transformación con map y `mapLeft
val processedResult = result
.map { user -> "Utilisateur trouvé : ${user.login}" }
.mapLeft { error -> "Erreur : ${error.message}" }
println(processedResult.merge())
Este enfoque permite transformar los valores contenidos en Either manteniendo su estructura, ideal para cadenas de procesamiento más complejas.
Gestión de errores con `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`Ofrece un manejo elegante de errores permitiendo proporcionar un valor por defecto
Acciones laterales con onLeft y `onRight
result.onLeft { error -> println("Erreur : ${error.message}") }
.onRight { user -> println("Utilisateur trouvé : ${user.login}") }
Estos métodos permiten realizar acciones en cada lado sin modificar Either, perfecto para el registro o los efectos secundarios ligeros.
Encadenamiento de operaciones con `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`es útil para encadenar operaciones que devuelven ellas mismas de`Either, evitando así los`Either`anidados.
Transformación bidireccional con `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 el lado izquierdo como el derecho en una sola operación.
Inversión de los lados con `swap
val result: Either<Throwable, User> = // ... obtention du résultat
val swapped = result.swap()
swap`es útil cuando quieres invertir los lados de un`Either, por ejemplo para adaptar la interfaz de una función a otra.
Uso de tap y tapLeft :
result.tap { user -> println("Utilisateur trouvé : ${user.login}") }
.tapLeft { error -> println("Erreur : ${error.message}") }
Similar a`onLeft` et onRight, pero estos métodos devuelven el Either original, lo cual es útil para encadenar operaciones.
Uso 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 un Either.Left en Either.Right proporcionando un valor de reemplazo.
Casos de uso prácticos
-
Use`fold`para operaciones simples que requieren un tratamiento para cada caso. - prefieran`map` et
mapLeft`para de las transformaciones de datos sin cambiar la estructura de l'`Either. - Opte por`flatMap`al encadenar operaciones que pueden fallar. emplead`recover`para proporcionar un valor predeterminado en caso de error - Eligan`onLeft` etonRight(outapettapLeft) para efectos secundarios como el logging. - Utilice`bimap`para transformar ambos lados en una sola operación - Aplica`swap`Cuando debas adaptar la interfaz de una función a otra
Conclusión
Cada una de estas aproximaciones tiene sus ventajas según el contexto de uso. Los métodos como`fold`, map/mapLeft, et `recover`son especialmente útiles cuando usted quiere encadenar varias operaciones o transformar los datos de manera funcional.
La monada`Either`d’Arrow ofrece una flexibilidad notable para manejar los casos de éxito y error en tus aplicaciones Kotlin. Al dominar estos diferentes enfoques, podrás escribir un código más robusto, más legible y más funcional.
En tu próximo proyecto, no dudes en explorar estas técnicas para aprovechar al máximo la programación funcional con Kotlin y Arrow!
Para ir más lejos
-
Documentación oficial de Arrow :https://arrow-kt.io/docs/apidocs/arrow-core/arrow.core/-either/[Arrow Either] - Corrutinas de Kotlin con Arrow :https://arrow-kt.io/docs/fx/[Arrow Fx Coroutines]
No olviden de compartir tus experiencias y tus técnicas favoritas para trabajar con`Either`¡En los comentarios de abajo!