JSON

Spring Boot は、3 つの JSON マッピングライブラリとの統合を提供します。

  • Gson

  • Jackson

  • JSON-B

Jackson は、推奨されるデフォルトのライブラリです。

Jackson

Jackson の自動構成が提供されており、Jackson は spring-boot-starter-json の一部です。Jackson がクラスパス上にある場合、ObjectMapper (英語) Bean が自動的に構成されます。ObjectMapper の設定をカスタマイズするにはいくつかの構成プロパティが提供されています。

カスタムシリアライザーとデシリアライザー

Jackson を使用して JSON データを直列化およびデ直列化する場合は、独自の JsonSerializer (英語) クラスと JsonDeserializer (英語) クラスを作成することをお勧めします。カスタムシリアライザーは通常、モジュールを介して Jackson に登録されます [GitHub] (英語) が、Spring Boot では、Spring Bean を直接登録しやすくする代替の @JsonComponent (Javadoc) アノテーションが提供されています。

@JsonComponent (Javadoc) アノテーションは、JsonSerializer (英語) 、JsonDeserializer (英語) 、または KeyDeserializer (英語) 実装で直接使用できます。また、次の例に示すように、シリアライザー / デシリアライザーを内部クラスとして含むクラスで使用することもできます。

  • Java

  • Kotlin

import java.io.IOException;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.ObjectCodec;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

import org.springframework.boot.jackson.JsonComponent;

@JsonComponent
public class MyJsonComponent {

	public static class Serializer extends JsonSerializer<MyObject> {

		@Override
		public void serialize(MyObject value, JsonGenerator jgen, SerializerProvider serializers) throws IOException {
			jgen.writeStartObject();
			jgen.writeStringField("name", value.getName());
			jgen.writeNumberField("age", value.getAge());
			jgen.writeEndObject();
		}

	}

	public static class Deserializer extends JsonDeserializer<MyObject> {

		@Override
		public MyObject deserialize(JsonParser jsonParser, DeserializationContext ctxt) throws IOException {
			ObjectCodec codec = jsonParser.getCodec();
			JsonNode tree = codec.readTree(jsonParser);
			String name = tree.get("name").textValue();
			int age = tree.get("age").intValue();
			return new MyObject(name, age);
		}

	}

}
import com.fasterxml.jackson.core.JsonGenerator
import com.fasterxml.jackson.core.JsonParser
import com.fasterxml.jackson.core.JsonProcessingException
import com.fasterxml.jackson.databind.DeserializationContext
import com.fasterxml.jackson.databind.JsonDeserializer
import com.fasterxml.jackson.databind.JsonNode
import com.fasterxml.jackson.databind.JsonSerializer
import com.fasterxml.jackson.databind.SerializerProvider
import org.springframework.boot.jackson.JsonComponent
import java.io.IOException

@JsonComponent
class MyJsonComponent {

	class Serializer : JsonSerializer<MyObject>() {
		@Throws(IOException::class)
		override fun serialize(value: MyObject, jgen: JsonGenerator, serializers: SerializerProvider) {
			jgen.writeStartObject()
			jgen.writeStringField("name", value.name)
			jgen.writeNumberField("age", value.age)
			jgen.writeEndObject()
		}
	}

	class Deserializer : JsonDeserializer<MyObject>() {
		@Throws(IOException::class, JsonProcessingException::class)
		override fun deserialize(jsonParser: JsonParser, ctxt: DeserializationContext): MyObject {
			val codec = jsonParser.codec
			val tree = codec.readTree<JsonNode>(jsonParser)
			val name = tree["name"].textValue()
			val age = tree["age"].intValue()
			return MyObject(name, age)
		}
	}

}

ApplicationContext (Javadoc) 内のすべての @JsonComponent (Javadoc) Bean は、自動的に Jackson に登録されます。@JsonComponent (Javadoc) は @Component (Javadoc) でメタアノテーションが付けられているため、通常のコンポーネントスキャンルールが適用されます。

Spring Boot は、オブジェクトを直列化するときに標準の Jackson バージョンの便利な代替手段となる JsonObjectSerializer (Javadoc) および JsonObjectDeserializer (Javadoc) 基本クラスも提供します。詳細については、API ドキュメントの JsonObjectSerializer (Javadoc) および JsonObjectDeserializer (Javadoc) を参照してください。

上記の例は、次のように JsonObjectSerializer (Javadoc) と JsonObjectDeserializer (Javadoc) を使用して書き直すことができます。

  • Java

  • Kotlin

import java.io.IOException;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.ObjectCodec;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.SerializerProvider;

import org.springframework.boot.jackson.JsonComponent;
import org.springframework.boot.jackson.JsonObjectDeserializer;
import org.springframework.boot.jackson.JsonObjectSerializer;

@JsonComponent
public class MyJsonComponent {

	public static class Serializer extends JsonObjectSerializer<MyObject> {

		@Override
		protected void serializeObject(MyObject value, JsonGenerator jgen, SerializerProvider provider)
				throws IOException {
			jgen.writeStringField("name", value.getName());
			jgen.writeNumberField("age", value.getAge());
		}

	}

	public static class Deserializer extends JsonObjectDeserializer<MyObject> {

		@Override
		protected MyObject deserializeObject(JsonParser jsonParser, DeserializationContext context, ObjectCodec codec,
				JsonNode tree) throws IOException {
			String name = nullSafeValue(tree.get("name"), String.class);
			int age = nullSafeValue(tree.get("age"), Integer.class);
			return new MyObject(name, age);
		}

	}

}
import com.fasterxml.jackson.core.JsonGenerator
import com.fasterxml.jackson.core.JsonParser
import com.fasterxml.jackson.core.ObjectCodec
import com.fasterxml.jackson.databind.DeserializationContext
import com.fasterxml.jackson.databind.JsonNode
import com.fasterxml.jackson.databind.SerializerProvider
import org.springframework.boot.jackson.JsonComponent
import org.springframework.boot.jackson.JsonObjectDeserializer
import org.springframework.boot.jackson.JsonObjectSerializer
import java.io.IOException

@JsonComponent
class MyJsonComponent {

	class Serializer : JsonObjectSerializer<MyObject>() {
		@Throws(IOException::class)
		override fun serializeObject(value: MyObject, jgen: JsonGenerator, provider: SerializerProvider) {
			jgen.writeStringField("name", value.name)
			jgen.writeNumberField("age", value.age)
		}
	}

	class Deserializer : JsonObjectDeserializer<MyObject>() {
		@Throws(IOException::class)
		override fun deserializeObject(jsonParser: JsonParser, context: DeserializationContext,
				codec: ObjectCodec, tree: JsonNode): MyObject {
			val name = nullSafeValue(tree["name"], String::class.java)
			val age = nullSafeValue(tree["age"], Int::class.java)
			return MyObject(name, age)
		}
	}

}

Mixins

Jackson は、ターゲットクラスですでに宣言されているアノテーションに追加のアノテーションをミックスするために使用できるミックスインをサポートしています。Spring Boot の Jackson 自動構成は、アプリケーションのパッケージをスキャンして @JsonMixin (Javadoc) でアノテーションされたクラスを探し、自動構成された ObjectMapper (英語) に登録します。登録は Spring Boot の JsonMixinModule (Javadoc) によって実行されます。

Gson

Gson の自動構成が提供されます。Gson がクラスパス上にある場合、Gson (英語) Bean が自動的に構成されます。構成をカスタマイズするための spring.gson.* 構成プロパティがいくつか提供されます。より細かく制御するには、1 つ以上の GsonBuilderCustomizer (Javadoc) Bean を使用できます。

JSON-B

JSON-B の自動構成が提供されます。JSON-B API と実装がクラスパス上にある場合、Jsonb (英語) Bean が自動的に構成されます。優先される JSON-B 実装は、依存関係管理が提供される Eclipse Yasson です。