JSON

Spring Boot 提供了對三種 JSON 對映庫的整合

  • Gson

  • Jackson

  • JSON-B

Jackson 是首選的預設庫。

Jackson

提供了 Jackson 的自動配置，並且 Jackson 是 spring-boot-starter-json 的一部分。當 Jackson 位於 classpath 中時，會自動配置一個 ObjectMapper bean。提供了多個配置屬性用於定製 ObjectMapper 的配置。

自定義序列化器和反序列化器

如果你使用 Jackson 來序列化和反序列化 JSON 資料，你可能需要編寫自己的 JsonSerializer 和 JsonDeserializer 類。自定義序列化器通常 透過模組註冊到 Jackson 中，但 Spring Boot 提供了一個替代的 @JsonComponent 註解，可以更方便地直接註冊 Spring Beans。

你可以直接在 JsonSerializer、JsonDeserializer 或 KeyDeserializer 的實現類上使用 @JsonComponent 註解。你也可以將其用於包含序列化器/反序列化器作為內部類的類上，如下例所示

  • 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 中的所有 @JsonComponent bean 都會自動註冊到 Jackson 中。由於 @JsonComponent 使用 @Component 進行了元註解，因此常規的元件掃描規則也適用。

Spring Boot 還提供了 JsonObjectSerializer 和 JsonObjectDeserializer 基類，它們在序列化物件時提供了標準 Jackson 版本的有用替代方案。有關詳細資訊，請參閱 API 文件中的 JsonObjectSerializer 和 JsonObjectDeserializer。

上面的示例可以重寫為使用 JsonObjectSerializer 和 JsonObjectDeserializer，如下所示

  • 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 支援 mixins，可用於將額外的註解混合到目標類已宣告的註解中。Spring Boot 的 Jackson 自動配置會掃描你的應用包中帶有 @JsonMixin 註解的類，並將它們註冊到自動配置的 ObjectMapper 中。註冊由 Spring Boot 的 JsonMixinModule 執行。

Gson

提供了 Gson 的自動配置。當 Gson 位於 classpath 中時，會自動配置一個 Gson bean。提供了多個 spring.gson.* 配置屬性用於定製配置。為了獲得更多控制權，可以使用一個或多個 GsonBuilderCustomizer bean。

JSON-B

提供了 JSON-B 的自動配置。當 JSON-B API 和一個實現位於 classpath 中時，會自動配置一個 Jsonb bean。首選的 JSON-B 實現是 Eclipse Yasson，併為其提供了依賴管理。