Jackson 进阶之自定义序列化器

Jackson 的基本介绍可以参考 Jackson 使用简介

JsonSerializer 的简单使用

1)实现 JsonSerializer 接口

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

import java.io.IOException;

public class ObfuscatedIdSerializer extends JsonSerializer<Integer> {
    @Override
    public void serialize(Integer value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        if (value == null) {
            gen.writeNull();
        } else if (value == 1) {
            gen.writeString("字符串 1");
        } else {
            gen.writeNumber(value);
        }
    }
}

2)定义需要序列化的类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;

    @JsonSerialize(using = ObfuscatedIdSerializer.class)
    private int age;

    private int anotherAge;

    public static Person from(String name, int age) {
        return new Person(name, age, age);
    }
}

@JsonSerializer 注解的作用是声明使用自定义的序列化类(实现了 JsonSerializer 接口)

3)进行序列化操作

public class JacksonDemo1 {

    public static void main(String[] args) throws IOException {
        ObjectMapper mapper = new ObjectMapper();
        System.out.println(mapper.writeValueAsString(Person.from("zhangsan", 18)));
        System.out.println(mapper.writeValueAsString(Person.from("zhangsan", 1)));
    }
}

控制台输出:

{"name":"zhangsan","age":18,"anotherAge":18}
{"name":"zhangsan","age":"字符串 1","anotherAge":1}

JsonDeserializer 的简单使用

1)实现 JsonDeserializer 接口

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 java.io.IOException;

public class ObfuscatedIdDeserializer extends JsonDeserializer<Integer> {

    @Override
    public Integer deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
        String obfuscatedId = p.getText().trim();
        if (obfuscatedId.isEmpty()) {
            return null;
        }

        if (obfuscatedId.equals("字符串 1")) {
            return 1;
        }

        return Integer.valueOf(obfuscatedId);
    }
}

2)定义需要序列化的类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;

    @JsonSerialize(using = ObfuscatedIdSerializer.class)
    @JsonDeserialize(using = ObfuscatedIdDeserializer.class)
    private int age;

    private int anotherAge;

    public static Person from(String name, int age) {
        return new Person(name, age, age);
    }
}

@JsonDeserialize 注解的作用是声明使用自定义的反序列化类(实现了 JsonDeserializer 接口)

3)进行序列化操作

public class JacksonDemo2 {
     private static ObjectMapper mapper = new ObjectMapper();

    public static void main(String[] args) throws IOException {
        serializerAndDeserializer(Person.from("zhangsan", 18));
        serializerAndDeserializer(Person.from("zhangsan", 1));
    }

    private static void serializerAndDeserializer(Person person) throws IOException {

        String serializer = mapper.writeValueAsString(person);
        Person deserializer = mapper.readValue(serializer, Person.class);

        System.out.println(serializer);
        System.out.println(deserializer);
    }
}

控制台输出:

{"name":"zhangsan","age":18,"anotherAge":18}
Person(name=zhangsan, age=18, anotherAge=18)
{"name":"zhangsan","age":"字符串 1","anotherAge":1}
Person(name=zhangsan, age=1, anotherAge=1)

@JacksonAnnotationsInside 的简单使用

@JacksonAnnotationsInside 注解的作用是将多个注解组合到一起。

1)定义新的序列化注解

@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonSerialize(using = ObfuscatedIdSerializer.class)
public @interface NeedObfuscatedId {
}

2)定义新的反序列化注解

@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonDeserialize(using = ObfuscatedIdDeserializer.class)
public @interface NeedUnobfuscatedId {
}

3)在需要序列化的类上使用新的特定注解 @NeedObfuscatedId@NeedUnobfuscatedId,替换之前的 @JsonSerialize@JsonDeserialize 通用注解

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;

    @NeedObfuscatedId
    @NeedUnobfuscatedId
    private int age;

    private int anotherAge;

    public static Person from(String name, int age) {
        return new Person(name, age, age);
    }
}

4)运行上面的 JacksonDemo2,控制台输出和之前一样。

5)把序列化和反序列化注解合并为同一个

@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonSerialize(using = ObfuscatedIdSerializer.class)
@JsonDeserialize(using = ObfuscatedIdDeserializer.class)
public @interface ObfuscatedIdSerde {
}

或者

@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@NeedObfuscatedId
@NeedUnobfuscatedId
public @interface ObfuscatedIdSerde {
}

6)在需要序列化的类上使用新的注解 ObfuscatedIdSerde 替换上面的 @NeedObfuscatedId@NeedUnobfuscatedId 注解。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;

    @ObfuscatedIdSerde
    private int age;

    private int anotherAge;

    public static Person from(String name, int age) {
        return new Person(name, age, age);
    }
}

7)运行上面的 JacksonDemo2,控制台输出和之前一样。

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,529评论 5 475
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,015评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,409评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,385评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,387评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,466评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,880评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,528评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,727评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,528评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,602评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,302评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,873评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,890评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,132评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,777评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,310评论 2 342

推荐阅读更多精彩内容