Konvert

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

これは Konvert です。Kotlin のマッピングコードジェネレーターで、Kotlin Symbol Processing (KSP) を使用しています。 Kotlin とその機能向けに特化して設計されており、Konvert は幅広いユースケースをサポートします。

主な特徴:

• 🧩 さまざまなクラス種別 をサポート → data、enum、value、通常の POJO
• 🔄 デフォルトで Null 安全
• ⚙️ スマート変換 (Int → String、Instant → Date、など)
• 🔧 @Konverter で 再利用可能なコンバーター を定義可能
• 🔌 SPI による拡張で究極の制御を実現
• 🔗 コレクション & マップ — 要素のマッピングを含む
• 🛠️ 細かい プロパティマッピングのカスタマイズ
• ☕ 100% Java との相互運用性
• ✨ クリーンで慣用的な Kotlin コードを生成
• ⏱️ コンパイル時 に生成
• 🚫 リフレクションなし、実行時オーバーヘッドなし
• 📦 Gradle と Maven とシームレスに連携

使い方

Konvert の使用方法は3通りあります:

• @KonvertTo を使用する:

   @KonvertTo(PersonDto::class)
   data class Person(val firstName: String, val lastName: String)
   data class PersonDto(val firstName: String, val lastName: String)
   ``
   これにより、次の拡張関数が生成されます
   `kotlin
   fun Person.toPersonDto(): PersonDto =
      PersonDto(firstName = firstName, lastName = lastName)
   `
@KonvertFrom を使用する（特に、ソースクラスのコードを変更できない場合に便利）
   
`kotlin
   class Person(val firstName: String, val lastName: String) {
      @KonvertFrom(PersonDto::class)
      companion object
   }
   class PersonDto(val firstName: String, val lastName: String)
   `
   これにより、次の拡張関数が生成されます
   `kotlin
   fun Person.Companion.fromPersonDto(personDto: PersonDto): Person =
      Person(firstName = personDto.firstName, lastName = personDto.lastName)
   `
@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
   }
   `
   これにより、次のオブジェクトが生成されます
   `kotlin
   object PersonMapperImpl: PersonMapper {
      override fun toDto(person: Person): PersonDto
         = PersonDto(firstName = person.firstName, lastName = person.lastName)
   }
   `
簡単なサンプルプロジェクトについては、exampleディレクトリを参照してください。
型マッピング
InstantからDateのような単純な型マッピングの場合、Konvertにはすでに型コンバーターが用意されています：

これにより、以下の拡張関数が生成されます。

ドキュメントを参照して、提供されている型変換器の一覧を確認してください。
🛈: 独自の型変換ライブラリも作成可能で、
TypeConverterを実装し、
SPIを使って登録できます。
詳細設定
多くの場合、ソースクラスとターゲットクラスではプロパティ名や型が一致しません。
特定のマッピングを設定し、生成される拡張関数の名前を変更することができます:

これにより、次の拡張関数が生成されます

• アノテーションを使用するためにkonvert-apiを依存関係として追加します：

• konvert を ksp 依存関係として追加します:

• アノテーションを使用するために konvert-api を依存関係として追加します：

• 依存関係として konvert を使用し、ksp-maven-plugin を使用します:

デフォルトでは、利用可能なテストのサブセットのみが実行されますが、これによりKonvertのほとんどの機能が検証されます。 すべてのテストを実行するには、プロパティ runAllTests を追加してください。例：

gradle test -PrunAllTests

ドキュメント

Jekyllサイトをローカルで提供するには、docs` 内で以下のコマンドを実行します：

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

CI

GitHub Actionsは以下の用途で使用されています：

• ビルドとテスト
• リリースと公開 をMavenリポジトリへ
• ドキュメント生成 とGitHub Pagesへのデプロイ

変更履歴

変更履歴にはすべての重要な変更が記載されています。

ライセンス

Copyright 2023 Marcel Carlé

Apache License, Version 2.0（以下「ライセンス」）の下でライセンスされています。 本ファイルは、ライセンスに従わなければ使用できません。 ライセンスのコピーは以下から入手できます。

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

適用法により要求される場合や書面による同意がない限り、 ライセンスに基づき配布されるソフトウェアは「現状のまま」提供され、

明示的にも黙示的にも、一切の保証または条件なしに提供されます。 ライセンスに記載された特定の言語に従って、許可および 制限事項を参照してください。

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