JSON → Kotlin データクラス
JSONからkotlinx.serialization用のKotlin data classを生成。import付き、値に応じてInt / Long / Double、型が決まらない値はJsonElement、ネストオブジェクト対応。ブラウザで動作。
- ブラウザ内で処理
- ツールの入力を ZeroTool のサーバーにアップロードしません
- 無料 · 登録不要
WeChat でスキャンしてシェア
例・詳しい説明・よくある質問 実際の出力つきの例、ほかのツールとの違い、よくある質問。
型マッピング
- 文字列 →
String、真偽値 →Boolean - −2,147,483,648〜2,147,483,647 の整数 →
Int、それより大きい →Long、Longの範囲外 →Double - 小数点か指数を含む数値(
9.5、19.0、1e3)→Double - 配列 →
List<T>。Int・Long・Doubleが混ざると最も広い型、それ以外の混在と空配列はList<JsonElement> null→ Nullable 型、常にnullのフィールド →JsonElement?- ネストしたオブジェクト → 別の
data class、空オブジェクト{}→class Name(data class にはプロパティが 1 つ以上必要)
例:snake_case の API レスポンス
snake_case のキー、null のフィールド、Int.MAX_VALUE を超えるカウンター、4.0 と書かれた評価を含む入力:
{"user_id": 1024, "display_name": "Alice", "is_active": true, "last_login": null, "follower_count": 3000000000, "rating": 4.0, "tags": ["admin", "editor"], "address": {"city": "Tokyo", "zip_code": "100-0001"}}
出力:
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.JsonElement
@Serializable
data class RootObject(
@SerialName("user_id")
val userId: Int = 0,
@SerialName("display_name")
val displayName: String = "",
@SerialName("is_active")
val isActive: Boolean = false,
@SerialName("last_login")
val lastLogin: JsonElement? = null,
@SerialName("follower_count")
val followerCount: Long = 0L,
val rating: Double = 0.0,
val tags: List<String> = emptyList(),
val address: Address = Address()
)
@Serializable
data class Address(
val city: String = "",
@SerialName("zip_code")
val zipCode: String = ""
)
camelCase 名が JSON キーと異なるフィールドは @SerialName で元のキーを保持します。キーに使われた Kotlin のキーワード(class、in、fun)はバッククォートで囲みます。文字も数字も含まないキー(空のキー "" や "-" など)はプロパティ field(次は field2)になり、元のキーは @SerialName に残ります。Kotlin 2.4.20 は _ という名前のプロパティを受け付けません。last_login はサンプルでは null だけなので JsonElement? になります。タイムスタンプだとわかったら String? に変えてください。
例:オブジェクトの配列
ルートが配列のときは、すべてのオブジェクトを 1 つのクラスにまとめます。price は 2 と 1.5 なので Double になります。一部の要素にしかないキーは Nullable で、既定値は null です。
[{"id": 1, "name": "Pen", "price": 2}, {"id": 2, "name": "Ink", "price": 1.5, "discount": 0.1}]
import kotlinx.serialization.Serializable
@Serializable
data class RootObject(
val id: Int = 0,
val name: String = "",
val price: Double = 0.0,
val discount: Double? = null
)
ステータス行に List<RootObject> としてデコードするよう表示されます。
例:同じ名前のキー、異なるオブジェクト
フィールドの異なる meta が 2 つあると、クラスも 2 つ生成され、2 つ目には親の名前が前に付きます。
{"order": {"id": 7, "meta": {"source": "web"}}, "payment": {"meta": {"method": "card", "last4": "4242"}}}
import kotlinx.serialization.Serializable
@Serializable
data class RootObject(
val order: Order = Order(),
val payment: Payment = Payment()
)
@Serializable
data class Order(
val id: Int = 0,
val meta: Meta = Meta()
)
@Serializable
data class Meta(
val source: String = ""
)
@Serializable
data class Payment(
val meta: PaymentMeta = PaymentMeta()
)
@Serializable
data class PaymentMeta(
val method: String = "",
val last4: String = ""
)
例:郵便番号検索 API の正常応答とエラー応答
zipcloud の郵便番号検索 API(日本郵便の郵便番号データを検索する REST API)は、ドキュメントに正常時とエラー時のレスポンスサンプルを載せています。まず正常時のサンプルをそのまま貼り付けます。
{"message": null, "results": [{"address1": "北海道", "address2": "美唄市", "address3": "上美唄町協和", "kana1": "ホッカイドウ", "kana2": "ビバイシ", "kana3": "カミビバイチョウキョウワ", "prefcode": "1", "zipcode": "0790177"}, {"address1": "北海道", "address2": "美唄市", "address3": "上美唄町南", "kana1": "ホッカイドウ", "kana2": "ビバイシ", "kana3": "カミビバイチョウミナミ", "prefcode": "1", "zipcode": "0790177"}], "status": 200}
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.JsonElement
@Serializable
data class RootObject(
val message: JsonElement? = null,
val results: List<ResultsItem> = emptyList(),
val status: Int = 0
)
@Serializable
data class ResultsItem(
val address1: String = "",
val address2: String = "",
val address3: String = "",
val kana1: String = "",
val kana2: String = "",
val kana3: String = "",
val prefcode: String = "",
val zipcode: String = ""
)
サンプルで常に null の message は JsonElement?、results は List<ResultsItem> で null を許しません。このクラスでドキュメントのエラー時サンプル {"message": "必須パラメータが指定されていません。", "results": null, "status": 400} をデコードすると、results の null を受け付けず JsonDecodingException になります。半角カナの kana1 などはそのまま String です。郵便番号 "0790177" も文字列なので、先頭の 0 は消えません。
正常時とエラー時のサンプルを配列にまとめて生成すると、両方を見た型になります。
[{"message": null, "results": [{"address1": "北海道", "address2": "美唄市", "address3": "上美唄町協和", "kana1": "ホッカイドウ", "kana2": "ビバイシ", "kana3": "カミビバイチョウキョウワ", "prefcode": "1", "zipcode": "0790177"}, {"address1": "北海道", "address2": "美唄市", "address3": "上美唄町南", "kana1": "ホッカイドウ", "kana2": "ビバイシ", "kana3": "カミビバイチョウミナミ", "prefcode": "1", "zipcode": "0790177"}], "status": 200}, {"message": "必須パラメータが指定されていません。", "results": null, "status": 400}]
import kotlinx.serialization.Serializable
@Serializable
data class RootObject(
val message: String? = null,
val results: List<ResultsItem>? = null,
val status: Int = 0
)
@Serializable
data class ResultsItem(
val address1: String = "",
val address2: String = "",
val address3: String = "",
val kana1: String = "",
val kana2: String = "",
val kana3: String = "",
val prefcode: String = "",
val zipcode: String = ""
)
message は文字列と null の両方を見たので String?、results は List<ResultsItem>? になりました。ステータス行には配列として List<RootObject> でデコードするよう表示されますが、API が返すのは毎回 1 件のオブジェクトなので、実際には Json.decodeFromString<RootObject>(body) で 1 件ずつ読みます。正常時もエラー時もこのクラスでデコードできることを確認しています。
デコード
ビルド設定にシリアライゼーションプラグインと JSON ライブラリを追加し(Kotlin のシリアライゼーションガイド参照)、次のようにデコードします。
import kotlinx.serialization.json.Json
val user = Json.decodeFromString<RootObject>(body)
val items = Json.decodeFromString<List<RootObject>>(arrayBody)
// サンプルにないキーを許容する
val lenient = Json { ignoreUnknownKeys = true }
既定の Json はクラスにないキーをエラーにします。このページの例はすべて Kotlin 2.4.20 と kotlinx.serialization 1.11.0 でコンパイルし、既定の設定でデコードできることを確認しています。
制限事項
- 型は 1 つのサンプルだけから決まります。サンプルで小さい ID は
Intになるので、本番の ID が 2,147,483,647 を超えるならLongに直してください。 - ブラウザは JSON の数値を 64 ビット浮動小数点で読むため、9,007,199,254,740,991 を超える整数は型を決める前に桁が落ちます。型は
Longのままですが、範囲は手で確認してください。 19.0を小数と判定できるのは、JSON.parseにソーステキストを渡すブラウザ(Chrome 114+、Firefox 135+、Safari 18.4+)だけです。古いブラウザではIntになります。JsonElementのフィールドはJson形式でだけ使え、CBOR や ProtoBuf では使えません。- 日付は
Stringのままです。JSON に日付型はないので、デコード後に解析するかカスタムシリアライザーを追加してください。 - すべてのプロパティに既定値があるため、キーが欠けても黙って既定値になります。必須のキーは既定値を削除してください。
FAQ
何が生成されますか?
@Serializable(kotlinx.serialization)を付けた Kotlin の data class と、必要な import です。ネストしたオブジェクトはそれぞれ別のクラスになります。kotlinx.serialization のコンパイラプラグインを入れればそのままコンパイルでき、既定の Json 設定でサンプルをデコードできます。
Nullable なフィールドはどう扱われますか?
値が null のフィールドは Nullable 型(例: String?)になります。配列の一部の要素にしかないキーも Nullable で、既定値は null です。サンプルで常に null のフィールドは、本当の型がわからないため JsonElement? になります。
各型の既定値は?
String は ""、Int は 0、Long は 0L、Double は 0.0、Boolean は false、List は emptyList()、JsonElement は JsonNull、Nullable 型は null、ネストしたクラスは引数なしコンストラクターです。既定値があるため、キーが欠けていてもデコードできます。
Any ではなく JsonElement を使うのはなぜですか?
kotlinx.serialization には Any のシリアライザーがなく、Any のフィールドを持つ @Serializable クラスはコンパイルできません。JsonElement は形が決まらない JSON のためにライブラリが用意している型で、常に null のフィールド、空配列、サンプル間で型が異なる値に使います。
データはサーバーに送信されますか?
いいえ。JSON はこのブラウザのタブ内で変換し、サーバーに送信することも、ブラウザのストレージに保存することもありません。ページのアクセス解析が記録するのは、入力を編集してフォーカスを外したとき、「Kotlin を生成」を押したとき(Ctrl/⌘+Enter を含む)、「サンプル」を押したときの利用イベント(ツール名と動作 generate)だけで、JSON の内容は含みません。