跳到主要内容
版本：4.0.2

JSON

QWen Max 中英对照 JSON

Spring Boot 提供了与以下 JSON 映射库的集成：

  • Jackson 3

  • Jackson 2

  • Gson

  • JSON-B

  • Kotlin Serialization

Jackson 3 是首选且默认的库。

对 Jackson 2 的支持已被弃用，并将在未来的 Spring Boot 4.x 版本中移除。提供该支持纯粹是为了简化从 Jackson 2 到 Jackson 3 的迁移过程，不应在长期项目中依赖此支持。

Jackson 3​

提供了 Jackson 3 的自动配置，且 Jackson 是 spring-boot-starter-json 的一部分。当 Jackson 位于 classpath 上时，会自动配置一个 JsonMapper bean。还提供了一些配置属性，用于自定义 JsonMapper 的配置。

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

如果你使用 Jackson 来序列化和反序列化 JSON 数据，你可能想要编写自己的 ValueSerializer 和 ValueDeserializer 类。自定义序列化器通常通过模块 向 Jackson 注册，但 Spring Boot 提供了一种替代方案：@JacksonComponent 注解，它使得直接注册 Spring Bean 更加简便。

你可以直接在 ValueSerializer、ValueDeserializer 或 KeyDeserializer 的实现类上使用 @JacksonComponent 注解。你也可以将其用在包含序列化器/反序列化器作为内部类的类上，如下例所示：

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);
		}

	}

}

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

Spring Boot 还提供了 ObjectValueSerializer 和 ObjectValueDeserializer 基类，在序列化对象时，它们为标准 Jackson 版本提供了有用的替代方案。更多详情请参见 API 文档中的 ObjectValueSerializer 和 ObjectValueDeserializer。

上面的示例可以重写为使用 ObjectValueSerializer 和 ObjectValueDeserializer，如下所示：

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);
		}

	}

}

Mixins​

Jackson 支持 mixin，可用于将额外的注解混入到目标类上已声明的注解中。Spring Boot 的 Jackson 自动配置会扫描应用程序包中带有 @JacksonMixin 注解的类，并将其注册到自动配置的 JsonMapper 中。该注册由 Spring Boot 的 JacksonMixinModule 执行。

Jackson 2​

已弃用的 Jackson 2 自动配置由 spring-boot-jackson2 模块提供。当该模块位于 classpath 上时，会自动配置一个 ObjectMapper Bean。提供了多个 spring.jackson2.* 配置属性用于自定义配置。若需更精细的控制，可定义一个或多个 Jackson2ObjectMapperBuilderCustomizer Bean。

当 Jackson 3 和 Jackson 2 同时存在时，可以使用多种配置属性来表明优先使用 Jackson 2：

  • spring.graphql.rsocket.preferred-json-mapper

  • spring.http.codecs.preferred-json-mapper（由 Spring WebFlux 和响应式 HTTP 客户端使用）

  • spring.http.converters.preferred-json-mapper（由 Spring MVC 和阻塞式 HTTP 客户端使用）

  • spring.rsocket.preferred-mapper

  • spring.websocket.messaging.preferred-json-mapper

在每种情况下，将相关属性设置为 jackson2 以表明优先使用 Jackson 2。

Gson​

提供了 Gson 的自动配置。当 Gson 在类路径中时，会自动配置一个 Gson Bean。提供了多个 spring.gson.* 配置属性用于自定义配置。若需更精细的控制，可以使用一个或多个 GsonBuilderCustomizer Bean。

JSON-B​

提供了 JSON-B 的自动配置。当 JSON-B API 及其实现位于 classpath 上时，将自动配置一个 Jsonb bean。首选的 JSON-B 实现是 Eclipse Yasson，其依赖管理已提供。

Kotlin Serialization​

提供了 Kotlin Serialization 的自动配置。当 kotlinx-serialization-json 在类路径上时，会自动配置一个 Json Bean。还提供了一些 spring.kotlinx.serialization.json.* 配置属性，用于自定义配置。