跳到主要内容
版本：3.5.10

JSON

QWen Max 中英对照 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 Bean。

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

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

	}

}

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

Spring Boot 还提供了 JsonObjectSerializer 和 JsonObjectDeserializer 基类，在序列化对象时，它们为标准 Jackson 版本提供了有用的替代方案。有关详细信息，请参阅 API 文档中的 JsonObjectSerializer 和 JsonObjectDeserializer。

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

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

	}

}

Mixins​

Jackson 支持 mixin，可用于将额外的注解混入到目标类已声明的注解中。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，已为其提供依赖管理。