データ変換
コード例: data-conversion
必要な依存関係: io.ktor:ktor-server-data-conversion
ネイティブサーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✅
DataConversion プラグインを使用すると、値のリストをシリアライズおよびデシリアライズできます。デフォルトでは、Ktor は DefaultConversionService を介して、文字列や、数値型、符号なし整数型、Uuid、enum などの一般的な型を処理します。
DataConversion プラグインをインストールして設定することで、このサービスを拡張して追加の型を処理できるようになります。
依存関係の追加
DataConversion を使用するには、ビルドスクリプトに ktor-server-data-conversion アーティファクトを追加します。
implementation(ktorLibs.server.dataConversion)implementation ktorLibs.server.dataConversion<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-data-conversion-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>DataConversion のインストール
アプリケーションに DataConversion プラグインをインストールするには、指定した モジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。 内の install 関数に渡します。 以下の例は、DataConversion をインストールする方法を示しています。
embeddedServer()関数の呼び出し内。Applicationクラスに明示的に定義されたmodule()拡張関数内。
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.dataconversion.*
fun main() {
embeddedServer(Netty, port = 8080) {
install(DataConversion)
// ...
}.start(wait = true)
}import io.ktor.server.application.*
import io.ktor.server.plugins.dataconversion.*
// ...
fun Application.module() {
install(DataConversion)
// ...
}コンバーターの追加
DataConversion の設定内で型変換を定義できます。指定した型に対して convert<T> メソッドを提供し、利用可能な関数を使用して値のリストをシリアライズおよびデシリアライズします。
値のリストをデシリアライズするには、
decode()関数を使用します。これは URL 内の重複する値を表す文字列のリストを受け取り、デコードされた値を返します。kotlindecode { values -> // converter: (values: List<String>) -> Any? //deserialize values }値をシリアライズするには、
encode()関数を使用します。この関数は任意の値を受け取り、それを表す文字列のリストを返します。kotlinencode { value -> // converter: (value: Any?) -> List<String> //serialize value }
サービスへのアクセス
現在のコンテキストから DataConversion サービスにアクセスできます。
val dataConversion = application.conversionServiceその後、コンバーターサービスを使用してコールバック関数を呼び出すことができます。
fromValues(values: List<String>, type: TypeInfo)コールバック関数は、文字列のリストとしてのvaluesと、変換先の型を表すTypeInfoを受け取り、デコードされた値を返します。toValues(value: Any?)コールバック関数は、任意の値を受け取り、それを表す文字列のリストを返します。
例
以下の例では、LocalDate 型のコンバーターを定義し、値をシリアライズおよびデシリアライズするように設定しています。encode 関数が呼び出されると、サービスは SimpleDateFormat を使用して値を変換し、フォーマットされた値を含むリストを返します。 decode 関数が呼び出されると、サービスは日付を LocalDate として変換して返します。
install(DataConversion) {
convert<LocalDate> { // this: DelegatingConversionService
val formatter = DateTimeFormatterBuilder()
.appendValue(ChronoField.YEAR, 4, 4, SignStyle.NEVER)
.appendValue(ChronoField.MONTH_OF_YEAR, 2)
.appendValue(ChronoField.DAY_OF_MONTH, 2)
.toFormatter(Locale.ROOT)
decode { values -> // converter: (values: List<String>) -> Any?
LocalDate.from(formatter.parse(values.single()))
}
encode { value -> // converter: (value: Any?) -> List<String>
listOf(SimpleDateFormat.getInstance().format(value))
}
}
}その後、変換サービスを手動で呼び出して、エンコードされた値およびデコードされた値を取得できます。
val encodedDate = application.conversionService.toValues(call.parameters["date"])
val decodedDate = application.conversionService.fromValues(encodedDate, typeInfo<LocalDate>())完全な例については、data-conversion を参照してください。
