【springboot进阶】springboot集成fastjson（二）自定义序列化/反序列化

目录

一、创建用于序列化日期的类

二、序列化类的使用

三、创建用于反序列化价格的类

四、反序列化类的使用

五、结语 

---

序列化场景：前端希望我们返回的日期为一个毫秒数，而不是一个直接从数据表返回的日期格式字符串。那么一般来说，我们就需要对每一条记录的日期进行格式化处理，这样就显得不优雅，而且很费劲。

这时候，我们可以使用自定义序列化的方式来处理这样的场景。

一、创建用于序列化日期的类

从fastjson2.x版本开始(以下使用2.0.6版本)，序列化接口将使用ObjectWriter，集成它并重写write方法。

/**
 * fastjson日期序列化类
 *
 * 序列化
 *
 * 统一将LocalDateTime转为毫秒数
 *
 */
public class DateJsonSerializer implements ObjectWriter<String> {

    @Override
    public void write(JSONWriter jsonWriter, Object object, Object fieldName, Type fieldType, long features) {
        if (object == null) {
            jsonWriter.writeNull();
            return;
        }

        if (object instanceof LocalDateTime) {
            LocalDateTime localDateTime = (LocalDateTime) object;
            jsonWriter.writeString(localDateTime.toInstant(ZoneOffset.of("+8")).toEpochMilli() + "");
            
            /**
             * 如果需要格式化为数字型的时间戳，使用 writeMillis 方法
             *
             * jsonWriter.writeMillis(localDateTime.toInstant(ZoneOffset.of("+8")).toEpochMilli());
             *
             */

   
        }
    }
}

其中object为需序列化的对象，而且只对LocalDateTime类型就行处理。最终使用JSONWriter.writeString方法，将转化后的毫秒数返回给前端。

二、序列化类的使用

现在我们创建了用于自定义的序列化类，那么我们接下来看看如何使用这个类。

@Data
public class FastjsonDemoResponse {

    @JSONField(name = "user_name")
    private String userName;

    @JSONField(name = "age")
    private Integer age;

    @JSONField(name = "today_timestamp", serializeUsing = DateJsonSerializer.class)
    private LocalDateTime localDateTime;

}

可以看到我们在LocalDateTime的JSONField注解上，引用了这个自定义序列化类，通过serializeUsing属性指定。

然后，我们在控制器中设置一下这个日期时间，看看效果如何。

@RequestMapping("/api/fastjson")
@RestController
public class FastjsonDemoController {

    @PostMapping("/request")
    public FastjsonDemoResponse demo(@RequestBody FastjsonDemoRequest fastjsonDemoRequest) {

        FastjsonDemoResponse response = new FastjsonDemoResponse();
        response.setUserName(fastjsonDemoRequest.getUserName());
        response.setAge(fastjsonDemoRequest.getAge());
        //获取当前日期
        LocalDateTime now = LocalDateTime.now();
        response.setLocalDateTime(now);

        return response;
    }

}

从调试窗口可以看到，目前设置的dto中，localDateTime为一个日期型的。然后，我们在自定义序列化类中，设置了断点，看看是否有生效。

从图中可以看到，write方法中的几个参数分别是带的是什么内容，其中object为我们注解上的日期属性值。

 从接口响应可以看到，today_timestamp经过自定义序列化后，变为了对应的毫秒数，达到了预期的效果。 

反序列化场景：前端传过来有一个价格的参数，单位是元，但是业务系统中统一使用的单位是分，我们希望可以做自动的转换，就不需要每次在代码中都处理一次。

三、创建用于反序列化价格的类

从fastjson2.x版本开始(以下使用2.0.6版本)，序列化接口将使用ObjectReader，集成它并重写readObject方法。

/**
 * 货币单位转换
 *
 * 反序列化
 *
 * 元转分
 *
 */
public class CurrencyChangeYuanToFenDeserializer implements ObjectReader<String> {

    @Override
    public String readObject(JSONReader jsonReader, long features) {
        String yuan = jsonReader.readString();
        if (StrUtil.isNotBlank(yuan)) {
            //元转分 处理
            BigDecimal meteBig = NumberUtil.mul(yuan, "100");
            Integer fen = meteBig.intValue();
            return fen + "";
        }

        return "";
    }
}

调用JSONReader.readString方法，读取对应字符串的属性值，并进行单位转换。

四、反序列化类的使用

我们在请求dto中，加入money属性，并设置反序列化使用的类为以上的自定义类，这次使用的是deserializeUsing属性。

@Data
public class FastjsonDemoRequest {

    @JSONField(name = "user_name")
    private String userName;

    @JSONField(name = "age")
    private Integer age;

    @JSONField(name = "money", deserializeUsing = CurrencyChangeYuanToFenDeserializer.class)
    private String money;

}

我们请求一下看看效果。 

从调试窗口中可以看到，我们读取了请求的价格1.2元。 

从controller控制器中看到，这时候的money已经经过转换，变成了120，即成功转为分单位。

五、结语 

日常业务处理中，还有很多类似这样的场景。自定义序列化/反序列化的灵活使用，能够简化很多频繁的转换工作，使代码看起来也更加的简洁。

如果项目转换了使用 fastjson2 的话，通常会遇到 json 字符串生成实体类的问题，这里介绍一个idea好用的插件，详情可以参考我另外一篇文章 

​​​​​​​IDEA GsonFormatPlus 插件调整支持 fastjson2-CSDN博客