@JsonSerialize注解的使用示例教程

 更新时间:2023年11月27日 14:31:19   作者:小徐敲java  
在开发中,有时候某些字段需要特殊处理,比如我们有一个日期字段,当日期为NULL时给前端不返回NULL而返回为其他等信息,就需要自定义字段的序列化,这就是@JsonSerialize的用处,本文给大家介绍@JsonSerialize注解的使用,感兴趣的朋友一起看看吧

@JsonSerialize注解的使用

使用场景

** 在开发中,有时候某些字段需要特殊处理,比如我们有一个日期字段,当日期为NULL时给前端不返回NULL而返回为其他等信息,就需要自定义字段的序列化。这就是@JsonSerialize的用处 **

1:先写一个指定的处理类

package org.demo.common.json;
import com.alibaba.fastjson.JSONObject;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;
import java.util.List;
/**
 *
 * @Description: 序列化工具,将list集合转字符串
 * @Author: xqf
 * @Date: 2023-11-25
 * @Version: V1.0
 * /
  /**继承JsonSerializer*/
public class ToArraysSerializer extends JsonSerializer<String> {
    /**
     * 重写serialize方法
     **/
    @Override
    public void serialize(String object, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
        /**自定义处理方式*/
        List<String> list = JSONObject.parseObject(object, List.class);
        jsonGenerator.writeObject(list);
    }
}

2:此字段上加上@JsonSerialize注解,并且使用using 属性(表示有值的时候调用ToArraysSerializer处理返回给前端)

    /**
     * 文章内容
     */
    @ApiModelProperty(value = "文章内容")
    @JsonSerialize(using = ToArraysSerializer.class)
    private String content;

3:nullsUsing用法与using 一样,当字段为NULL时的自定义序列化方式

    /**
     * 文章内容
     */
    @ApiModelProperty(value = "文章内容")
    @JsonSerialize(nullsUsing = xxx.class)
    private String content;

扩展:

@JsonSerialize的使用

一、项目背景

在前后端分离的项目中,后端使用雪花算法生成的id,前端使用js来处理数据。如果使用传统方式,在保存和响应时加上转换的处理,不难但是很繁琐的操作令人很头痛,jackson提供了JsonSerialize和JsonDeserialize注解来优雅的解决这个问题,项目采用的springboot框架,而springboot框架默认配置json转换工具就是jackson。如此,使用注解解决问题很nice了。

也可以自己手动引入一个自己想要的版本

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>2.13.3</version>
</dependency>

二、注解介绍

@JsonSerialize:json序列化注解,用于字段或get方法上,作用于getter()方法,将java对象序列化为json数据。

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL) //include里面包含了序列化的范围和作用的规则,本行作用是属性为null的时候不进行序列化操作。
@JsonSerialize(using = ToStringSerializer.class) //将id实现字符串的序列化和反序列序列化
@JsonSerialize(nullsUsing = DateJsonSerialize.class) //当此字段为NULL时就使用我们自定义的解析类序列化此字段(注意当此字段不为NULL时不执行此配置)
@JsonSerialize(using = Bean.class) //Bean 为实现类,Bean需要继承JsonSerializer<>,泛型就是作用字段的类型。

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)

对返回的json数据含有null值进行过滤

过滤前

{
    name: null,
    age: 22,
    sex: 'man'
}

过滤后

{
    age: 22,
    sex: 'man'
}

@JsonSerialize(using = ToStringSerializer.class)

java中id为long时,前端js传到后台就变了值,后两位就变成了00;从网上查了资料才知道,后端使用雪花或是其他算法生成的id一般都在19位,而js中number的最大长度为17位所以出现了这种乌龙的情况。解决这个问题就是在id上加上这个注解

@TableId(type = IdType.ASSIGN_ID)
	@JsonSerialize(using = ToStringSerializer.class)
	@ApiModelProperty(value = "id")
	private Long id;

@JsonSerialize(nullsUsing = DateJsonSerialize.class)

需要我们写一个指定的处理类

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;
import java.util.Date;
//继承JsonSerializer
public class DateJsonSerialize extends JsonSerializer<Date> {
    //重写serialize方法
    @Override
    public void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        //自定义处理方式
        jsonGenerator.writeString("未完成");
    }
}

@JsonSerialize(using = Bean.class)

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;
public class BeanSerializer extends JsonSerializer<MyBeanClass> {
    @Override
    public void serialize(MyBeanClass bean, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        // 在这里实现你自定义的序列化逻辑
        // 使用 jsonGenerator 将对象的属性按照你的需求写入 JSON
    }
}

然后,你可以将这个自定义的序列化器类BeanSerializer应用于你的Java对象,例如:

@Data
@JsonSerialize(using = BeanSerializer.class)//①放到这
public class MyBeanClass {
    @JsonSerialize(using = BeanSerializer.class)//②放到这
    private String name;
}

到此这篇关于@JsonSerialize注解的使用的文章就介绍到这了,更多相关@JsonSerialize注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Springboot设置文件上传大小限制的实现示例

    Springboot设置文件上传大小限制的实现示例

    Spring Boot工程嵌入的tomcat限制了请求的文件大小默认为1MB,单次请求的文件的总数不能大于10Mb,本文主要介绍了Springboot设置文件上传大小限制的实现示例,感兴趣的可以了解一下
    2023-11-11
  • Spring Boot日志控制详解

    Spring Boot日志控制详解

    这篇文章主要为大家详细介绍了Spring Boot日志控制的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • java+jdbc+mysql+socket搭建局域网聊天室

    java+jdbc+mysql+socket搭建局域网聊天室

    这篇文章主要为大家详细介绍了java+jdbc+mysql+socket搭建局域网聊天室,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-01-01
  • springsecurity 基本使用详解

    springsecurity 基本使用详解

    这篇文章主要介绍了springsecurity 基本使用,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • Spring Boot实战之模板引擎

    Spring Boot实战之模板引擎

    这篇文章主要介绍了Spring Boot实战之模板引擎,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • Spring Boot命令行运行器的实现方法

    Spring Boot命令行运行器的实现方法

    这篇文章主要介绍了Spring Boot命令行运行器的实现方法,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-10-10
  • 利用Java手写一个简易的lombok的示例代码

    利用Java手写一个简易的lombok的示例代码

    Lombok是一款Java开发插件,使得Java开发者可以通过其定义的一系列注解来消除业务工程中冗长和繁琐的代码,尤其对于简单的Java模型对象。本文就来手写一个简易的lombok,需要的可以参考一下
    2022-10-10
  • Hibernate映射文件id的generator配置方法

    Hibernate映射文件id的generator配置方法

    下面小编就为大家分享一篇Hibernate映射文件id的generator配置方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2017-12-12
  • Java微服务Nacos Config配置中心超详细讲解

    Java微服务Nacos Config配置中心超详细讲解

    配置文件相对分散。在一个微服务架构下,配置文件会随着微服务的增多变的越来越多,而且分散 在各个微服务中,不好统一配置和管理。每一个环境所使用的配置理论上都是不同的,一旦需要修改,就需要我们去各个微服务下手动维护
    2023-02-02
  • 剖析Java中的事件处理与异常处理机制

    剖析Java中的事件处理与异常处理机制

    这篇文章主要介绍了Java中的事件处理与异常处理机制,讲解Java是如何对事件或者异常作出响应以及定义异常的一些方法,需要的朋友可以参考下
    2016-01-01

最新评论