Konvert

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

Voici Konvert, un générateur de code de mappage Kotlin utilisant Kotlin Symbol Processing (KSP). Conçu spécifiquement pour Kotlin et ses fonctionnalités, Konvert prend en charge un large éventail de cas d'utilisation.

Fonctionnalités principales :

• 🧩 supporte divers types de classes → data, enum, value, POJO classiques
• 🔄 Sécurité null par défaut
• ⚙️ Conversions intelligentes (Int → String, Instant → Date, …)
• 🔧 Définir des convertisseurs réutilisables avec @Konverter
• 🔌 Étendre via SPI pour un contrôle ultime
• 🔗 Collections & maps — mappage des éléments inclus
• 🛠️ Personnalisation fine du mappage des propriétés
• ☕ 100% Interopérabilité Java
• ✨ Génère un code Kotlin propre et idiomatique
• ⏱️ Généré à la compilation
• 🚫 Zéro réflexion, aucune surcharge à l'exécution
• 📦 Fonctionne parfaitement avec Gradle et Maven

Utilisation

Il existe trois façons différentes d’utiliser Konvert :

• Utilisation de @KonvertTo :

   @KonvertTo(PersonDto::class)
   data class Person(val firstName: String, val lastName: String)
   data class PersonDto(val firstName: String, val lastName: String)
   ``
   Cela générera la fonction d'extension suivante
   `kotlin
   fun Person.toPersonDto(): PersonDto =
      PersonDto(firstName = firstName, lastName = lastName)
   `
Utilisation de @KonvertFrom (particulièrement utile si vous ne pouvez pas modifier le code de la classe source)
   
`kotlin
   class Person(val firstName: String, val lastName: String) {
      @KonvertFrom(PersonDto::class)
      companion object
   }
   class PersonDto(val firstName: String, val lastName: String)
   `
   Cela générera la fonction d'extension suivante
   `kotlin
   fun Person.Companion.fromPersonDto(personDto: PersonDto): Person =
      Person(firstName = personDto.firstName, lastName = personDto.lastName)
   `
Utilisation de @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
   }
   `
   Cela générera l'objet suivant
   `kotlin
   object PersonMapperImpl: PersonMapper {
      override fun toDto(person: Person): PersonDto
         = PersonDto(firstName = person.firstName, lastName = person.lastName)
   }
   `
Pour un exemple de projet simple, consultez le répertoire example.
Correspondances de types
Pour des correspondances de types simples, comme de Instant à Date, un convertisseur de type est déjà fourni avec Konvert :

Cela générera la fonction d'extension suivante

Consultez la documentation pour une liste des convertisseurs de types fournis.
🛈 : Vous pouvez également créer votre propre bibliothèque de convertisseurs de types en
implémentant TypeConverter et en l'enregistrant
via SPI.
Ajustement fin
La plupart du temps, les classes source et cible peuvent ne pas avoir les mêmes noms et types de propriétés.
Vous pouvez configurer des mappages spécifiques et renommer la fonction d’extension générée ainsi :

Cela générera la fonction d'extension suivante

• Ajoutez konvert-api comme dépendance pour utiliser les annotations :

• Ajoutez konvert en tant que dépendance ksp :

• Ajoutez konvert-api en tant que dépendance pour utiliser les annotations :

• Utilisez le ksp-maven-plugin avec konvert comme dépendance :

Par défaut, seul un sous-ensemble des tests disponibles est exécuté, ce qui devrait vérifier la plupart des fonctionnalités de Konvert. Pour exécuter tous les tests, ajoutez la propriété runAllTests, par exemple :

gradle test -PrunAllTests

Documentation

Pour servir le site Jekyll localement, exécutez simplement la commande suivante dans docs` :

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

CI

GitHub Actions sont utilisés pour :

• construire et tester
• publier et diffuser vers un dépôt Maven
• générer la documentation et la déployer sur GitHub Pages.

Journal des modifications

Le journal des modifications contient tous les changements notables.

Licence

Copyright 2023 Marcel Carlé

Sous licence Apache, version 2.0 (la "Licence"); vous ne pouvez utiliser ce fichier que conformément à la Licence. Vous pouvez obtenir une copie de la Licence à

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

Sauf exigence légale ou accord écrit, le logiciel distribué sous la Licence est distribué "EN L’ÉTAT", SANS GARANTIES NI CONDITIONS D'AUCUNE SORTE, explicites ou implicites. Consultez la Licence pour les permissions spécifiques régissant et les limitations sous la Licence.

[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 ---