|
此版本仍在开发中，尚未被视为稳定版本。如需最新稳定版本，请使用 Spring Boot 4.0.4! |
JSON
Spring Boot 提供了与三种 JSON 映射库的集成：
-
Gson
-
Jackson
-
JSON-B
Jackson 是首选且默认的库。
Jackson
提供了 Jackson 的自动配置，且 Jackson 是 spring-boot-starter-json 的一部分。
当 Jackson 位于类路径上时，会自动配置一个 ObjectMapper Bean。
提供了多个配置属性，用于自定义 ObjectMapper 的配置。
自定义序列化器和反序列化器
如果您使用 Jackson 来序列化和反序列化 JSON 数据，可能需要编写自己的 JsonSerializer 和 JsonDeserializer 类。
自定义序列化器通常通过模块向 Jackson 注册，但 Spring Boot 提供了一种替代方案——@JsonComponent 注解，可更便捷地直接注册 Spring Bean。
您可以直接在 @JsonComponent 注解上使用该注解，应用于 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)
}
}
}@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)
}
}
}混入类
Jackson 支持混入（mixins），可用于将额外的注解添加到目标类已声明的注解中。
Spring Boot 的 Jackson 自动配置会扫描应用程序的包，查找使用 @JsonMixin 注解的类，并将其注册到自动配置的 ObjectMapper 中。
该注册操作由 Spring Boot 的 JsonMixinModule 执行。
Gson
提供了 Gson 的自动配置。
当类路径中包含 Gson 时，会自动配置一个 Gson 类型的 Bean。
提供了多个 spring.gson.* 配置属性，用于自定义配置。
如需更精细的控制，可以使用一个或多个 GsonBuilderCustomizer 类型的 Bean。
JSON-B
提供了对 JSON-B 的自动配置。
当类路径中存在 JSON-B API 及其实现时，将自动配置一个 Jsonb Bean。
首选的 JSON-B 实现是 Eclipse Yasson，其依赖管理已由框架提供。