當前位置：首頁 > 前端技术 > javascript >内容正文

javascript

spring序列化_使用@JsonIdentityInfo的Spring自定义序列化器

發布時間：2023/12/3 javascript 40 豆豆

生活随笔收集整理的這篇文章主要介紹了 spring序列化_使用@JsonIdentityInfo的Spring自定义序列化器小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

spring序列化

介紹

Spring中從JSON到JSON的序列化/反序列化已廣泛用于基于Spring的現代應用程序中。它基于杰克遜。 Jackson可以輕松地將任何POJO序列化為JSON，反之亦然。這段代碼寫得很好。我從來沒有遇到任何問題。涉及自定義序列化程序時，將變得更加困難。這篇文章展示了如何在帶有自動裝配字段的Spring中使用自定義序列化程序。

定義自定義序列化器

通常，一個類的自定義序列化器是從繼承的
com.fasterxml.jackson.databind.ser.std.StdSerializer。此類定義了一些構造函數，但是框架只需要一個無參數的構造函數即可調用超類，如下所示：

public CustomSerializer() {this(null); }public CustomSerializer(Class<ObjectToSerialize> t) {super(t); }

然后是實際編寫JSON必須實現的主要方法：

@Override public void serialize(ObjectToSerialize value, JsonGenerator gen, SerializerProvider provider) throws IOException {gen.writeStartObject();...provider.defaultSerializeField("some field", value.getField(), gen);...gen.writeEndObject(); }

創建序列化程序類時，必須將其注冊為ObjectToSerialize的序列化程序。這可以通過在類上使用@JsonSerialize注釋來完成：

@JsonSerialize(using = CustomSerializer.class) public class ObjectToSerialize {

現在，杰克遜將對該類的所有實例使用此自定義序列化程序。如有必要，可以通過子類編寫自定義解串器
com.fasterxml.jackson.databind.deser.std.StdDeserializer <T>

循環引用和@JsonIdentityInfo

對于大多數使用Spring和Hibernate的商業應用程序，循環引用的問題遲早會出現。這是一個簡單的例子。

我們有2個課程：

public class Building {@Id@GeneratedValue(<parameters>)private Long id;private Set<Apartment> apartments; }public class Apartment {@Id@GeneratedValue(<parameters>)private Long id;private Building building; }

如果我們嘗試序列化至少有一個公寓的建筑物，則會得到StackOverflowException。

杰克遜有一個解決此問題的方法-@JsonIdentityInfo。

如果將注釋@JsonIdentityInfo添加到此類，則：

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id") public class ObjectToSerialize {

那么任何ObjectMapper都將通過用其ID替換除第一個對象以外的所有對象的出現而打破循環。像這樣：

{"id": 1,"apartments": [{"id": 2,"building": 1 - the object is replaced with its ID},{"id": 3,"building": 1 - the object is replaced with its ID}] }

這些是Jackson提供的用于自定義序列化和處理循環引用的工具。

JSON結構問題

問題

@JsonIdentityInfo適用于簡單的應用程序。但是隨著應用程序以默認格式增長，它可能會影響JSON的結構。例如，如果某些方法在一個響應中返回建筑物和區域，則可能會發生以下情況：

{"buildings": [{"id": 1,"apartments": [{"id": 2,"building": 1 - the object is replaced with its ID},{"id": 3,"building": 1 - the object is replaced with its ID}]}],"districts": [{"buildings": [{"id": 5,...},1, - the object is replaced with its ID{"id": 6,...}]}] }

從解析器的角度來看，這種替換可能是完全不可預測的。在數組中，它可能會遇到對象和ID。這可能發生在任何字段和任何對象上。如果序列化提供程序多次找到該對象，則使用@JsonIdentityInfo對該類進行注釋的任何對象都將替換為其ID。序列化提供程序發現的具有相同ID的每個第二，第三，第四等實例都將替換為其ID。

解

這里的解決方案是使用單獨的ObjectMapper編寫JSON的一部分。已經看到的ID的列表存儲在由ObjectMapper創建的序列化提供程序中。通過創建單獨的ObjectMapper（具有可能不同的配置），可以重置列表。

對于返回不同對象類型的“復合” JSON結果，可以編寫自定義序列化程序。在此自定義序列化程序中，“標頭”是使用JsonGenerator方法手動編寫的，當達到JSON中的正確級別時，我們將創建一個新的ObjectMapper并編寫外觀更好的JSON。

{"buildings": [ - create a new ObjectMapper{"id": 1,"apartments": [{"id": 2,"building": 1 - the object is replaced with its ID},{"id": 3,"building": 1 - the object is replaced with its ID}]}],"districts": [ - create a new ObjectMapper{"buildings": [{"id": 5,...},{ - the object is written as a JSON Object not an ID"id": 1,...},{"id": 6,...}]}] }

要將JSON寫入原始生成器，我們可以使用
ObjectMapper.writeValueAsString和
JsonGenerator.writeRawValue（String）。

PS也可以通過以下方式創建新的序列化提供程序
DefaultSerializerProvider.createInstance（SerializationConfig，SerializerFactory），但它可能更復雜。

自定義序列化器自動裝配問題

問題

我們希望能夠在自定義序列化程序中使用@Autowire。這是Spring的最佳功能之一！實際上，如果使用默認的ObjectMapper，它就可以工作。但是，如果我們使用JSON結構問題的解決方案，則該解決方案不適用于由我們自己的對象映射器實例化的自定義序列化程序。

解

我們自己的對象映射器必須配置有特殊的HandlerInstantiator：

// try to use the default configuration as much as possible ObjectMapper om = Jackson2ObjectMapperBuilder.json().build(); // This instantiator will handle autowiring properties into the custom serializers om.setHandlerInstantiator( new SpringHandlerInstantiator(this.applicationContext.getAutowireCapableBeanFactory()));

如果自定義對象映射器是在另一個由默認ObjectMapper創建的自定義序列化器中創建的，則它可以自動裝配ApplicationContext。

翻譯自: https://www.javacodegeeks.com/2019/01/spring-custom-serializers-jsonidentityinfo.html