SpringBoot接口自定义序列化

需求背景

在我们写接口的时候可能会有这样的需求，例如对于BigDecimal类型的字段有时候需要显示到小数点后两位，有时候需要显示成百分比，有时候则取整。

@Data
public class Order {
    /**
     * 订单号
     */
    private String orderNo;
    /**
     * 订单金额,保留两位小数
     */
    private BigDecimal orderAmount;
    /**
     * 优惠金额，只保留整数
     */
    private BigDecimal discountAmount;
    /**
     * 优惠百分比，显示百分比
     */
    private BigDecimal discountPercent;
}

例如上面的订单模型，我们的订单金额需要保留两位小数，优惠金额保留整数，而优惠百分比我们这需要以百分号的形式显示出来，如果我们没有做任何特殊处理，最后显示的效果如下所示：

{
    "orderNo": "20210605091",
    "orderAmount": 100.05,
    "discountAmount": 10.00,
    "discountPercent": 0.10
}

@JsonSerialize和JsonSerializer

通过查询资料，可以通过@JsonSerialize和JsonSerializer来实现自定义序列化。

public class PercentSerialize extends JsonSerializer {
    private final DecimalFormat df = new DecimalFormat("##.00%");
    @Override
    public void serialize(BigDecimal value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        if (value == null){
            gen.writeNull();
        }else {
            gen.writeString(df.format(value));
        }
    }
}

我们通过继承JsonSerializer类来实现我们自己的序列化要求，这里面的代表的是序列化时的类型，例如我需要对Double类型做自定义的序列化那么这个T就是Double。最后我们只要实现serialize方法即可，第一个参数value就是字段的值，第二个参数gen用于生成json内容，第三个参数暂时不管。

@Data
public class Order {
    /**
     * 订单号
     */
    private String orderNo;
    /**
     * 订单金额,保留两位小数
     */
    private BigDecimal orderAmount;
    /**
     * 优惠金额，只保留整数
     */
    private BigDecimal discountAmount;
    /**
     * 优惠百分比，显示百分比
     */
    @JsonSerialize(using = PercentSerialize.class)
    private BigDecimal discountPercent;
}

在我们的订单模型类中我们给discountPercent字段加上@JsonSerialize(using = PercentSerialize.class)注解，然后运行代码打印效果如下：

{
    "orderNo": "20210605091",
    "orderAmount": 100.05,
    "discountAmount": 10.00,
    "discountPercent": "10.00%"
}

存在的问题

上面貌似已经解决了问题，我们只要再写一个把BigDecimal显示成整数输出的类即可。但是如果我还要输出别的格式怎么办呢？难道再写一个？看来这种方式也不是很靠谱，哪有没有别的更好的方式呢？

如果我能获取到序列化的那个字段，我是不是可以在字段上添加一个注解，然后读取注解中的格式，然后在序列化时将BigDecimal序列化成我指定的格式就行了。经过一番查找，发现还真有办法可以获取到当前序列化的字段。

Jackson中提供了一个ContextualSerializer接口，我们只要实现这个接口就能获取到当前序列化的字段。

public class BigDecimalSerialize extends JsonSerializer implements ContextualSerializer {
    private DecimalFormat df;
    @Override
    public void serialize(BigDecimal value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        if (value == null){
            gen.writeNull();
        }else {
            if (df == null){
                gen.writeNumber(value.setScale(2,BigDecimal.ROUND_HALF_UP));
            }else {
                gen.writeString(df.format(value));
            }
        }
    }
    @Override
    public JsonSerializer createContextual(SerializerProvider prov, BeanProperty property) throws JsonMappingException {
        //判断beanProperty是不是空
        if (property == null){
            return prov.findNullValueSerializer(property);
        }
        //判断类型是否是BigDecimal
        if (Objects.equals(property.getType().getRawClass(),BigDecimal.class)){
            JacksonBigDecimal annotation = property.getAnnotation(JacksonBigDecimal.class);
            if (annotation != null){
                String pattern = annotation.pattern();
                df = new DecimalFormat(pattern);
                return this;
            }
        }
        return prov.findValueSerializer (property.getType (), property);
    }
}

然后自定义注解如下：

@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonSerialize(using = BigDecimalSerialize.class)
public @interface JacksonBigDecimal {
    /**
     * BigDecimal格式，格式标准请参考{@link java.text.DecimalFormat}
     */
    String pattern() default "";
}

订单模型类中修改如下：

@Data
public class Order {
    /**
     * 订单号
     */
    private String orderNo;
    /**
     * 订单金额,保留两位小数
     */
    @JacksonBigDecimal(pattern = "#.##")
    private BigDecimal orderAmount;
    /**
     * 优惠金额，只保留整数
     */
    @JacksonBigDecimal(pattern = "#")
    private BigDecimal discountAmount;
    /**
     * 优惠百分比，显示百分比
     */
//    @JsonSerialize(using = PercentSerialize.class)
    @JacksonBigDecimal(pattern = "##.00%")
    private BigDecimal discountPercent;
}

最后输出的结果如下：

{
    "orderNo": "20210605091",
    "orderAmount": "100.05",
    "discountAmount": "10",
    "discountPercent": "10.00%"
}

通过这种方式，我们在处理同一种类型时将它用不同的方式进行JSON输出。例如我们在输出用户的手机号码时，我们需要输出前三位和后四位，中间几位使用*号来代替。对于这种需求都可以通过这种方式实现。

相关代码

• 源码地址：https://gitee.com/zengchao_workspace/custom-json.git