@JsonDeserialize和@JsonSerialize注解的使用方式

更新時間：2024年08月23日 09:18:47 作者：華妃

這篇文章主要介紹了@JsonDeserialize和@JsonSerialize注解的使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

JsonDeserialize注解介紹

@JsonDeserialize：

json反序列化注解，作用于setter()方法，將json數(shù)據(jù)反序列化為java對象。
可以理解為用在處理接收的數(shù)據(jù)上。

使用場景

前端傳遞的參數(shù)與后端實際接收的參數(shù)不一致時，可以通過反序列化注解處理。
（比如將前端傳遞的主鍵集合轉換成用逗號分隔的字符串）

使用示例

假如前端頁面中選擇多條數(shù)據(jù)，會向后端傳遞選中的數(shù)據(jù)對象集合，但是后端期望存儲選中的多個數(shù)據(jù)id用逗號分隔，此時可以用反序列注解。

1、自定義反序列化的方式

public class CheckedStringDeserializer extends JsonDeserializer<String> {

    @Override
    public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        final List<Map<String, String>> list = p.getCodec().readValue(p, new TypeReference<List<Map<String, String>>>() {
        });
        if (CollUtil.isNotEmpty(list)) {
            final ArrayList<String> objects = new ArrayList<>(list.size());
            list.forEach(e -> objects.add(e.get("id")));
            return CollUtil.join(objects, ",");
        }
        return "";
    }
}

2、后端接收參數(shù)的dto如下圖所示，其中臨時黨支部人員Id接收的是String類型，增加了該反序列化注解。

3、前端傳遞參數(shù)如下圖所示：

4、后端實際接收到的參數(shù)如圖所示：

@JsonSerialize注解

@JsonSerialize：

json序列化注解，作用于getter()方法，將java對象序列化為json數(shù)據(jù)。
可以理解為用在處理返回的數(shù)據(jù)上

使用場景

后端返回前端的參數(shù)與前端期望的參數(shù)不一致時，可以用個序列化注解處理。（比如數(shù)據(jù)脫敏、數(shù)據(jù)格式處理等）

使用示例

假如后端存儲附件、圖片或者其他文件時，只存了文件key，此時前端反顯需要將數(shù)據(jù)放在list中回顯。

1、自定義序列化處理方式

public class FileUploadSeserializer extends JsonSerializer<String> {

    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        //將string轉為List<Map<String,String>>格式
        Map<String,String> map = new HashMap<>(2);
        List<Map<String,String>> list = new ArrayList<>(1);
        map.put("key", value);
        map.put("name",value);
        list.add(map);
        gen.writeObject(list);
    }
}

2、返回前端的vo對象如下圖所示，其中其中模板背景期望為附件的Key和name對象集合,在該字段上增加了文件上傳序列化注解。