栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Jackson - 注解 @JsonSerialize 和 @JsonDeserialize 实现自定义序列化和反序列化

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Jackson - 注解 @JsonSerialize 和 @JsonDeserialize 实现自定义序列化和反序列化

注解 @JsonSerialize 和 @JsonDeserialize 可以用于为 Java 对象中的字段指定自定义序列化和反序列化程序 ,最常用的就是对日期时间进行序列化。

1. 测试案例 Demo 1. 注解 @JsonSerialize

使用 @JsonSerialize 通过 OptimizedBooleanSerializer 序列化 enabled 属性:

@Data
public class PersonSerializer {
    public long personId = 0;
    public String name = "John";
    
    // 实现enabled属性的自定义序列化
    @JsonSerialize(using = OptimizedBooleanSerializer.class)
    public boolean enabled;
}
public class OptimizedBooleanSerializer extends JsonSerializer {
    // 自定义序列化逻辑
    @Override
    public void serialize(Boolean value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
        // 将false序列化为0,将true序列化为0
        if(value){
            jsonGenerator.writeNumber(1);
        } else {
            jsonGenerator.writeNumber(0);
        }
    }
}
public class Main {
    public static void main(String[] args) throws JsonProcessingException {
        // 创建对象
        PersonSerializer personSerializer = new PersonSerializer();
        personSerializer.setPersonId(1);
        personSerializer.setName("张三");
        personSerializer.setEnabled(true);

        // 将PersonSerializer对象序列化为json字符串
        ObjectMapper objectMapper = new ObjectMapper();
        String jsonStr = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(personSerializer);
        System.out.println(jsonStr);
    }
}

测试结果:

{
“personId” : 1,
“name” : “张三”,
“enabled” : 1
}

2. 注解 @JsonDeserialize

使用 @JsonDeserialize 通过 OptimizedBooleanDeserializer 反序列化 enabled 属性:

@Data
public class PersonDerializer {
    public long personId = 0;
    public String name = "John";

    // 实现enabled属性的自定义反序列化
    @JsonDeserialize(using = OptimizedBooleanDeserializer.class)
    public boolean enabled;
}
public class OptimizedBooleanDeserializer extends JsonDeserializer {
    @Override
    public Boolean deserialize(JsonParser jsonParser, DeserializationContext deserializationContext)
            throws IOException, JacksonException {
        // 获取需要反序列化的json值
        int intValue = jsonParser.getIntValue();
        if (intValue == 1) {
            return true;
        }else{
            return false;
        }
    }
}
public class Main {
    public static void main(String[] args) throws JsonProcessingException {

        String json = "{n" +
                "  "personId" : 1,n" +
                "  "name" : "张三",n" +
                "  "enabled" : 1n" +
                "}";

        // json字符串反序列化为PersonSerializer对象
        ObjectMapper objectMapper = new ObjectMapper();
        PersonDerializer personSerializer = objectMapper.readValue(json, PersonDerializer.class);
        System.out.println(personSerializer);
    }
}

测试结果:

PersonDerializer(personId=1, name=张三, enabled=true)

2. 测试案例 Demo 1. 注解 @JsonSerialize

使用 @JsonSerialize 通过 CustomDateSerializer 序列化 eventDate 属性:

@Data
public class EventWithSerializer {
    public String name;

    @JsonSerialize(using = CustomDateSerializer.class)
    public Date eventDate;
}
public class CustomDateSerializer extends JsonSerializer {

    private static SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        // Date -> String
        String format = formatter.format(date);
        jsonGenerator.writeString(format);
    }
}
public class Main {
    public static void main(String[] args) throws JsonProcessingException {
        EventWithSerializer eventWithSerializer = new EventWithSerializer();
        Date date = new Date();
        eventWithSerializer.setEventDate(date);
        eventWithSerializer.setName("haha");

        ObjectMapper objectMapper = new ObjectMapper();
        String jsonString = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(eventWithSerializer);

        System.out.println(date);
        System.out.println(jsonString);
    }
}

输出:

Fri Jun 03 15:19:24 SGT 2022

{
“name” : “haha”,
“eventDate” : “2022-06-03 15:19:24”
}

2. 注解 @JsonDeserialize

使用 @JsonDeserialize 通过 CustomDateDeserializer 反序列化 eventDate 属性:

@Data
public class EventWithSerializer {
    public String name;

    @JsonDeserialize(using = CustomDateDeserializer.class)
    public Date eventDate;
}
public class CustomDateDeserializer extends JsonDeserializer {
    private static SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    public Date deserialize(JsonParser jsonParser, DeserializationContext deserializationContext)
            throws IOException, JacksonException {

        String jsonDateString = jsonParser.getText();
        Date date = null;
        try {
            date = formatter.parse(jsonDateString);
        } catch (ParseException e) {
            throw new RuntimeException(e);
        }
        return date;
    }
}
public class Main {
    public static void main(String[] args) throws JsonProcessingException {
        String jsonString = "{n" +
                "  "name" : "haha",n" +
                "  "eventDate" : "2022-06-03 15:19:24"n" +
                "}";

        ObjectMapper objectMapper = new ObjectMapper();
        EventWithSerializer eventWithSerializer
                = objectMapper.readerFor(EventWithSerializer.class).readValue(jsonString);

        System.out.println(eventWithSerializer);
    }
}

输出:

EventWithSerializer(name=haha, eventDate=Fri Jun 03 15:19:24 SGT 2022)

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/950924.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号