@JsonSerialize注解的使用

使用场景

在开发中，我们将对象序列化为JSON传输给前端，有时候我们的某个或者某些字段需要特殊处理，比如我们有一个日期字段，我们希望当日期为NULL时给前端不返回NULL而返回为未完成等信息，或者我们有一些状态字段，我们需要给前端返回状态对应的信息，此时我们就需要自定义字段的序列化。这就是@JsonSerialize的用处

nullsUsing用法

假设我们的项目中有一个Date类型的字段，我们的需求是当此字段为NULL时，我们在序列化数据的时候序列化成 "未完成"(前端也可以做，假设前端比较懒hhh)

 @ApiModelProperty("完成时间")
 private Date finishTime;

第一步，我们先写一个指定的处理类

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注解,并且使用nullsUsing属性，即当此字段为NULL时就使用我们自定义的解析类序列化此字段(注意当此字段不为NULL时不执行此配置)

	@ApiModelProperty("完成时间")
    @JsonSerialize(nullsUsing = DateJsonSerialize.class)
    private Date finishTime;

测试

将finishTime设置为NULL，然后进行测试查询，序列化为了未完成

using用法

当字段不为NULL时的自定义序列化方式，用法跟上面一样

    @ApiModelProperty("完成时间")
    @JsonSerialize(using = XXX.class) //自定义序列化类
    private Date finishTime;

详细实例参考