Konvert

[![Maven Central][maven-image]][maven-url] [![License][license-image]](LICENSE) [![Code Coverage][codecov-image]][codecov-url]

Este es Konvert, un generador de código de mapeo para Kotlin que utiliza Kotlin Symbol Processing (KSP). Diseñado específicamente para Kotlin y sus características, Konvert soporta una amplia gama de casos de uso.

Características principales:

• 🧩 soporta varios tipos de clases → data, enum, value, POJOs regulares
• 🔄 Seguro contra nulos por defecto
• ⚙️ Conversiones inteligentes (Int → String, Instant → Date, …)
• 🔧 Define convertidores reutilizables con @Konverter
• 🔌 Extiende mediante SPI para control total
• 🔗 Colecciones y mapas — mapeo de elementos incluido
• 🛠️ Personalización detallada del mapeo de propiedades
• ☕ 100% interoperabilidad con Java
• ✨ Genera código Kotlin limpio e idiomático
• ⏱️ Generado en tiempo de compilación
• 🚫 Cero reflexión, cero sobrecarga en tiempo de ejecución
• 📦 Funciona perfectamente con Gradle y Maven

Uso

Hay tres maneras diferentes de usar Konvert:

• Usando @KonvertTo:

   @KonvertTo(PersonDto::class)
   data class Person(val firstName: String, val lastName: String)
   data class PersonDto(val firstName: String, val lastName: String)
   ``
   Esto generará la siguiente función de extensión
   `kotlin
   fun Person.toPersonDto(): PersonDto =
      PersonDto(firstName = firstName, lastName = lastName)
   `
Usando @KonvertFrom (especialmente útil si no puedes cambiar el código de la clase fuente)

   
`kotlin
   class Person(val firstName: String, val lastName: String) {
      @KonvertFrom(PersonDto::class)
      companion object
   }
   class PersonDto(val firstName: String, val lastName: String)
   `
   Esto generará la siguiente función de extensión
   `kotlin
   fun Person.Companion.fromPersonDto(personDto: PersonDto): Person =
      Person(firstName = personDto.firstName, lastName = personDto.lastName)
   `
Usando @Konverter:

   
`kotlin
   class Person(val firstName: String, val lastName: String)
   data class PersonDto(val firstName: String, val lastName: String)
   @Konverter
   interface PersonMapper {
      fun toDto(person: Person): PersonDto
   }
   `
   Esto generará el siguiente objeto
   `kotlin
   object PersonMapperImpl: PersonMapper {
      override fun toDto(person: Person): PersonDto
         = PersonDto(firstName = person.firstName, lastName = person.lastName)
   }
   `
Para un proyecto de ejemplo simple, eche un vistazo al directorio de ejemplo.
Mapeos de tipos
Para mapeos de tipos simples, como de Instant a Date, ya existe un convertidor de tipos proporcionado con Konvert:

Esto generará la siguiente función de extensión

Echa un vistazo a la documentación para una lista de convertidores de tipo proporcionados.
🛈: También puedes crear tu propia biblioteca de convertidores de tipo
implementando TypeConverter y registrarla
usando SPI.
Ajuste fino
La mayoría de las veces, las clases origen y destino pueden no tener los mismos nombres y tipos de propiedades.
Puedes configurar mapeos específicos y renombrar la función de extensión generada así:

Esto generará la siguiente función de extensión

• Añade konvert-api como dependencia para usar las anotaciones:

• Añada konvert como una dependencia de ksp:

• Agrega konvert-api como dependencia para usar las anotaciones:

• Use el ksp-maven-plugin con konvert como dependencia:

Por defecto, solo se ejecuta un subconjunto de las pruebas disponibles, que deberían verificar la mayoría de la funcionalidad de Konvert. Para ejecutar todas las pruebas, añade la propiedad runAllTests, por ejemplo:

gradle test -PrunAllTests

Documentación

Para servir el sitio Jekyll localmente, simplemente ejecuta el siguiente comando dentro de docs`:

docker run --rm -it -v "$PWD":/site -p 4000:4000 bretfisher/jekyll-serve

CI

GitHub Actions se usan para:

• compilar y probar
• lanzar y publicar en un repositorio Maven
• generar documentación y desplegarla en GitHub Pages.

Registro de cambios

El registro de cambios contiene todos los cambios notables.

Licencia

Copyright 2023 Marcel Carlé

Licenciado bajo la Licencia Apache, Versión 2.0 (la "Licencia"); no puedes usar este archivo excepto en conformidad con la Licencia. Puedes obtener una copia de la Licencia en

http://www.apache.org/licenses/LICENSE-2.0

A menos que lo exija la ley aplicable o se acuerde por escrito, el software distribuido bajo la Licencia se distribuye "TAL CUAL", SIN GARANTÍAS NI CONDICIONES DE NINGÚN TIPO, ya sean expresas o implícitas. Consulte la Licencia para conocer el idioma específico que rige los permisos y limitaciones bajo la Licencia.

[maven-image]: https://img.shields.io/maven-central/v/io.mcarle/konvert.svg

[maven-url]: https://central.sonatype.com/artifact/io.mcarle/konvert/

[license-image]: https://img.shields.io/github/license/mcarleio/konvert.svg

[codecov-image]: https://img.shields.io/codecov/c/github/mcarleio/konvert.svg

[codecov-url]: https://codecov.io/gh/mcarleio/konvert

--- Tranlated By Open Ai Tx | Last indexed: 2026-04-08 ---