JSONKit

© 2024 JSONKit

JSONKit

JSON → Java クラス変換ツール

JSONからgetter・setter付きのJavaクラスを生成し、JacksonベースのConverterも作成します。

JSONからJavaのPOJOを生成

JavaでJSONをマッピングするには、オブジェクトごとにprivateフィールド、getter、setter、アノテーションを備えたPOJOを書くのが一般的です。このツールはサンプルからそれらを生成します。各オブジェクトはアクセサにJacksonの@JsonPropertyアノテーションが付いたクラスになり、ネストしたオブジェクトは別のクラスに、配列は型付き配列に、整数はlongになります。fromJsonStringとtoJsonStringメソッドを持つConverterクラスが、日付・時刻のパース用ヘルパーを含めてJacksonのObjectMapperの設定をまとめて引き受けます。

使い方

  1. SpringやAndroidアプリが利用するRESTレスポンスなど、JSONサンプルを貼り付けます。
  2. ルートクラスの名前を入力します（例: Customer）。
  3. MavenまたはGradleのビルドにjackson-databindを追加し、各クラスをパッケージ内の個別の.javaファイルに移して、Converter.fromJsonString(json)を呼び出します。

よくある質問

出力がこれほど長いのはなぜですか？
Javaではフィールド、getter、setterを明示的に書く必要があり、生成されるConverterにはjava.time API用の日時ヘルパーも含まれるためです。モデルだけが必要なら、データクラスだけをコピーして既存のObjectMapperを使ってください。
JavaのrecordやLombokを使うことはできますか？
互換性を最大限に保つため、生成ツールは従来型のクラスを出力します。コピー後にrecord（Java 16以降）に書き換えたり、Lombokの@Dataを付けたりできます。Jacksonはどちらにも対応しています。
Spring Bootで使えますか？
はい。Spring BootはデフォルトでJacksonを使用するため、アノテーション付きのクラスはConverterクラスなしで、そのまま@RequestBodyやレスポンスの型として使えます。

例: JSONからJavaへの変換

入力JSON

{
  "customerId": 501,
  "fullName": "Grace Hopper",
  "vip": true,
  "addresses": [{ "city": "Arlington", "zip": "22201" }]
}

生成されたJava（Customer）

// Converter.java

// To use this code, add the following Maven dependency to your project:
//
//
//     com.fasterxml.jackson.core     : jackson-databind          : 2.9.0
//     com.fasterxml.jackson.datatype : jackson-datatype-jsr310   : 2.9.0
//
// Import this package:
//
//     import io.quicktype.Converter;
//
// Then you can deserialize a JSON string with
//
//     Customer data = Converter.fromJsonString(jsonString);

package io.quicktype;

import java.io.IOException;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import java.util.*;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.time.OffsetTime;
import java.time.ZoneOffset;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeFormatterBuilder;
import java.time.temporal.ChronoField;

public class Converter {
    // Date-time helpers

    private static final DateTimeFormatter DATE_TIME_FORMATTER = new DateTimeFormatterBuilder()
            .appendOptional(DateTimeFormatter.ISO_DATE_TIME)
            .appendOptional(DateTimeFormatter.ISO_OFFSET_DATE_TIME)
            .appendOptional(DateTimeFormatter.ISO_INSTANT)
            .appendOptional(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SX"))
            .appendOptional(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ssX"))
            .appendOptional(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"))
            .toFormatter()
            .withZone(ZoneOffset.UTC);

    public static OffsetDateTime parseDateTimeString(String str) {
        return ZonedDateTime.from(Converter.DATE_TIME_FORMATTER.parse(str)).toOffsetDateTime();
    }

    private static final DateTimeFormatter TIME_FORMATTER = new DateTimeFormatterBuilder()
            .appendOptional(DateTimeFormatter.ISO_TIME)
            .appendOptional(DateTimeFormatter.ISO_OFFSET_TIME)
            .parseDefaulting(ChronoField.YEAR, 2020)
            .parseDefaulting(ChronoField.MONTH_OF_YEAR, 1)
            .parseDefaulting(ChronoField.DAY_OF_MONTH, 1)
            .toFormatter()
            .withZone(ZoneOffset.UTC);

    public static OffsetTime parseTimeString(String str) {
        return ZonedDateTime.from(Converter.TIME_FORMATTER.parse(str)).toOffsetDateTime().toOffsetTime();
    }
    // Serialize/deserialize helpers

    public static Customer fromJsonString(String json) throws IOException {
        return getObjectReader().readValue(json);
    }

    public static String toJsonString(Customer obj) throws JsonProcessingException {
        return getObjectWriter().writeValueAsString(obj);
    }

    private static ObjectReader reader;
    private static ObjectWriter writer;

    private static void instantiateMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.findAndRegisterModules();
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        SimpleModule module = new SimpleModule();
        module.addDeserializer(OffsetDateTime.class, new JsonDeserializer<OffsetDateTime>() {
            @Override
            public OffsetDateTime deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
                String value = jsonParser.getText();
                return Converter.parseDateTimeString(value);
            }
        });
        mapper.registerModule(module);
        reader = mapper.readerFor(Customer.class);
        writer = mapper.writerFor(Customer.class);
    }

    private static ObjectReader getObjectReader() {
        if (reader == null) instantiateMapper();
        return reader;
    }

    private static ObjectWriter getObjectWriter() {
        if (writer == null) instantiateMapper();
        return writer;
    }
}

// Customer.java

package io.quicktype;

import com.fasterxml.jackson.annotation.*;

public class Customer {
    private long customerID;
    private String fullName;
    private boolean vip;
    private Address[] addresses;

    @JsonProperty("customerId")
    public long getCustomerID() { return customerID; }
    @JsonProperty("customerId")
    public void setCustomerID(long value) { this.customerID = value; }

    @JsonProperty("fullName")
    public String getFullName() { return fullName; }
    @JsonProperty("fullName")
    public void setFullName(String value) { this.fullName = value; }

    @JsonProperty("vip")
    public boolean getVip() { return vip; }
    @JsonProperty("vip")
    public void setVip(boolean value) { this.vip = value; }

    @JsonProperty("addresses")
    public Address[] getAddresses() { return addresses; }
    @JsonProperty("addresses")
    public void setAddresses(Address[] value) { this.addresses = value; }
}

// Address.java

package io.quicktype;

import com.fasterxml.jackson.annotation.*;

public class Address {
    private String city;
    private String zip;

    @JsonProperty("city")
    public String getCity() { return city; }
    @JsonProperty("city")
    public void setCity(String value) { this.city = value; }

    @JsonProperty("zip")
    public String getZip() { return zip; }
    @JsonProperty("zip")
    public void setZip(String value) { this.zip = value; }
}

JSONを他の言語に変換