JSON

Spring Boot 提供了与以下 JSON 映射库的集成:spring-doc.cadn.net.cn

Jackson 3 是首选且默认的库。spring-doc.cadn.net.cn

对 Jackson 2 的支持已被弃用,并将在未来的 Spring Boot 4.x 版本中移除。 提供该支持纯粹是为了便于从 Jackson 2 迁移到 Jackson 3,不应在长期项目中继续依赖。spring-doc.cadn.net.cn

Jackson 3

为 Jackson 3 提供了自动配置,且 Jackson 是 spring-boot-starter-json 的一部分。 当 Jackson 位于类路径上时,会自动配置一个 JsonMapper Bean。 提供了多个配置属性,用于 自定义 JsonMapper 的配置。spring-doc.cadn.net.cn

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

如果您使用 Jackson 来序列化和反序列化 JSON 数据,您可能希望编写自己的 ValueSerializerValueDeserializer 类。 自定义序列化器通常通过模块 向 Jackson 注册,但 Spring Boot 提供了一种替代的 @JacksonComponent 注解,使得直接注册 Spring Bean 变得更加容易。spring-doc.cadn.net.cn

您可以直接在 @JacksonComponentValueSerializerValueDeserializer 实现上使用 KeyDeserializer 注解。 您也可以将其用于包含序列化器/反序列化器作为内部类的类,如下例所示:spring-doc.cadn.net.cn

import tools.jackson.core.JsonGenerator;
import tools.jackson.core.JsonParser;
import tools.jackson.databind.DeserializationContext;
import tools.jackson.databind.JsonNode;
import tools.jackson.databind.SerializationContext;
import tools.jackson.databind.ValueDeserializer;
import tools.jackson.databind.ValueSerializer;

import org.springframework.boot.jackson.JacksonComponent;

@JacksonComponent
public class MyJacksonComponent {

	public static class Serializer extends ValueSerializer<MyObject> {

		@Override
		public void serialize(MyObject value, JsonGenerator jgen, SerializationContext context) {
			jgen.writeStartObject();
			jgen.writeStringProperty("name", value.getName());
			jgen.writeNumberProperty("age", value.getAge());
			jgen.writeEndObject();
		}

	}

	public static class Deserializer extends ValueDeserializer<MyObject> {

		@Override
		public MyObject deserialize(JsonParser jsonParser, DeserializationContext ctxt) {
			JsonNode tree = jsonParser.readValueAsTree();
			String name = tree.get("name").stringValue();
			int age = tree.get("age").intValue();
			return new MyObject(name, age);
		}

	}

}
import tools.jackson.core.JsonGenerator
import tools.jackson.core.JsonParser
import tools.jackson.databind.DeserializationContext
import tools.jackson.databind.JsonNode
import tools.jackson.databind.SerializationContext
import tools.jackson.databind.ValueDeserializer
import tools.jackson.databind.ValueSerializer

import org.springframework.boot.jackson.JacksonComponent

@JacksonComponent
class MyJacksonComponent {

	class Serializer : ValueSerializer<MyObject>() {
		override fun serialize(value: MyObject, jgen: JsonGenerator, serializers: SerializationContext) {
			jgen.writeStartObject()
			jgen.writeStringProperty("name", value.name)
			jgen.writeNumberProperty("age", value.age)
			jgen.writeEndObject()
		}
	}

	class Deserializer : ValueDeserializer<MyObject>() {
		override fun deserialize(jsonParser: JsonParser, ctxt: DeserializationContext): MyObject {
			val tree = jsonParser.readValueAsTree<JsonNode>()
			val name = tree["name"].stringValue()
			val age = tree["age"].intValue()
			return MyObject(name, age)
		}
	}

}

所有 @JacksonComponent Bean 在 ApplicationContext 中都会自动注册到 Jackson。 由于 @JacksonComponent 使用了 @Component 进行元注解,因此常规的组件扫描规则适用。spring-doc.cadn.net.cn

Spring Boot 还提供了 ObjectValueSerializerObjectValueDeserializer 基类,它们在序列化对象时提供了标准 Jackson 版本的有用替代方案。 有关详细信息,请参阅 API 文档中的 ObjectValueSerializerObjectValueDeserializerspring-doc.cadn.net.cn

上述示例可以重写为使用 ObjectValueSerializerObjectValueDeserializer,如下所示:spring-doc.cadn.net.cn

import tools.jackson.core.JsonGenerator;
import tools.jackson.core.JsonParser;
import tools.jackson.databind.DeserializationContext;
import tools.jackson.databind.JsonNode;
import tools.jackson.databind.SerializationContext;

import org.springframework.boot.jackson.JacksonComponent;
import org.springframework.boot.jackson.ObjectValueDeserializer;
import org.springframework.boot.jackson.ObjectValueSerializer;

@JacksonComponent
public class MyJacksonComponent {

	public static class Serializer extends ObjectValueSerializer<MyObject> {

		@Override
		protected void serializeObject(MyObject value, JsonGenerator jgen, SerializationContext context) {
			jgen.writeStringProperty("name", value.getName());
			jgen.writeNumberProperty("age", value.getAge());
		}

	}

	public static class Deserializer extends ObjectValueDeserializer<MyObject> {

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

	}

}
import tools.jackson.core.JsonGenerator
import tools.jackson.core.JsonParser
import tools.jackson.databind.DeserializationContext
import tools.jackson.databind.JsonNode
import tools.jackson.databind.SerializationContext

import org.springframework.boot.jackson.JacksonComponent;
import org.springframework.boot.jackson.ObjectValueDeserializer
import org.springframework.boot.jackson.ObjectValueSerializer

@JacksonComponent
class MyJacksonComponent {

	class Serializer : ObjectValueSerializer<MyObject>() {
		override fun serializeObject(value: MyObject, jgen: JsonGenerator, context: SerializationContext) {
			jgen.writeStringProperty("name", value.name)
			jgen.writeNumberProperty("age", value.age)
		}
	}

	class Deserializer : ObjectValueDeserializer<MyObject>() {
		override fun deserializeObject(jsonParser: JsonParser, context: DeserializationContext,
				tree: JsonNode): MyObject {
			val name = nullSafeValue(tree["name"], String::class.java) ?: throw IllegalStateException("name is null")
			val age = nullSafeValue(tree["age"], Int::class.java) ?: throw IllegalStateException("age is null")
			return MyObject(name, age)
		}
	}

}

混入(Mixins)

Jackson 支持混入(mixins),可用于将额外的注解混合到目标类已声明的注解中。 Spring Boot 的 Jackson 自动配置会扫描应用程序包中使用 @JacksonMixin 注解的类,并将它们注册到自动配置的 JsonMapper 中。 该注册过程由 Spring Boot 的 JacksonMixinModule 执行。spring-doc.cadn.net.cn

Jackson 2

已弃用的 Jackson 2 自动配置由 spring-boot-jackson2 模块提供。 当该模块位于类路径上时,会自动配置一个 ObjectMapper Bean。 提供了多个 spring.jackson2.* 配置属性用于自定义配置。 如需更多控制,可定义一个或多个 Jackson2ObjectMapperBuilderCustomizer Bean。spring-doc.cadn.net.cn

当 Jackson 3 和 Jackson 2 同时存在时,可以使用各种配置属性来指定优先使用 Jackson 2:spring-doc.cadn.net.cn

在每种情况下,将相关属性设置为 jackson2,以表明优先使用 Jackson 2。spring-doc.cadn.net.cn

Gson

提供了针对 Gson 的自动配置。 当 Gson 位于类路径上时,会自动配置一个 Gson Bean。 提供了多个 spring.gson.* 配置属性用于自定义配置。 若需更多控制权,可以使用一个或多个 GsonBuilderCustomizer Bean。spring-doc.cadn.net.cn

JSON-B

已提供针对 JSON-B 的自动配置。 当 JSON-B API 及其实现位于类路径上时,将自动配置一个 Jsonb Bean。 首选的 JSON-B 实现是 Eclipse Yasson,并已为其提供依赖管理支持。spring-doc.cadn.net.cn

Kotlin 序列化

提供了 Kotlin Serialization 的自动配置。 当 classpath 中存在 kotlinx-serialization-json 时,会自动配置一个 Json Bean。 提供了多个 spring.kotlinx.serialization.json.* 配置属性,用于自定义配置。spring-doc.cadn.net.cn