JSON
Spring Boot 提供与以下 JSON 映射库的集成:
-
Jackson3
-
Jackson2号
-
Gson
-
JSON-B
-
Kotlin 序列化
Jackson 3 是首选且默认的库。
Jackson 2 的支持已不再支持,并将在未来的 Spring Boot 4.x 版本中移除。 它纯粹是为了缓解从Jackson 2迁移到Jackson 3的过程,长期来看不应依赖。
Jackson3
提供Jackson 3的自动配置功能,Jackson是Spring-boot-starter-json.
当Jackson处于阶级路径 a 上时JsonMapperBean 会自动配置。
提供了若干配置属性用于自定义 JsonMapper.
自定义串行器和解串器
如果你用Jackson来序列化和反序列化JSON数据,你可能想自己写一写价值序列化器和价值解串器类。
自定义串行器通常通过模块注册给Jackson,但Spring Boot提供了另一种选择@JacksonComponent注释使得直接注册春豆变得更方便。
你可以使用@JacksonComponent直接在 上进行注释价值序列化器,价值解串器或密钥解串器实现。
你也可以在包含串行化器/反串行器作为内类的类上使用它,如下示例所示:
-
Java
-
Kotlin
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豆子在应用上下文自动注册于Jackson。
因为@JacksonComponent是元注释,记为@Component,通常适用的组件扫描规则。
Spring靴还提供对象值序列化器和ObjectValueDeserializer这些基类在序列化对象时提供了标准 Jackson 版本的有用替代方案。
看对象值序列化器和ObjectValueDeserializer详情请见API文档。
上述示例可以重写为对象值序列化器和ObjectValueDeserializer如下:
-
Java
-
Kotlin
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)
}
}
}
混音
Jackson 支持混合注释,可以用来将额外注释混入目标类已声明的注释中。
Spring Boot 的 Jackson 自动配置会扫描你应用程序包中的 class 标注为@JacksonMixin并向自动配置的JsonMapper.
注册由Spring Boot's负责JacksonMixin模块.
Jackson2号
Jackson 2 已废弃的自动配置由Spring靴Jackson2模块。
当该模处于类路径 a 上时对象映射器Bean 会自动配置。
几个Spring。Jackson2.*提供配置属性以实现配置的自定义。
想要获得更多控制权,请定义一个或多个Jackson2ObjectMapperBuilderCustomizer豆。
当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 处于类路径 a 上时GsonBean 会自动配置。
几个spring.gson.*提供配置属性以实现配置的自定义。
想要获得更多控制权,一个或多个GsonBuilder定制器豆子也可以使用。
JSON-B
提供 JSON-B 自动配置功能。
当 JSON-B API 和实现都处于类路径 a 上时Jsonb豆子会自动配置。
首选的 JSON-B 实现是 Eclipse Yasson,该版本提供了依赖管理。
Kotlin 序列化
提供 Kotlin 序列化的自动配置。
什么时候Kotlinx-serialization-JSON在classpath上,Json豆会自动配置。
几个spring.kotlinx.serialization.json。*提供配置属性以实现配置的自定义。