解决json_serializable中Decimal类型的序列化问题

在使用json_serializable进行JSON序列化时，处理Decimal类型数据可能会遇到一些挑战。本文将详细介绍如何通过自定义转换器(JsonConverter)来解决Decimal类型在API和SQLite中的序列化问题。

问题背景

当使用json_serializable生成代码处理Decimal类型时，默认生成的代码可能会遇到以下两个问题：

1. 从JSON反序列化时：API返回的Decimal数值可能是double类型，而生成的代码默认尝试将其作为String处理，导致类型转换错误。

2. 序列化为JSON时：生成的代码与SQLite不兼容，虽然目前只是警告，但未来可能会变成错误。

解决方案

通过实现自定义的JsonConverter可以完美解决这些问题。下面是一个完整的DecimalConverter实现：

class DecimalConverter implements JsonConverter<Decimal?, dynamic> {
  const DecimalConverter();

  @override
  Decimal? fromJson(dynamic json) => Decimal.tryParse('$json');

  @override
  double? toJson(Decimal? object) => object?.toDouble();
}

实现解析

1. 泛型参数：DecimalConverter实现了JsonConverter<Decimal?, dynamic>，表示它能将任意类型(dynamic)转换为可空的Decimal类型。

2. fromJson方法：

   • 接收任意类型的输入参数
   • 使用'$json'将输入转换为字符串
   • 通过Decimal.tryParse安全地解析为Decimal对象

3. toJson方法：

   • 将Decimal对象转换为double类型
   • 使用?.操作符处理可能为null的情况

使用方法

在数据类中使用这个转换器非常简单：

@JsonSerializable()
class ApiPdvTroco {
  @DecimalConverter()
  final Decimal? valor;
  
  // 其他字段...
  
  factory ApiPdvTroco.fromJson(Map<String, dynamic> json) =>
      _$ApiPdvTrocoFromJson(json);
      
  Map<String, dynamic> toJson() => _$ApiPdvTrocoToJson(this);
}

注意事项

1. 动态类型处理：转换器使用dynamic作为输入类型，可以处理API返回的各种数值类型(如int、double等)。

2. 空安全：实现中充分考虑了null安全性，使用tryParse和?.操作符避免空指针异常。

3. SQLite兼容性：转换为double类型确保了与SQLite的良好兼容性。

通过这种实现方式，我们既解决了API返回值的类型问题，又确保了与SQLite的兼容性，是一种较为完善的解决方案。